public class PageListParameterBean extends Object
Modifier and Type | Field and Description |
---|---|
boolean |
contentTags
true if the contenttags shall be attached to all returned pages.
|
int |
createdBefore
timestamp to search pages, which were created before a given time (0 for all pages)
|
int |
createdSince
timestamp to search pages, which were created since a given time (0 for all pages)
|
String |
creator
pattern for restricting pages by creator
|
int |
editedBefore
timestamp to search pages, which were edited before a given time (0 for all pages)
|
int |
editedSince
timestamp to search pages, which were edited since a given time (0 for all pages)
|
String |
editor
pattern for restricting pages by editor
|
String |
filename
(optional) search string for filenames (may be empty)
|
boolean |
folder
true when the folder information should be added to the pages
|
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
|
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. |
boolean |
isCreator
(optional) true when only the pages created by the user shall be returned
|
boolean |
isEditor
(optional) true when only the pages last edited by the user shall be
returned
|
boolean |
isPublisher
(optional) true when only the pages which were last published by the user
shall be returned
|
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 pages
|
int |
maxItems
maximum number of items to be returned, set to -1 for returning all items
|
String |
niceUrl
optional regular expression to get pages with a nice URL.
|
Integer |
nodeId
node id of the channel when used in multichannelling
|
boolean |
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 result
|
int |
priority
priority of the page
|
int |
publishedBefore
timestamp to search pages, which were published before a given time (0 for all pages)
|
int |
publishedSince
timestamp to search pages, which were published since a given time (0 for all pages)
|
String |
publisher
pattern for restricting pages by publisher
|
boolean |
recursive
(optional) true when the pages shall be fetched recursively, false if
not.
|
String |
search
(optional) search string (may be empty for no search) - this will filter
the results if either the ID, the name (partial match), the description
(partial match) or the nice URL (partial match) matches the given search string.
|
boolean |
searchContent
(optional) true, if also the content shall be searched, false if not
|
int |
skipCount
number of items to be skipped, set to 0 for skipping no items
|
String |
sortBy
(optional) attribute to sort by.
|
String |
sortOrder
(optional) result sort order - may be "asc" for ascending or "desc" for
descending other strings will be ignored.
|
List<PageStatus> |
status
list of page stati
|
boolean |
template
true when the template information should be added to the pages
|
List<Integer> |
templateIds
list of template ids
|
int |
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.
|
WastebinSearch |
wastebinSearch
exclude (default) to exclude deleted objects, include to include deleted
objects, only to return only deleted objects
|
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 and Description |
---|
PageListParameterBean() |
@QueryParam(value="skipCount") @DefaultValue(value="0") public int skipCount
@QueryParam(value="maxItems") @DefaultValue(value="-1") public int maxItems
@QueryParam(value="nodeId") public Integer nodeId
@QueryParam(value="template") @DefaultValue(value="false") public boolean template
@QueryParam(value="folder") @DefaultValue(value="false") public boolean folder
@QueryParam(value="langvars") @DefaultValue(value="false") public boolean languageVariants
@QueryParam(value="language") public String language
@QueryParam(value="langfallback") @DefaultValue(value="true") public boolean langFallback
@QueryParam(value="contenttags") @DefaultValue(value="false") public boolean contentTags
@QueryParam(value="objecttags") @DefaultValue(value="false") public boolean objectTags
@QueryParam(value="search") public String search
@QueryParam(value="searchcontent") @DefaultValue(value="false") public boolean searchContent
@QueryParam(value="filename") public String filename
@QueryParam(value="recursive") @DefaultValue(value="false") public boolean recursive
@QueryParam(value="sortby") @DefaultValue(value="name") public String sortBy
@QueryParam(value="sortorder") @DefaultValue(value="asc") public String sortOrder
@QueryParam(value="iseditor") @DefaultValue(value="false") public boolean isEditor
@QueryParam(value="iscreator") @DefaultValue(value="false") public boolean isCreator
@QueryParam(value="ispublisher") @DefaultValue(value="false") public boolean isPublisher
@QueryParam(value="editor") public String editor
@QueryParam(value="creator") public String creator
@QueryParam(value="publisher") public String publisher
@QueryParam(value="timedue") @DefaultValue(value="0") public int timeDue
@QueryParam(value="wfown") @DefaultValue(value="false") public boolean workflowOwn
@QueryParam(value="wfwatch") @DefaultValue(value="false") public boolean workflowWatch
@QueryParam(value="insync") public Boolean inSync
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.@QueryParam(value="translationstatus") @DefaultValue(value="false") public boolean translationStatus
@QueryParam(value="status") public List<PageStatus> status
@QueryParam(value="permission") public List<Permission> permission
@QueryParam(value="priority") @DefaultValue(value="0") public int priority
@QueryParam(value="editedbefore") @DefaultValue(value="0") public int editedBefore
@QueryParam(value="editedsince") @DefaultValue(value="0") public int editedSince
@QueryParam(value="createdbefore") @DefaultValue(value="0") public int createdBefore
@QueryParam(value="createdsince") @DefaultValue(value="0") public int createdSince
@QueryParam(value="publishedbefore") @DefaultValue(value="0") public int publishedBefore
@QueryParam(value="publishedsince") @DefaultValue(value="0") public int publishedSince
@QueryParam(value="inherited") public Boolean inherited
@QueryParam(value="wastebin") @DefaultValue(value="exclude") public WastebinSearch wastebinSearch
@QueryParam(value="niceurl") public String niceUrl
public PageListParameterBean setSkipCount(int skipCount)
public PageListParameterBean setMaxItems(int maxItems)
public PageListParameterBean setNodeId(Integer nodeId)
public PageListParameterBean setTemplate(boolean template)
public PageListParameterBean setFolder(boolean folder)
public PageListParameterBean setLanguageVariants(boolean languageVariants)
public PageListParameterBean setLanguage(String language)
public PageListParameterBean setLangFallback(boolean langFallback)
public PageListParameterBean setContentTags(boolean contentTags)
public PageListParameterBean setObjectTags(boolean objectTags)
public PageListParameterBean setSearch(String search)
public PageListParameterBean setSearchContent(boolean searchContent)
public PageListParameterBean setFilename(String filename)
public PageListParameterBean setRecursive(boolean recursive)
public PageListParameterBean setSortBy(String sortBy)
public PageListParameterBean setSortOrder(String sortOrder)
public PageListParameterBean setEditor(boolean isEditor)
public PageListParameterBean setCreator(boolean isCreator)
public PageListParameterBean setPublisher(boolean isPublisher)
public PageListParameterBean setEditor(String editor)
public PageListParameterBean setCreator(String creator)
public PageListParameterBean setPublisher(String publisher)
public PageListParameterBean setTimeDue(int timeDue)
public PageListParameterBean setWorkflowOwn(boolean workflowOwn)
public PageListParameterBean setWorkflowWatch(boolean workflowWatch)
public PageListParameterBean setInSync(Boolean inSync)
public PageListParameterBean setTranslationStatus(boolean translationStatus)
public PageListParameterBean setStatus(List<PageStatus> status)
public PageListParameterBean setPermission(List<Permission> permission)
public PageListParameterBean setPriority(int priority)
public PageListParameterBean setTemplateIds(List<Integer> templateIds)
public PageListParameterBean setEditedBefore(int editedBefore)
public PageListParameterBean setEditedSince(int editedSince)
public PageListParameterBean setCreatedBefore(int createdBefore)
public PageListParameterBean setCreatedSince(int createdSince)
public PageListParameterBean setPublishedBefore(int publishedBefore)
public PageListParameterBean setPublishedSince(int publishedSince)
public PageListParameterBean setInherited(Boolean inherited)
public PageListParameterBean setWastebinSearch(WastebinSearch wastebinSearch)
public PageListParameterBean setNiceUrl(String niceUrl)
Copyright © 2019 Gentics Software. All rights reserved.