Class FileListParameterBean


  • public class FileListParameterBean
    extends Object
    Parameter bean for getting files/images of folder
    • Field Detail

      • nodeId

        @QueryParam("nodeId")
        public Integer nodeId
        node id for this folder - for use with multichannelling
      • inherited

        @QueryParam("inherited")
        public Boolean inherited
        true to only return inherited files in the given node, false to only get local/localized files, null to get local and inherited files
      • online

        @QueryParam("online")
        public Boolean online
        true to only return online files, false to only get offline files, null to get both online and offline files
      • broken

        @QueryParam("broken")
        public Boolean broken
        true to only return broken files (where the binary data is missing), false to only get non-broken files, null to get both
      • used

        @QueryParam("used")
        public Boolean used
        true if only used files that are referenced somewhere shall be fetched, false for unused files. If "usedIn" is not specified, this filter will only check in the current channel
      • usedIn

        @QueryParam("usedIn")
        public List<Integer> usedIn
        optional list of channel IDs for extending the "used" filter to multiple channels.
      • folder

        @QueryParam("folder")
        @DefaultValue("false")
        public boolean folder
        True to add the folder information to the returned objects
      • niceUrl

        @QueryParam("niceurl")
        public String niceUrl
        optional regular expression to get files with a nice URL.
    • Constructor Detail

      • FileListParameterBean

        public FileListParameterBean()