Package com.gentics.contentnode.rest.resource.parameter

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 Details

    • 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

    • templateIds

      @QueryParam("template_id") public List<Integer> templateIds
      list of template ids

    • 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

    • excludeMlIds

      @QueryParam("excludeMlId") public List<Integer> excludeMlIds
      List of markup language IDs for restricting to pages that have templates with none of the given markup languages

  • Constructor Details

    • PageListParameterBean

      public PageListParameterBean()

  • Method Details