com.adobe.cq.social.enablement.view.api

Interface EnablementResourceView

All Superinterfaces:

SocialComponent

All Known Subinterfaces:

EnablementResourceViewDetail

@ProviderType
public interface EnablementResourceView
extends SocialComponent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	RESOURCE_TYPE

Fields inherited from interface com.adobe.cq.social.scf.SocialComponent

CSV_SELECTOR, DEFAULT_SELECTOR, INDEX_SELECTOR, PROP_REFERER, QUERY_SELECTOR, TRANSLATE_SELECTOR

Method Summary

Modifier and Type	Method and Description
java.lang.Boolean	getAllowAnonymous()
java.lang.Boolean	getAllowCatalogVisibility()
EnablementAuthorizables	getAssignees() Returns an object representing the assignees
EnablementAuthorizables	getAuthors() Returns an object representing the authors
java.lang.String	getCardImagePath()
java.lang.String	getCommentsEndpoint()
EnablementAuthorizables	getContacts() Returns an object representing the contacts
java.lang.String	getCoverImage()
java.lang.String	getDescription()
java.lang.String	getDueStatus()
EnablementResourceModel	getEnablementResourceModel()
java.lang.String	getEnablementType()
EnablementAuthorizables	getExperts() Returns an object representing the experts
EnablementAssetModel	getFragmentAsset() Returns an object representing the resource content fragment asset.
java.lang.String	getFriendlyDueDate()
java.lang.String	getFriendlyUrl() Get a url that can be used to display this component, most of the time, this is the page url that contains the component.
java.lang.Boolean	getIsPublished()
java.lang.String	getLanguage()
EnablementAssetModel	getLargeAsset() Returns an object representing the resource large asset.
java.lang.String	getMarketingCloudOrgId() Gets the marketing cloud org id, which is required for video heartbeat analytics
EnablementAssetModel	getPrimaryAsset() Returns an object representing the primary resource asset.
java.lang.String	getPrimaryAssetType()
java.lang.String	getRatingsEndpoint()
java.lang.String	getResourceAssetPath()
java.lang.String	getResourceId()
java.lang.String[]	getResourceTags() Gets the list of tagIds associated with the given Enablement content.
java.lang.String	getResourceUID()
java.lang.String	getSiteId()
java.lang.String	getSitePagePath()
EnablementAssetModel	getSmallAsset() Returns an object representing the resource small asset.
java.lang.String	getTitle()
EnablementResourceUserReportModel	getUserReport()

Methods inherited from interface com.adobe.cq.social.scf.SocialComponent

getAsMap, getId, getParentComponent, getProperties, getProperty, getProperty, getResource, getResourceType, getSourceComponent, getUrl, toJSONString

Field Detail

RESOURCE_TYPE

static final java.lang.String RESOURCE_TYPE

See Also:

Constant Field Values

Method Detail

getTitle

java.lang.String getTitle()

Returns:

resource title

getFriendlyUrl

java.lang.String getFriendlyUrl()

Description copied from interface: SocialComponent

Get a url that can be used to display this component, most of the time, this is the page url that contains the component. This method method may return null value if there is no available friendly url .

Specified by:

getFriendlyUrl in interface SocialComponent

Returns:

friendlyURL String

getSitePagePath

java.lang.String getSitePagePath()

Returns:

Site Path

getCoverImage

java.lang.String getCoverImage()

Returns:

resource cover image

getCardImagePath

java.lang.String getCardImagePath()

Returns:

get the card image path

getDescription

java.lang.String getDescription()

Returns:

resource description

getSiteId

java.lang.String getSiteId()

Returns:

resource site id

getLanguage

java.lang.String getLanguage()

Returns:

resource site language

getFriendlyDueDate

java.lang.String getFriendlyDueDate()

Returns:

resource date

getDueStatus

java.lang.String getDueStatus()

Returns:

resource due status

getResourceId

java.lang.String getResourceId()

Returns:

resource id

getResourceUID

java.lang.String getResourceUID()

Returns:

resource id

getResourceTags

java.lang.String[] getResourceTags()
                            throws RepositoryException

Gets the list of tagIds associated with the given Enablement content.

Returns:

list of tagIds

Throws:

RepositoryException - on failure

getIsPublished

java.lang.Boolean getIsPublished()

Returns:

resource is published

getAllowAnonymous

java.lang.Boolean getAllowAnonymous()

Returns:

resource allow anonymous

getAllowCatalogVisibility

java.lang.Boolean getAllowCatalogVisibility()

Returns:

allow catalog visibility

getResourceAssetPath

java.lang.String getResourceAssetPath()

Returns:

path to the primary asset

getCommentsEndpoint

java.lang.String getCommentsEndpoint()

Returns:

path representing the enablement resource comments endpoint

getRatingsEndpoint

java.lang.String getRatingsEndpoint()

Returns:

path representing the enablement resource ratings endpoint

getPrimaryAsset

EnablementAssetModel getPrimaryAsset()

Returns an object representing the primary resource asset.

Returns:

primary asset

getLargeAsset

EnablementAssetModel getLargeAsset()

Returns an object representing the resource large asset.

Returns:

large asset

getSmallAsset

EnablementAssetModel getSmallAsset()

Returns an object representing the resource small asset.

Returns:

small asset

getFragmentAsset

EnablementAssetModel getFragmentAsset()

Returns an object representing the resource content fragment asset.

Returns:

fragment asset

getContacts

EnablementAuthorizables getContacts()

Returns an object representing the contacts

Returns:

contacts

getAuthors

EnablementAuthorizables getAuthors()

Returns an object representing the authors

Returns:

authors

getExperts

EnablementAuthorizables getExperts()

Returns an object representing the experts

Returns:

experts

getAssignees

EnablementAuthorizables getAssignees()

Returns an object representing the assignees

Returns:

assignees

getEnablementType

java.lang.String getEnablementType()

Returns:

enablement type

getUserReport

EnablementResourceUserReportModel getUserReport()

Returns:

user report

getPrimaryAssetType

java.lang.String getPrimaryAssetType()

Returns:

primary asset type

getEnablementResourceModel

EnablementResourceModel getEnablementResourceModel()

Returns:

enablement resource model

getMarketingCloudOrgId

java.lang.String getMarketingCloudOrgId()

Gets the marketing cloud org id, which is required for video heartbeat analytics

Returns:

marketing cloud org id