com.day.cq.personalization.ui.items

Interface Audience

@ConsumerType
public interface Audience

Represents an interface for the audiences and is intended to be used by UI.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAudienceJson() Returns the audience JSON
java.lang.String	getAudienceType() Returns the audience type which can be either 'CC', 'CH', 'AT' or 'folder'.
java.lang.String	getClasses() Returns the applicable CSS classes.
java.lang.String	getConfigPath() Returns the path to the cloud configuration.
java.util.Calendar	getLastModified() Returns the last modified date.
java.lang.String	getLastModifiedBy() Returns the formatted user name by whom the item has been modified.
java.util.Calendar	getLastPublished() Returns the last publication date.
java.lang.String	getLastPublishedBy() Returns the formatted user name by whom the item has been published.
java.lang.String	getNavigatorHref() Returns the navigator HREF attribute.
java.lang.String	getPath() Returns the path.
java.util.List<java.lang.String>	getQuickactionsRels() Returns the quick actions relations.
java.lang.String	getResourceType() Returns the resource type.
java.lang.String	getTitle() Returns the audience title
boolean	isEditable() Return true if resource is editable.
boolean	isFolder() Returns true if resource is of type folder.

Method Detail

getTitle

java.lang.String getTitle()

Returns the audience title

Returns:

Title of the resource or the resource name if title is not available.

getPath

java.lang.String getPath()

Returns the path.

Returns:

Path of the resource.

getResourceType

java.lang.String getResourceType()

Returns the resource type.

Returns:

Resource type of the resource.

getLastModified

java.util.Calendar getLastModified()

Returns the last modified date.

Returns:

Last modification date or null

getLastModifiedBy

java.lang.String getLastModifiedBy()

Returns the formatted user name by whom the item has been modified.

Returns:

Formatted user name, identifier or null

getLastPublished

java.util.Calendar getLastPublished()

Returns the last publication date.

Returns:

Last publication date or null

getLastPublishedBy

java.lang.String getLastPublishedBy()

Returns the formatted user name by whom the item has been published.

Returns:

Formatted user name, identifier or null

getClasses

java.lang.String getClasses()

Returns the applicable CSS classes.

Returns:

Space separated CSS classes or an empty string

getAudienceType

java.lang.String getAudienceType()

Returns the audience type which can be either 'CC', 'CH', 'AT' or 'folder'.

Returns:

Audience type

getAudienceJson

java.lang.String getAudienceJson()

Returns the audience JSON

Returns:

Audience JSON or null

getConfigPath

java.lang.String getConfigPath()

Returns the path to the cloud configuration.

Returns:

Cloud configuration path or null

getNavigatorHref

java.lang.String getNavigatorHref()

Returns the navigator HREF attribute.

Returns:

Navigator href attribute or null

getQuickactionsRels

java.util.List<java.lang.String> getQuickactionsRels()

Returns the quick actions relations.

Returns:

A list of quick actions relations or an empty list

isEditable

boolean isEditable()

Return true if resource is editable.

Returns:

true it resource is editable, false otherwise

isFolder

boolean isFolder()

Returns true if resource is of type folder.

Returns:

true if resource is a folder, false otherwise