Class Page
java.lang.Object
com.gentics.contentnode.rest.model.ContentNodeItem
com.gentics.contentnode.rest.model.PublishableContentItem
com.gentics.contentnode.rest.model.Page
- All Implemented Interfaces:
Serializable
Page object representing a page in GCN
- Author:
- floriangutmann
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class com.gentics.contentnode.rest.model.ContentNodeItem
ContentNodeItem.ItemType -
Field Summary
FieldsModifier and TypeFieldDescriptionprotected IntegerChannel IDprotected IntegerChannelset IDprotected IntegerContent IDprotected PageVersionCurrent page versionprotected booleantrue when the page is inherited from a master channel, false if notprotected booleantrue when the page is locked, false if notprotected UserUser, who locked the page (iflockedis true)protected intDate when the page was locked, or -1 if the page is not lockedprotected booleantrue if the page is a master page, false if notprotected PageVersionPublished page versionprotected TranslationStatusTranslation statusprotected List<PageVersion>Page versions -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidAdd the given rest tags to the map of all other rest tags for this pageAlternate URLs (in alphabetical order)Get the channel idGet the channelset idContentgroup IDGet the content idContentset IDCurrent version of the pageCustom creation date of the page (set to 0 for clearing custom creation date and falling back to the real creation date)Custom edit date of the page (set to 0 for clearing custom edit date and falling back to the real edit date)Descriptionthe set of disinherited channels for this objectFilenameFolderFolder IDName of the node, this page is inherited from.Return the node id of the node this page is inherited from.Language Code (if page has a language)Language Name (if page has a language)Language variantsLive URL to the pageUser, who locked the pageintTimestamp, since when the page is locked, or -1 if it is not lockedName of the node, the master object belongs toReturn the id of the node, the master object belongs to.Nice URLPage variants of the pagegetPath()Folder path to the pagePriorityPublished version of the pagePublish pathgetTags()Tags of the pageTemplateTemplate IDTime ManagementTranslation status informationgetUrl()URL to the pagePage versionsWorkflow attached to the pageWhether this folder is disinherited by default in new channels.True if the page is disinherited in some channelsWhether this page is excluded from multichannelling.booleanTrue if the page was inheritedbooleanisLocked()True if the page is lockedbooleanisMaster()Get whether this page is a master pagebooleanWhether the page is modified (the last version of the page is not the currently published one)booleanisOnline()Whether the page is currently online.booleanWhether the page has time management set or notbooleanisQueued()Whether the page is in queue for being published or taken offlinebooleanTrue if the page was fetched readonly, false if fetched in edit modevoidsetAlternateUrls(SortedSet<String> alternateUrls) Set the alternate URLsvoidsetChannelId(Integer channelId) Set the channel idvoidsetChannelSetId(Integer channelSetId) Set the channelset idvoidsetContentGroupId(Integer contentGroupId) voidsetContentId(Integer contentId) Set the content idvoidsetContentSetId(Integer contentSetId) voidsetCurrentVersion(PageVersion currentVersion) Set the current versionvoidsetCustomCdate(Integer customCdate) Set custom creation datevoidsetCustomEdate(Integer customEdate) Set custom edit datevoidsetDescription(String description) voidsetDisinheritDefault(Boolean disinheritDefault) Set whether this folder should be disinherited by default in new channels.voidsetDisinherited(Boolean disinherited) Set whether the page is disinheritedvoidsetDisinheritedChannels(Set<Node> disinheritedChannels) Set the disinherited channels for this objectvoidsetExcluded(Boolean excluded) Set wether the page is excluded from multichannellingvoidsetFileName(String fileName) voidvoidsetFolderId(Integer folderId) voidsetInherited(boolean inherited) voidsetInheritedFrom(String inheritedFrom) Sets the name of the node this page is inherited from.voidsetInheritedFromId(Integer inheritedFromId) Set the id of the node this page is inherited from.voidsetLanguage(String language) voidsetLanguageName(String languageName) Set the language namevoidsetLanguageVariants(Map<Object, Page> languageVariants) voidsetLiveUrl(String liveUrl) Set the live URL of the pagevoidsetLocked(boolean locked) voidsetLockedBy(User lockedBy) Set locked byvoidsetLockedSince(int lockedSince) Set the timestamp, since when the page is lockedvoidsetMaster(boolean master) Set true for master pages, false for localized copiesvoidsetMasterNode(String masterNode) Set the name of the node, the master object belongs tovoidsetMasterNodeId(Integer masterNodeId) Set the id of the node the master object belongs to.voidsetModified(boolean modified) Set modified flagvoidsetNiceUrl(String niceUrl) Set the nice URLvoidsetOnline(boolean online) Set the online status of the page.voidsetPageVariants(List<Page> variantIds) voidSet the pathvoidsetPlanned(boolean planned) Set planned flagvoidsetPriority(Integer priority) voidsetPublishedVersion(PageVersion publishedVersion) Set the published versionvoidsetPublishPath(String publishPath) Set the publish pathvoidsetQueued(boolean queued) Set queued flagvoidsetReadOnly(boolean readOnly) voidSet the tagsvoidsetTemplate(Template template) voidsetTemplateId(Integer templateId) voidsetTimeManagement(TimeManagement timeManagement) voidsetTranslationStatus(TranslationStatus translationStatus) Set the translation status informationvoidvoidsetVersions(List<PageVersion> versions) Set the page versionsvoidsetWorkflow(Workflow workflow) Methods inherited from class com.gentics.contentnode.rest.model.PublishableContentItem
getFuturePublisher, getFutureUnpublisher, getPdate, getPublisher, getUnpublishedDate, getUnpublisher, setFuturePublisher, setFutureUnpublisher, setPdate, setPublisher, setUnpublishedDate, setUnpublisherMethods inherited from class com.gentics.contentnode.rest.model.ContentNodeItem
getCdate, getCreator, getDeleted, getEdate, getEditor, getFolderDeleted, getGlobalId, getId, getMasterDeleted, getName, getType, setCdate, setCreator, setDeleted, setEdate, setEditor, setFolderDeleted, setGlobalId, setId, setMasterDeleted, setName, setType
-
Field Details
-
inherited
protected boolean inheritedtrue when the page is inherited from a master channel, false if not -
master
protected boolean mastertrue if the page is a master page, false if not -
locked
protected boolean lockedtrue when the page is locked, false if not -
lockedSince
protected int lockedSinceDate when the page was locked, or -1 if the page is not locked -
lockedBy
User, who locked the page (iflockedis true) -
translationStatus
Translation status -
versions
Page versions -
currentVersion
Current page version -
publishedVersion
Published page version -
contentId
Content ID -
channelId
Channel ID -
channelSetId
Channelset ID
-
-
Constructor Details
-
Page
public Page()Constructor used by JAXB
-
-
Method Details
-
getNiceUrl
Nice URL- Returns:
- nice URL
-
getAlternateUrls
Alternate URLs (in alphabetical order)- Returns:
- sorted alternate URLs
-
getFileName
Filename- Returns:
- the fileName
-
getDescription
Description- Returns:
- the description
-
getTemplateId
Template ID- Returns:
- the templateId
-
getFolderId
Folder ID- Returns:
- the folderId
-
getPriority
Priority- Returns:
- the priority
-
getLanguage
Language Code (if page has a language)- Returns:
- the language
-
getLanguageName
Language Name (if page has a language)- Returns:
- name of the page language
-
getTags
Tags of the page- Returns:
- tags
-
getInheritedFrom
Name of the node, this page is inherited from.- Returns:
-
setInheritedFrom
Sets the name of the node this page is inherited from.- Parameters:
inheritedFrom-
-
getInheritedFromId
Return the node id of the node this page is inherited from.- Returns:
-
setInheritedFromId
Set the id of the node this page is inherited from.- Parameters:
inheritedFromId-
-
getMasterNode
Name of the node, the master object belongs to- Returns:
- node name
-
setMasterNode
Set the name of the node, the master object belongs to- Parameters:
masterNode- node name
-
getMasterNodeId
Return the id of the node, the master object belongs to.- Returns:
-
setMasterNodeId
Set the id of the node the master object belongs to.- Parameters:
masterNodeId-
-
getPageVariants
Page variants of the page- Returns:
- pageVariants
-
setNiceUrl
Set the nice URL- Parameters:
niceUrl- nice URL
-
setAlternateUrls
Set the alternate URLs- Parameters:
alternateUrls- alternate URLs
-
setFileName
- Parameters:
fileName- the fileName to set
-
setDescription
- Parameters:
description- the description to set
-
setTemplateId
- Parameters:
templateId- the templateId to set
-
setFolderId
- Parameters:
folderId- the folderId to set
-
setPriority
- Parameters:
priority- the priority to set
-
setLanguage
- Parameters:
language- the language to set
-
setLanguageName
Set the language name- Parameters:
languageName- language name
-
setTags
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
Time Management- Returns:
- the timeManagement
-
setTimeManagement
- Parameters:
timeManagement- the timeManagement to set
-
setPageVariants
-
getPath
Folder path to the page- Returns:
- path
-
setPath
Set the path- Parameters:
path- the path
-
setUrl
-
getUrl
URL to the page- Returns:
-
setLiveUrl
Set the live URL of the page -
getLiveUrl
Live URL to the page- Returns:
-
setPublishPath
Set the publish path- Parameters:
publishPath- publish path
-
getPublishPath
Publish path- Returns:
- publish path
-
isOnline
public boolean isOnline()Whether the page is currently online.- Returns:
trueif the page is currently online,falseotherwise.
-
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
Template- Returns:
- the template
-
getFolder
Folder- Returns:
- the folder
-
setTemplate
- Parameters:
template- the template to set
-
setFolder
- Parameters:
folder- the folder to set
-
getContentSetId
Contentset ID- Returns:
- the contentSetId
-
getContentGroupId
Contentgroup ID- Returns:
- the contentGroupId
-
setContentSetId
- Parameters:
contentSetId- the contentSetId to set
-
setContentGroupId
- Parameters:
contentGroupId- the contentGroupId to set
-
getLanguageVariants
Language variants- Returns:
- the languageVariants
-
setLanguageVariants
- 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
User, who locked the page- Returns:
- user
-
setLockedBy
Set locked by- Parameters:
lockedBy- user, who locked the page
-
getWorkflow
Workflow attached to the page- Returns:
- the workflow
-
setWorkflow
- Parameters:
workflow- the workflow to set
-
getTranslationStatus
Translation status information- Returns:
- translation status information
-
setTranslationStatus
Set the translation status information- Parameters:
translationStatus- translation status information
-
getCurrentVersion
Current version of the page- Returns:
- current version
-
getPublishedVersion
Published version of the page- Returns:
- published version
-
getVersions
Page versions- Returns:
- page versions
-
setCurrentVersion
Set the current version- Parameters:
currentVersion- current version
-
setPublishedVersion
Set the published version- Parameters:
publishedVersion- published version
-
setVersions
Set the page versions- Parameters:
versions- page versions
-
addTags
Add the given rest tags to the map of all other rest tags for this page- Parameters:
restTags-
-
getContentId
Get the content id- Returns:
- content id
-
setContentId
Set the content id- Parameters:
contentId- content id
-
getChannelSetId
Get the channelset id- Returns:
- channelset id
-
setChannelSetId
Set the channelset id- Parameters:
channelSetId- channelset id
-
getChannelId
Get the channel id- Returns:
- channel id
-
setChannelId
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
the set of disinherited channels for this object- Returns:
- the set of disinherited channels
-
setDisinheritedChannels
Set the disinherited channels for this object- Parameters:
disinheritedChannels- the set of disinherited channnels
-
isExcluded
Whether this page is excluded from multichannelling.- Returns:
- true iff the page should be excluded from multichannelling
-
setExcluded
Set wether the page is excluded from multichannelling- Parameters:
excluded- if true, the page will be excluded from multichannelling
-
isDisinheritDefault
Whether this folder is disinherited by default in new channels.- Returns:
trueif the folder is disinherited in new channels,falseotherwise.
-
setDisinheritDefault
Set whether this folder should be disinherited by default in new channels.- Parameters:
disinheritDefault- If set totruethis folder will be disinherited by default in new channels.
-
isDisinherited
True if the page is disinherited in some channels- Returns:
- true iff the page is disinherited
-
setDisinherited
Set whether the page is disinherited- Parameters:
disinherited- true if disinherited
-
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
Set custom creation date- Parameters:
customCdate- custom creation date
-
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
Set custom edit date- Parameters:
customEdate- custom edit date
-