Class PageListParameterBean
- java.lang.Object
-
- com.gentics.contentnode.rest.resource.parameter.PageListParameterBean
-
public class PageListParameterBean extends Object
Parameter bean for getting pages of folder
-
-
Field Summary
Fields Modifier and Type Field Description boolean
contentTags
true if the contenttags shall be attached to all returned pages.List<Integer>
excludeMlIds
List of markup language IDs for restricting to pages that have templates with none of the given markup languagesString
filename
(optional) search string for filenames (may be empty)boolean
folder
true when the folder information should be added to the pagesList<Integer>
includeMlIds
List of markup language IDs for restricting to pages that have templates with one of the given markup languagesBoolean
inherited
true to only return inherited pages in the given node, false to only get local/localized pages, null to get local and inherited pagesBoolean
inSync
(optional)Boolean.TRUE
to restrict to pages that are currently in sync with their translation masters,Boolean.FALSE
to restrict to pages that are currently not in sync with their translation masters, and NULL to not consider the translation status information at all.boolean
langFallback
true if the language fallback shall be done when getting pages in a language, false if not.String
language
code of the language in which the pages shall be fetched.boolean
languageVariants
true when the language variants should be added to the pagesString
niceUrl
optional regular expression to get pages with a nice URL.Integer
nodeId
node id of the channel when used in multichannellingboolean
objectTags
true if the objecttags shall be attached to all returned pages.List<Permission>
permission
List of folder permissions which must be granted for folders in order to include their pages in the resultBoolean
planned
(optional) true to restrict to planned pages, false to restrict to unplanned pagesint
priority
priority of the pageBoolean
queued
(optional) true to restrict to queued pages, false to restrict to unqueued pagesboolean
searchContent
(optional) true, if also the content shall be searched, false if notboolean
template
true when the template information should be added to the pagesList<Integer>
templateIds
list of template idsint
timeDue
(optional) difference in seconds for searching pages, that will change their status due to timemanagement within the given timespan.boolean
translationStatus
true if the translationstatus information shall be added for every page, false if not.boolean
workflowOwn
(optional) true to restrict to pages owned by the user in a workflow.boolean
workflowWatch
(optional) true to restrict to pages watched by the user in a workflow.
-
Constructor Summary
Constructors Constructor Description PageListParameterBean()
-
Method Summary
-
-
-
Field Detail
-
nodeId
@QueryParam("nodeId") public Integer nodeId
node id of the channel when used in multichannelling
-
template
@QueryParam("template") @DefaultValue("false") public boolean template
true when the template information should be added to the pages
-
folder
@QueryParam("folder") @DefaultValue("false") public boolean folder
true when the folder information should be added to the pages
-
languageVariants
@QueryParam("langvars") @DefaultValue("false") public boolean languageVariants
true when the language variants should be added to the pages
-
language
@QueryParam("language") public String language
code of the language in which the pages shall be fetched.
-
langFallback
@QueryParam("langfallback") @DefaultValue("true") public boolean langFallback
true if the language fallback shall be done when getting pages in a language, false if not. If a page is not present in the given language and langFallback is true, the language variant with highest priority in the node is used instead, otherwise the page will not be present in the list
-
contentTags
@QueryParam("contenttags") @DefaultValue("false") public boolean contentTags
true if the contenttags shall be attached to all returned pages. Default is false
-
objectTags
@QueryParam("objecttags") @DefaultValue("false") public boolean objectTags
true if the objecttags shall be attached to all returned pages. Default is false
-
searchContent
@QueryParam("searchcontent") @DefaultValue("false") public boolean searchContent
(optional) true, if also the content shall be searched, false if not
-
filename
@QueryParam("filename") public String filename
(optional) search string for filenames (may be empty)
-
timeDue
@QueryParam("timedue") @DefaultValue("0") public int timeDue
(optional) difference in seconds for searching pages, that will change their status due to timemanagement within the given timespan. When set to 0 (default), the timemanagement will not be considered.
-
workflowOwn
@QueryParam("wfown") @DefaultValue("false") public boolean workflowOwn
(optional) true to restrict to pages owned by the user in a workflow. Defaults to false.
-
workflowWatch
@QueryParam("wfwatch") @DefaultValue("false") public boolean workflowWatch
(optional) true to restrict to pages watched by the user in a workflow. Defaults to false.
-
inSync
@QueryParam("insync") public Boolean inSync
(optional)Boolean.TRUE
to restrict to pages that are currently in sync with their translation masters,Boolean.FALSE
to restrict to pages that are currently not in sync with their translation masters, and NULL to not consider the translation status information at all. Setting this flag (to either true or false) will also add the translation status information.
-
translationStatus
@QueryParam("translationstatus") @DefaultValue("false") public boolean translationStatus
true if the translationstatus information shall be added for every page, false if not.
-
planned
@QueryParam("planned") public Boolean planned
(optional) true to restrict to planned pages, false to restrict to unplanned pages
-
queued
@QueryParam("queued") public Boolean queued
(optional) true to restrict to queued pages, false to restrict to unqueued pages
-
permission
@QueryParam("permission") public List<Permission> permission
List of folder permissions which must be granted for folders in order to include their pages in the result
-
priority
@QueryParam("priority") @DefaultValue("0") public int priority
priority of the page
-
inherited
@QueryParam("inherited") public Boolean inherited
true to only return inherited pages in the given node, false to only get local/localized pages, null to get local and inherited pages
-
niceUrl
@QueryParam("niceurl") public String niceUrl
optional regular expression to get pages with a nice URL.
-
includeMlIds
@QueryParam("includeMlId") public List<Integer> includeMlIds
List of markup language IDs for restricting to pages that have templates with one of the given markup languages
-
-
Method Detail
-
setNodeId
public PageListParameterBean setNodeId(Integer nodeId)
-
setTemplate
public PageListParameterBean setTemplate(boolean template)
-
setFolder
public PageListParameterBean setFolder(boolean folder)
-
setLanguageVariants
public PageListParameterBean setLanguageVariants(boolean languageVariants)
-
setLanguage
public PageListParameterBean setLanguage(String language)
-
setLangFallback
public PageListParameterBean setLangFallback(boolean langFallback)
-
setContentTags
public PageListParameterBean setContentTags(boolean contentTags)
-
setObjectTags
public PageListParameterBean setObjectTags(boolean objectTags)
-
setSearchContent
public PageListParameterBean setSearchContent(boolean searchContent)
-
setFilename
public PageListParameterBean setFilename(String filename)
-
setTimeDue
public PageListParameterBean setTimeDue(int timeDue)
-
setWorkflowOwn
public PageListParameterBean setWorkflowOwn(boolean workflowOwn)
-
setWorkflowWatch
public PageListParameterBean setWorkflowWatch(boolean workflowWatch)
-
setInSync
public PageListParameterBean setInSync(Boolean inSync)
-
setTranslationStatus
public PageListParameterBean setTranslationStatus(boolean translationStatus)
-
setPlanned
public PageListParameterBean setPlanned(Boolean planned)
-
setQueued
public PageListParameterBean setQueued(Boolean queued)
-
setPermission
public PageListParameterBean setPermission(List<Permission> permission)
-
setPriority
public PageListParameterBean setPriority(int priority)
-
setTemplateIds
public PageListParameterBean setTemplateIds(List<Integer> templateIds)
-
setInherited
public PageListParameterBean setInherited(Boolean inherited)
-
setNiceUrl
public PageListParameterBean setNiceUrl(String niceUrl)
-
setIncludeMlIds
public PageListParameterBean setIncludeMlIds(List<Integer> includeMlIds)
-
setExcludeMlIds
public PageListParameterBean setExcludeMlIds(List<Integer> excludeMlIds)
-
clone
public PageListParameterBean clone()
Create a clone of this parameter bean.
-
-