Class SearchParameterBean


  • public class SearchParameterBean
    extends Object
    Parameter bean for search requests
    • Field Detail

      • template

        @QueryParam("template")
        @DefaultValue("false")
        public boolean template
        true to add the template to pages
      • folder

        @QueryParam("folder")
        @DefaultValue("false")
        public boolean folder
        true to add the folder to search hits
      • languageVariants

        @QueryParam("langvars")
        @DefaultValue("false")
        public boolean languageVariants
        true to add language variants to pages
      • translationStatus

        @QueryParam("translationstatus")
        @DefaultValue("false")
        public boolean translationStatus
        true to add the translation status to pages
      • contentTags

        @QueryParam("contenttags")
        @DefaultValue("false")
        public boolean contentTags
        true to add content tags to pages
      • objectTags

        @QueryParam("objecttags")
        @DefaultValue("false")
        public boolean objectTags
        true to add object tags to search hits
      • addPrivileges

        @QueryParam("privileges")
        @DefaultValue("false")
        public boolean addPrivileges
        true to add privilege information to folders
      • privilegeMap

        @QueryParam("privilegeMap")
        @DefaultValue("false")
        public boolean privilegeMap
        true to add privilege maps to folders
      • nodeId

        @QueryParam("nodeId")
        @DefaultValue("0")
        public int nodeId
        optional nodeId to restrict search to a specific node
      • folderId

        @QueryParam("folderId")
        public List<Integer> folderId
        optional folderId to restrict search to specific folder(s)
      • recursive

        @QueryParam("recursive")
        @DefaultValue("false")
        public boolean recursive
        flag for restricting search to given folderIds and their subfolders
      • languages

        @QueryParam("language")
        public List<String> languages
        optional list of language codes to restrict search
      • wastebinSearch

        @QueryParam("wastebin")
        @DefaultValue("exclude")
        public WastebinSearch wastebinSearch
        exclude (default) to exclude deleted objects, include to include deleted objects, only to return only deleted objects
      • stagingPackageName

        @QueryParam("package")
        public String stagingPackageName
        optional name for a Content Staging package to check upon the object inclusion status
    • Constructor Detail

      • SearchParameterBean

        public SearchParameterBean()