com.adobe.cq.social.enablement.resource.model.api

Interface EnablementResourceModel

All Superinterfaces:

SocialComponent

All Known Subinterfaces:

EnablementLearningPathModel

public interface EnablementResourceModel
extends SocialComponent

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ALLOW_COMMENTS
static java.lang.String	ALLOW_RATINGS
static java.lang.String	ANONYMOUS_ACCESS
static java.lang.String	APPLY_TO_LIST
static java.lang.String	ASSIGNEES
static java.lang.String	AUTHORS
static java.lang.String	CARD_IMAGE_PATH
static java.lang.String	CONTACTS
static java.lang.String	COVER_IMAGE
static java.lang.String	DATE_CREATED
static java.lang.String	DATE_MODIFIED
static java.lang.String	DATE_PUBLISHED
static java.lang.String	DESCRIPTION
static java.lang.String	DIRECT_ENROLLEE_GROUP_ID
static java.lang.String	DIRECT_ENROLLMENT_QUERY_PROPERTY
static java.lang.String	DUE_DATE
static java.lang.String	ENABLEMENT_TYPE
static java.lang.String	ENABLEMENT_TYPE_DISPLAY_NAME
static java.lang.String	ENABLEMENT_TYPE_VALUE
static java.lang.String	ENROLLED_USERS
static java.lang.String	ENROLLMENT_RESOURCE_NAME
static java.lang.String	EXPERTS
static java.lang.String	FIRST_PUBLISHED_BY
static java.lang.String	INDIRECT_ENROLLEE_GROUP_ID
static java.lang.String	JCR_TITLE
static java.lang.String	PUBLISHED
static java.lang.String	REPLICATION_ACTION
static java.lang.String	REPORT_USERS_GROUP_ID
static java.lang.String	RESOURCE_ID
static java.lang.String	RESOURCE_NAME
static java.lang.String	RESOURCE_TAGS
static java.lang.String	RESOURCE_TYPE
static java.lang.String	RESOURCE_UID
static java.lang.String	SEND_ENROLLMENT_EMAIL
static java.lang.String	SHOW_IN_CATALOG
static java.lang.String	SITE
static java.lang.String	TAG_NAMESPACES

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
void	createNamedAsset(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> assetMap)
java.lang.Boolean	getAllowAnonymous()
java.lang.Boolean	getAllowCatalogVisibility()
java.lang.Boolean	getAllowComments()
java.lang.Boolean	getAllowRatings()
java.util.List<EnablementAssetModel>	getAssets() Returns an array of resource assets.
EnablementAuthorizables	getAssignees() Returns an object representing the assignees
EnablementAuthorizables	getAuthors() Returns an object representing the authors
EnablementAuthorizables	getContacts() Returns an object representing the contacts
java.lang.String	getCoverImage()
java.lang.String	getDescription()
java.util.Date	getDueDate()
java.util.Calendar	getDueDateAsCalendar()
java.lang.String	getDueDateAsString()
EnablementCardImage	getEnablementCardImage()
java.lang.String	getEnablementType()
EnablementAuthorizables	getExperts() Returns an object representing the experts
java.util.Date	getFirstPublishedDate() Returns the first published date
EnablementAssetModel	getFragmentAsset() Returns an object representing the primary resource asset.
java.lang.String	getFriendlyDueDate()
java.lang.Boolean	getIsPublished()
java.lang.String	getLanguage()
EnablementAssetModel	getLargeAsset() Returns an object representing the primary resource asset.
java.lang.String	getName()
EnablementAssetModel	getPrimaryAsset() Returns an object representing the primary resource asset.
java.lang.String	getPrimaryAssetType() Returns a the primary asset type
java.lang.String	getResourceAssetsPath()
Group	getResourceGroup(java.lang.String groupId)
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	getSite()
java.lang.String	getSiteId()
java.lang.String	getSiteUID()
EnablementAssetModel	getSmallAsset() Returns an object representing the primary resource asset.
EnablementSocialModel	getSocial()
java.lang.String	getTitle()
void	importNamedAsset(java.lang.String name, JSONArray primaryAssetArray)
void	setAnonymousAccess(java.lang.Boolean allowAnonymousAccess)
void	setAuthorizables(java.lang.String key, java.util.Map<java.lang.String,java.lang.Object> authorizableMap)
void	setCardImage(java.lang.String cardImageTmpPath)
void	setCoverImagePath(java.lang.String coverImagePath)
void	setDescription(java.lang.String description) updates resource description
void	setDueDate(java.util.Calendar dueDate) Set due date for a resourse
void	setName(java.lang.String name) updates resource name
void	setShowInCatalog(java.lang.Boolean showInCatalog)
void	setSocialResources(java.lang.String displayName, java.lang.Boolean allowComments, java.lang.Boolean allowRatings) Create social resource endpoints.
void	setTags(java.lang.String[] tags)

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

getAsMap, getFriendlyUrl, 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

ENABLEMENT_TYPE_VALUE

static final java.lang.String ENABLEMENT_TYPE_VALUE

See Also:

Constant Field Values

ENABLEMENT_TYPE_DISPLAY_NAME

static final java.lang.String ENABLEMENT_TYPE_DISPLAY_NAME

See Also:

Constant Field Values

JCR_TITLE

static final java.lang.String JCR_TITLE

See Also:

Constant Field Values

RESOURCE_NAME

static final java.lang.String RESOURCE_NAME

See Also:

Constant Field Values

DESCRIPTION

static final java.lang.String DESCRIPTION

See Also:

Constant Field Values

RESOURCE_ID

static final java.lang.String RESOURCE_ID

See Also:

Constant Field Values

RESOURCE_UID

static final java.lang.String RESOURCE_UID

See Also:

Constant Field Values

RESOURCE_TAGS

static final java.lang.String RESOURCE_TAGS

See Also:

Constant Field Values

ENABLEMENT_TYPE

static final java.lang.String ENABLEMENT_TYPE

See Also:

Constant Field Values

COVER_IMAGE

static final java.lang.String COVER_IMAGE

See Also:

Constant Field Values

SITE

static final java.lang.String SITE

See Also:

Constant Field Values

DUE_DATE

static final java.lang.String DUE_DATE

See Also:

Constant Field Values

PUBLISHED

static final java.lang.String PUBLISHED

See Also:

Constant Field Values

FIRST_PUBLISHED_BY

static final java.lang.String FIRST_PUBLISHED_BY

See Also:

Constant Field Values

ALLOW_COMMENTS

static final java.lang.String ALLOW_COMMENTS

See Also:

Constant Field Values

ALLOW_RATINGS

static final java.lang.String ALLOW_RATINGS

See Also:

Constant Field Values

SHOW_IN_CATALOG

static final java.lang.String SHOW_IN_CATALOG

See Also:

Constant Field Values

ANONYMOUS_ACCESS

static final java.lang.String ANONYMOUS_ACCESS

See Also:

Constant Field Values

AUTHORS

static final java.lang.String AUTHORS

See Also:

Constant Field Values

CONTACTS

static final java.lang.String CONTACTS

See Also:

Constant Field Values

EXPERTS

static final java.lang.String EXPERTS

See Also:

Constant Field Values

ASSIGNEES

static final java.lang.String ASSIGNEES

See Also:

Constant Field Values

DATE_MODIFIED

static final java.lang.String DATE_MODIFIED

See Also:

Constant Field Values

DATE_CREATED

static final java.lang.String DATE_CREATED

See Also:

Constant Field Values

DATE_PUBLISHED

static final java.lang.String DATE_PUBLISHED

See Also:

Constant Field Values

CARD_IMAGE_PATH

static final java.lang.String CARD_IMAGE_PATH

See Also:

Constant Field Values

ENROLLMENT_RESOURCE_NAME

static final java.lang.String ENROLLMENT_RESOURCE_NAME

See Also:

Constant Field Values

ENROLLED_USERS

static final java.lang.String ENROLLED_USERS

See Also:

Constant Field Values

SEND_ENROLLMENT_EMAIL

static final java.lang.String SEND_ENROLLMENT_EMAIL

See Also:

Constant Field Values

REPLICATION_ACTION

static final java.lang.String REPLICATION_ACTION

See Also:

Constant Field Values

APPLY_TO_LIST

static final java.lang.String APPLY_TO_LIST

See Also:

Constant Field Values

DIRECT_ENROLLMENT_QUERY_PROPERTY

static final java.lang.String DIRECT_ENROLLMENT_QUERY_PROPERTY

See Also:

Constant Field Values

TAG_NAMESPACES

static final java.lang.String TAG_NAMESPACES

See Also:

Constant Field Values

DIRECT_ENROLLEE_GROUP_ID

static final java.lang.String DIRECT_ENROLLEE_GROUP_ID

See Also:

Constant Field Values

INDIRECT_ENROLLEE_GROUP_ID

static final java.lang.String INDIRECT_ENROLLEE_GROUP_ID

See Also:

Constant Field Values

REPORT_USERS_GROUP_ID

static final java.lang.String REPORT_USERS_GROUP_ID

See Also:

Constant Field Values

Method Detail

getTitle

java.lang.String getTitle()

Returns:

resource title

getName

java.lang.String getName()

Returns:

resource name

setName

void setName(java.lang.String name)
      throws PersistenceException,
             com.adobe.cq.social.enablement.exceptions.EnablementException

updates resource name

Parameters:

name - - name of resource

Throws:

PersistenceException - thrown if exception occurs while persisting data

com.adobe.cq.social.enablement.exceptions.EnablementException - thrown if exception occurs while setting name

getDescription

java.lang.String getDescription()

Returns:

resource description

setDescription

void setDescription(java.lang.String description)
             throws PersistenceException,
                    com.adobe.cq.social.enablement.exceptions.EnablementException

updates resource description

Parameters:

description - - description of resource

Throws:

PersistenceException - thrown if exception occurs while persisting data

com.adobe.cq.social.enablement.exceptions.EnablementException - thrown if exception occurs while setting description

getEnablementType

java.lang.String getEnablementType()

Returns:

resource enablement type

getCoverImage

java.lang.String getCoverImage()

Returns:

resource cover image

getSite

java.lang.String getSite()

Returns:

resource site path

getSiteId

java.lang.String getSiteId()

Returns:

resource site id

getSiteUID

java.lang.String getSiteUID()

Returns:

resource site unique id

getLanguage

java.lang.String getLanguage()

Returns:

resource site language

getFriendlyDueDate

java.lang.String getFriendlyDueDate()

Returns:

resource date

getDueDateAsString

java.lang.String getDueDateAsString()

Returns:

resource date as a string

getDueDateAsCalendar

java.util.Calendar getDueDateAsCalendar()

Returns:

resource date as a calendar

getDueDate

java.util.Date getDueDate()

Returns:

resource date

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

getAllowComments

java.lang.Boolean getAllowComments()

Returns:

resource allow comments

getAllowRatings

java.lang.Boolean getAllowRatings()

Returns:

resource allow ratings

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

createNamedAsset

void createNamedAsset(java.lang.String key,
                      java.util.Map<java.lang.String,java.lang.Object> assetMap)
               throws PersistenceException,
                      com.adobe.cq.social.enablement.exceptions.EnablementException

Parameters:

key - - key to be fetch data from map

assetMap - - map

Throws:

PersistenceException - thrown if exception occurs while persisting data

com.adobe.cq.social.enablement.exceptions.EnablementException - thrown if exception occurs while creating named asset

setSocialResources

void setSocialResources(java.lang.String displayName,
                        java.lang.Boolean allowComments,
                        java.lang.Boolean allowRatings)
                 throws PersistenceException,
                        com.adobe.cq.social.enablement.exceptions.EnablementException

Create social resource endpoints.

Parameters:

displayName - - name to be displayed

allowComments - - boolean to allow comments

allowRatings - - boolean to allow ratings

Throws:

PersistenceException - thrown if exception occurs while persisting data

com.adobe.cq.social.enablement.exceptions.EnablementException - thrown if exception occurs while setting social resources

setAuthorizables

void setAuthorizables(java.lang.String key,
                      java.util.Map<java.lang.String,java.lang.Object> authorizableMap)
               throws PersistenceException,
                      com.adobe.cq.social.enablement.exceptions.EnablementException

Parameters:

key - - authorizable key

authorizableMap - - map

Throws:

PersistenceException - thrown if exception occurs while persisting data

com.adobe.cq.social.enablement.exceptions.EnablementException - thrown if exception occurs while setting authorizables

getAssets

java.util.List<EnablementAssetModel> getAssets()

Returns an array of resource assets.

Returns:

list of assets

getResourceAssetsPath

java.lang.String getResourceAssetsPath()

Returns:

the resource assets path where resources will be persisted in the DAM

getPrimaryAsset

EnablementAssetModel getPrimaryAsset()

Returns an object representing the primary resource asset.

Returns:

primary asset

getSmallAsset

EnablementAssetModel getSmallAsset()

Returns an object representing the primary resource asset.

Returns:

small asset

getLargeAsset

EnablementAssetModel getLargeAsset()

Returns an object representing the primary resource asset.

Returns:

large asset

getFragmentAsset

EnablementAssetModel getFragmentAsset()

Returns an object representing the primary resource asset.

Returns:

fragment asset

getEnablementCardImage

EnablementCardImage getEnablementCardImage()

Returns:

get the enablement card image

setCoverImagePath

void setCoverImagePath(java.lang.String coverImagePath)
                throws com.adobe.cq.social.enablement.exceptions.EnablementException

Parameters:

coverImagePath - - path of cover image

Throws:

com.adobe.cq.social.enablement.exceptions.EnablementException - thrown if exception occurs while setting cover image path

setCardImage

void setCardImage(java.lang.String cardImageTmpPath)
           throws PersistenceException,
                  com.adobe.cq.social.enablement.exceptions.EnablementException

Parameters:

cardImageTmpPath - - path of card image

Throws:

PersistenceException - thrown if exception occurs while persisting data

com.adobe.cq.social.enablement.exceptions.EnablementException - thrown if exception occurs while setting card image

setDueDate

void setDueDate(java.util.Calendar dueDate)
         throws com.adobe.cq.social.enablement.exceptions.EnablementException

Set due date for a resourse

Parameters:

dueDate - - due date for resource to complete

Throws:

com.adobe.cq.social.enablement.exceptions.EnablementException - thrown if exception occurs while setting dude date

getSocial

EnablementSocialModel getSocial()

Returns:

an object representing the social resource endpoints

getContacts

EnablementAuthorizables getContacts()

Returns an object representing the contacts

Returns:

contacts related to resource

getAuthors

EnablementAuthorizables getAuthors()

Returns an object representing the authors

Returns:

authors related to resource

getExperts

EnablementAuthorizables getExperts()

Returns an object representing the experts

Returns:

experts related to resource

getAssignees

EnablementAuthorizables getAssignees()

Returns an object representing the assignees

Returns:

assignees for resource

getPrimaryAssetType

java.lang.String getPrimaryAssetType()

Returns a the primary asset type

Returns:

primary asset type

getFirstPublishedDate

java.util.Date getFirstPublishedDate()

Returns the first published date

Returns:

publish date

getResourceGroup

Group getResourceGroup(java.lang.String groupId)

Parameters:

groupId - - id of group

Returns:

the authorizable group for the resource with the corresponding group id

importNamedAsset

void importNamedAsset(java.lang.String name,
                      JSONArray primaryAssetArray)

Parameters:

name - - name of asset

primaryAssetArray - - array of primary assets

setTags

void setTags(java.lang.String[] tags)
      throws com.adobe.cq.social.enablement.exceptions.EnablementException

Parameters:

tags - - tags

Throws:

com.adobe.cq.social.enablement.exceptions.EnablementException - thrown if exception occurs while setting tags

setShowInCatalog

void setShowInCatalog(java.lang.Boolean showInCatalog)
               throws com.adobe.cq.social.enablement.exceptions.EnablementException

Parameters:

showInCatalog - - boolean to show resource in catalog

Throws:

com.adobe.cq.social.enablement.exceptions.EnablementException - thrown if exception occurs while setting show in catalog

setAnonymousAccess

void setAnonymousAccess(java.lang.Boolean allowAnonymousAccess)
                 throws com.adobe.cq.social.enablement.exceptions.EnablementException

Parameters:

allowAnonymousAccess - - boolean to allow anonymous access

Throws:

com.adobe.cq.social.enablement.exceptions.EnablementException - thrown if exception occurs while setting anonymous access