Package com.day.cq.personalization

Interface Teaser

  • @ProviderType
public interface Teaser
    A teaser meta-data object

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getCampaignName()
      Return the name of the campaign that contains this teaser
      java.lang.String getCampaignPath()
      Returns the path of the campaign that contains this teaser
      java.lang.String getId()
      Returns the unique id of the teaser.
      java.lang.String getName()
      Returns the name of the teaser
      java.lang.String getPath()
      Returns the repository path of the teaser
      java.util.List<java.lang.String> getSegments()
      Returns a list of segments associated with this teaser
      java.lang.String getSourcePath()
      Returns the source repository path of the teaser
      java.util.List<TeaserTag> getTags()
      Returns the list of tags associated to this teaser
      java.lang.String getThumbnailPath()
      Returns the path to the thumbnail of this teaser (the *.thumb.png selector)
      java.lang.String getTitle()
      Returns the title of the teaser
      java.lang.String getUrl()
      Returns the URL to the teaser

    • Method Detail

      • getPath

        java.lang.String getPath()
        Returns the repository path of the teaser
        Returns:
        a String representing the path

      • getSourcePath

        java.lang.String getSourcePath()
        Returns the source repository path of the teaser
        Returns:
        a String representing the path

      • getName

        java.lang.String getName()
        Returns the name of the teaser
        Returns:
        a String representing the name

      • getTitle

        java.lang.String getTitle()
        Returns the title of the teaser
        Returns:
        a String representing the title

      • getCampaignName

        java.lang.String getCampaignName()
        Return the name of the campaign that contains this teaser
        Returns:
        a String representing the name of the campaign

      • getCampaignPath

        java.lang.String getCampaignPath()
        Returns the path of the campaign that contains this teaser
        Returns:
        a String representing the path to the campaign

      • getThumbnailPath

        java.lang.String getThumbnailPath()
        Returns the path to the thumbnail of this teaser (the *.thumb.png selector)
        Returns:
        a String representing the path to the thumbnail

      • getId

        java.lang.String getId()
        Returns the unique id of the teaser.
        Returns:
        a String representing the unique id

      • getSegments

        java.util.List<java.lang.String> getSegments()
        Returns a list of segments associated with this teaser
        Returns:
        a List of String objects, or an empty list if the teaser has no segments

      • getTags

        java.util.List<TeaserTag> getTags()
        Returns the list of tags associated to this teaser
        Returns:
        a List of TeaserTag objects or an empty list if the teaser has no tags

      • getUrl

        java.lang.String getUrl()
        Returns the URL to the teaser
        Returns:
        a String representing the URL