Class Page

    • Field Detail

      • inherited

        protected boolean inherited
        true when the page is inherited from a master channel, false if not
      • master

        protected boolean master
        true if the page is a master page, false if not
      • locked

        protected boolean locked
        true when the page is locked, false if not
      • lockedSince

        protected int lockedSince
        Date when the page was locked, or -1 if the page is not locked
      • lockedBy

        protected User lockedBy
        User, who locked the page (if locked is true)
      • translationStatus

        protected TranslationStatus translationStatus
        Translation status
      • currentVersion

        protected PageVersion currentVersion
        Current page version
      • publishedVersion

        protected PageVersion publishedVersion
        Published page version
      • contentId

        protected Integer contentId
        Content ID
      • channelId

        protected Integer channelId
        Channel ID
      • channelSetId

        protected Integer channelSetId
        Channelset ID
    • Constructor Detail

      • Page

        public Page()
        Constructor used by JAXB
    • Method Detail

      • getNiceUrl

        public String getNiceUrl()
        Nice URL
        Returns:
        nice URL
      • getAlternateUrls

        public SortedSet<String> getAlternateUrls()
        Alternate URLs (in alphabetical order)
        Returns:
        sorted alternate URLs
      • getFileName

        public String getFileName()
        Filename
        Returns:
        the fileName
      • getDescription

        public String getDescription()
        Description
        Returns:
        the description
      • getTemplateId

        public Integer getTemplateId()
        Template ID
        Returns:
        the templateId
      • getFolderId

        public Integer getFolderId()
        Folder ID
        Returns:
        the folderId
      • getPriority

        public Integer getPriority()
        Priority
        Returns:
        the priority
      • getPublisher

        public User getPublisher()
        Publisher
        Returns:
        the publisher
      • getPdate

        public int getPdate()
        Publish Date
        Returns:
        the pdate
      • getLanguage

        public String getLanguage()
        Language Code (if page has a language)
        Returns:
        the language
      • getLanguageName

        public String getLanguageName()
        Language Name (if page has a language)
        Returns:
        name of the page language
      • getTags

        public Map<String,​Tag> getTags()
        Tags of the page
        Returns:
        tags
      • getInheritedFrom

        public String getInheritedFrom()
        Name of the node, this page is inherited from.
        Returns:
      • setInheritedFrom

        public void setInheritedFrom​(String inheritedFrom)
        Sets the name of the node this page is inherited from.
        Parameters:
        inheritedFrom -
      • getInheritedFromId

        public Integer getInheritedFromId()
        Return the node id of the node this page is inherited from.
        Returns:
      • setInheritedFromId

        public void setInheritedFromId​(Integer inheritedFromId)
        Set the id of the node this page is inherited from.
        Parameters:
        inheritedFromId -
      • getMasterNode

        public String getMasterNode()
        Name of the node, the master object belongs to
        Returns:
        node name
      • setMasterNode

        public void setMasterNode​(String masterNode)
        Set the name of the node, the master object belongs to
        Parameters:
        masterNode - node name
      • getMasterNodeId

        public Integer getMasterNodeId()
        Return the id of the node, the master object belongs to.
        Returns:
      • setMasterNodeId

        public void setMasterNodeId​(Integer masterNodeId)
        Set the id of the node the master object belongs to.
        Parameters:
        masterNodeId -
      • getPageVariants

        public List<Page> getPageVariants()
        Page variants of the page
        Returns:
        pageVariants
      • setNiceUrl

        public void setNiceUrl​(String niceUrl)
        Set the nice URL
        Parameters:
        niceUrl - nice URL
      • setAlternateUrls

        public void setAlternateUrls​(SortedSet<String> alternateUrls)
        Set the alternate URLs
        Parameters:
        alternateUrls - alternate URLs
      • setFileName

        public void setFileName​(String fileName)
        Parameters:
        fileName - the fileName to set
      • setDescription

        public void setDescription​(String description)
        Parameters:
        description - the description to set
      • setTemplateId

        public void setTemplateId​(Integer templateId)
        Parameters:
        templateId - the templateId to set
      • setFolderId

        public void setFolderId​(Integer folderId)
        Parameters:
        folderId - the folderId to set
      • setPriority

        public void setPriority​(Integer priority)
        Parameters:
        priority - the priority to set
      • setPublisher

        public void setPublisher​(User publisher)
        Parameters:
        publisher - the publisher to set
      • setPdate

        public void setPdate​(int pdate)
        Parameters:
        pdate - the pdate to set
      • setLanguage

        public void setLanguage​(String language)
        Parameters:
        language - the language to set
      • setLanguageName

        public void setLanguageName​(String languageName)
        Set the language name
        Parameters:
        languageName - language name
      • setTags

        public void setTags​(Map<String,​Tag> tags)
        Set the tags
        Parameters:
        tags - tags
      • isReadOnly

        public boolean isReadOnly()
        True if the page was fetched readonly, false if fetched in edit mode
        Returns:
      • setReadOnly

        public void setReadOnly​(boolean readOnly)
      • getTimeManagement

        public TimeManagement getTimeManagement()
        Time Management
        Returns:
        the timeManagement
      • setTimeManagement

        public void setTimeManagement​(TimeManagement timeManagement)
        Parameters:
        timeManagement - the timeManagement to set
      • setPageVariants

        public void setPageVariants​(List<Page> variantIds)
      • getPath

        public String getPath()
        Folder path to the page
        Returns:
        path
      • setPath

        public void setPath​(String path)
        Set the path
        Parameters:
        path - the path
      • setUrl

        public void setUrl​(String url)
      • getUrl

        public String getUrl()
        URL to the page
        Returns:
      • setLiveUrl

        public void setLiveUrl​(String liveUrl)
        Set the live URL of the page
      • getLiveUrl

        public String getLiveUrl()
        Live URL to the page
        Returns:
      • setPublishPath

        public void setPublishPath​(String publishPath)
        Set the publish path
        Parameters:
        publishPath - publish path
      • getPublishPath

        public String getPublishPath()
        Publish path
        Returns:
        publish path
      • isOnline

        public boolean isOnline()
        Whether the page is currently online.
        Returns:
        true if the page is currently online, false otherwise.
      • setOnline

        public void setOnline​(boolean online)
        Set the online status of the page.
        Parameters:
        online - The online status.
      • isModified

        public boolean isModified()
        Whether the page is modified (the last version of the page is not the currently published one)
        Returns:
        true for modified page
      • setModified

        public void setModified​(boolean modified)
        Set modified flag
        Parameters:
        modified - flag
      • isQueued

        public boolean isQueued()
        Whether the page is in queue for being published or taken offline
        Returns:
        true for queued page
      • setQueued

        public void setQueued​(boolean queued)
        Set queued flag
        Parameters:
        queued - flag
      • isPlanned

        public boolean isPlanned()
        Whether the page has time management set or not
        Returns:
        true for time management
      • setPlanned

        public void setPlanned​(boolean planned)
        Set planned flag
        Parameters:
        planned - flag
      • getTemplate

        public Template getTemplate()
        Template
        Returns:
        the template
      • getFolder

        public Folder getFolder()
        Folder
        Returns:
        the folder
      • setTemplate

        public void setTemplate​(Template template)
        Parameters:
        template - the template to set
      • setFolder

        public void setFolder​(Folder folder)
        Parameters:
        folder - the folder to set
      • getContentSetId

        public Integer getContentSetId()
        Contentset ID
        Returns:
        the contentSetId
      • getContentGroupId

        public Integer getContentGroupId()
        Contentgroup ID
        Returns:
        the contentGroupId
      • setContentSetId

        public void setContentSetId​(Integer contentSetId)
        Parameters:
        contentSetId - the contentSetId to set
      • setContentGroupId

        public void setContentGroupId​(Integer contentGroupId)
        Parameters:
        contentGroupId - the contentGroupId to set
      • getLanguageVariants

        public Map<Object,​Page> getLanguageVariants()
        Language variants
        Returns:
        the languageVariants
      • setLanguageVariants

        public void setLanguageVariants​(Map<Object,​Page> languageVariants)
        Parameters:
        languageVariants - the languageVariants to set
      • isInherited

        public boolean isInherited()
        True if the page was inherited
        Returns:
      • setInherited

        public void setInherited​(boolean inherited)
      • isLocked

        public boolean isLocked()
        True if the page is locked
        Returns:
        the locked
      • setLocked

        public void setLocked​(boolean locked)
        Parameters:
        locked - the locked to set
      • getLockedSince

        public int getLockedSince()
        Timestamp, since when the page is locked, or -1 if it is not locked
        Returns:
        timestamp of page locking or -1
      • setLockedSince

        public void setLockedSince​(int lockedSince)
        Set the timestamp, since when the page is locked
        Parameters:
        lockedSince - timestamp of page locking or -1
      • getLockedBy

        public User getLockedBy()
        User, who locked the page
        Returns:
        user
      • setLockedBy

        public void setLockedBy​(User lockedBy)
        Set locked by
        Parameters:
        lockedBy - user, who locked the page
      • getWorkflow

        public Workflow getWorkflow()
        Workflow attached to the page
        Returns:
        the workflow
      • setWorkflow

        public void setWorkflow​(Workflow workflow)
        Parameters:
        workflow - the workflow to set
      • getTranslationStatus

        public TranslationStatus getTranslationStatus()
        Translation status information
        Returns:
        translation status information
      • setTranslationStatus

        public void setTranslationStatus​(TranslationStatus translationStatus)
        Set the translation status information
        Parameters:
        translationStatus - translation status information
      • getCurrentVersion

        public PageVersion getCurrentVersion()
        Current version of the page
        Returns:
        current version
      • getPublishedVersion

        public PageVersion getPublishedVersion()
        Published version of the page
        Returns:
        published version
      • getVersions

        public List<PageVersion> getVersions()
        Page versions
        Returns:
        page versions
      • setCurrentVersion

        public void setCurrentVersion​(PageVersion currentVersion)
        Set the current version
        Parameters:
        currentVersion - current version
      • setPublishedVersion

        public void setPublishedVersion​(PageVersion publishedVersion)
        Set the published version
        Parameters:
        publishedVersion - published version
      • setVersions

        public void setVersions​(List<PageVersion> versions)
        Set the page versions
        Parameters:
        versions - page versions
      • addTags

        public void addTags​(Map<String,​Tag> restTags)
        Add the given rest tags to the map of all other rest tags for this page
        Parameters:
        restTags -
      • getContentId

        public Integer getContentId()
        Get the content id
        Returns:
        content id
      • setContentId

        public void setContentId​(Integer contentId)
        Set the content id
        Parameters:
        contentId - content id
      • getChannelSetId

        public Integer getChannelSetId()
        Get the channelset id
        Returns:
        channelset id
      • setChannelSetId

        public void setChannelSetId​(Integer channelSetId)
        Set the channelset id
        Parameters:
        channelSetId - channelset id
      • getChannelId

        public Integer getChannelId()
        Get the channel id
        Returns:
        channel id
      • setChannelId

        public void setChannelId​(Integer channelId)
        Set the channel id
        Parameters:
        channelId - channel id
      • isMaster

        public boolean isMaster()
        Get whether this page is a master page
        Returns:
        true for master pages, false for localized copies
      • setMaster

        public void setMaster​(boolean master)
        Set true for master pages, false for localized copies
        Parameters:
        master - true for master page
      • getDisinheritedChannels

        public Set<Node> getDisinheritedChannels()
        the set of disinherited channels for this object
        Returns:
        the set of disinherited channels
      • setDisinheritedChannels

        public void setDisinheritedChannels​(Set<Node> disinheritedChannels)
        Set the disinherited channels for this object
        Parameters:
        disinheritedChannels - the set of disinherited channnels
      • isExcluded

        public Boolean isExcluded()
        Whether this page is excluded from multichannelling.
        Returns:
        true iff the page should be excluded from multichannelling
      • setExcluded

        public void setExcluded​(Boolean excluded)
        Set wether the page is excluded from multichannelling
        Parameters:
        excluded - if true, the page will be excluded from multichannelling
      • isDisinheritDefault

        public Boolean isDisinheritDefault()
        Whether this folder is disinherited by default in new channels.
        Returns:
        true if the folder is disinherited in new channels, false otherwise.
      • setDisinheritDefault

        public void setDisinheritDefault​(Boolean disinheritDefault)
        Set whether this folder should be disinherited by default in new channels.
        Parameters:
        disinheritDefault - If set to true this folder will be disinherited by default in new channels.
      • isDisinherited

        public Boolean isDisinherited()
        True if the page is disinherited in some channels
        Returns:
        true iff the page is disinherited
      • setDisinherited

        public void setDisinherited​(Boolean disinherited)
        Set whether the page is disinherited
        Parameters:
        disinherited - true if disinherited
      • getCustomCdate

        public Integer getCustomCdate()
        Custom creation date of the page (set to 0 for clearing custom creation date and falling back to the real creation date)
        Returns:
        custom creation date
      • setCustomCdate

        public void setCustomCdate​(Integer customCdate)
        Set custom creation date
        Parameters:
        customCdate - custom creation date
      • getCustomEdate

        public Integer getCustomEdate()
        Custom edit date of the page (set to 0 for clearing custom edit date and falling back to the real edit date)
        Returns:
        custom edit date
      • setCustomEdate

        public void setCustomEdate​(Integer customEdate)
        Set custom edit date
        Parameters:
        customEdate - custom edit date