Package com.day.cq.personalization.ui.items

Interface PersonalizationItem

  • @ProviderType
public interface PersonalizationItem
    Represents an interface for datasource items related to personalization such as activities and offers and is intended to be used by UI.

    • Method Detail

      • getPath

        String getPath()
        Returns the path.
        Returns:
        Path of the resource.

      • getResourceType

        String getResourceType()
        Returns the resource type.
        Returns:
        Resource type of the resource. If the resource is of type cq:Page the resource type of cq:PageContent will be returned.

      • getTitle

        String getTitle()
        Returns the title
        Returns:
        Title of the resource or the resource name if title is not available.

      • getNavigatorHref

        String getNavigatorHref()
        Returns the composed URL for navigating to the item. The URL is composed as follows {request.url}.html{resource.path}.
        Returns:
        Composed URL for navigating to the item.

      • getThumbnailPath

        String getThumbnailPath()
        Returns the thumbnail path.
        Returns:
        Path to the resource thumbnail.

      • getActivityType

        String getActivityType()
        Returns the activity type.
        Returns:
        One of the activity types such as 'ab', 'aem', 'xt' or null if resource is not an activity.

      • getSyncStatus

        String getSyncStatus()
        Returns the activity sync status.
        Returns:
        One of the activity sync states such as'synced', 'synced-with-errors', 'not-synced' or null if resource is not an activity.

      • getSyncError

        String getSyncError()
        Returns the last synchronization error in an untranslated form as returned by the remote service.
        Returns:
        The synchronization error or null

      • getActiveStatus

        String getActiveStatus()
        Returns the activity active status.
        Returns:
        One of the activity active states such as 'live' or 'inactive' or null if the resource is not an activity.

      • getLocations

        Collection<Location> getLocations()
        Returns a collection of Location's related to this activity.
        Returns:
        A collection of location's

      • getTargetConfigurationPath

        String getTargetConfigurationPath()
        Returns the path to the target configuration.
        Returns:
        Path to target configuration or null if target is not configured for this activity.

      • getModifiedDate

        Calendar getModifiedDate()
        Returns the modification date or null if this information is not available.
        Returns:
        Modification date or null

      • getModifiedBy

        String getModifiedBy()
        Returns the formatted user name by whom the item has been modified.
        Returns:
        Formatted user name or identifier if an error occurred.

      • getPublishedDate

        Calendar getPublishedDate()
        Returns the published date or null if this information is not available.
        Returns:
        Publication date or null

      • getPublishedBy

        String getPublishedBy()
        Returns the formatted user name by whom the item has been published.
        Returns:
        Formatted user name or identifier if an error occurred.

      • getOnTime

        Calendar getOnTime()
        Returns the date the activity is set to active.
        Returns:
        On date or null

      • getOffTime

        Calendar getOffTime()
        Returns the date the activity is set to inactive.
        Returns:
        Off date or null

      • getQuickactionsRel

        Set<String> getQuickactionsRel()
        Returns a set of relation identifiers for the quick actions.
        Returns:
        Set of relation identifiers

      • isActivity

        boolean isActivity()
        Returns if the item is an activity.
        Returns:
        true if the item is an activity, false otherwise

      • isActive

        boolean isActive()
        Returns if the item is active.
        Returns:
        true if the item is active, false otherwise

      • isPage

        boolean isPage()
        Returns if the item is a Page.
        Returns:
        true if the item is a cq:Page, false otherwise

      • isLiveCopy

        boolean isLiveCopy()
        Returns if the item is a LiveCopy.
        Returns:
        true if the item is a LiveCopy, false otherwise.