Class FolderListParameterBean
- java.lang.Object
-
- com.gentics.contentnode.rest.resource.parameter.FolderListParameterBean
-
public class FolderListParameterBean extends Object
Parameter bean for getting subfolders of a folder.
-
-
Field Summary
Fields Modifier and Type Field Description boolean
addPrivileges
Whether the privileges shall be added to the folders.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.Integer
nodeId
Node ID of the channel when used in multichannelling.boolean
privilegeMap
Whether the privileges shall be added to the folders as map.List<String>
recursiveIds
Optional list of folder ids, for which the children shall be fetched (ignored if recursive is false).boolean
tree
Whether folders shall be returned as tree(s).
-
Constructor Summary
Constructors Constructor Description FolderListParameterBean()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FolderListParameterBean
clone()
Create a clone of this parameter bean.FolderListParameterBean
setAddPrivileges(boolean addPrivileges)
FolderListParameterBean
setInherited(Boolean inherited)
FolderListParameterBean
setNodeId(Integer nodeId)
FolderListParameterBean
setPrivilegeMap(boolean privilegeMap)
FolderListParameterBean
setRecursiveIds(List<String> recursiveIds)
FolderListParameterBean
setTree(boolean tree)
-
-
-
Field Detail
-
nodeId
@QueryParam("nodeId") public Integer nodeId
Node ID of the channel when used in multichannelling.
-
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.
-
tree
@QueryParam("tree") @DefaultValue("false") public boolean tree
Whether folders shall be returned as tree(s). Subfolders will be attached to their mothers. This only makes sense, when recursive is true.
-
recursiveIds
@QueryParam("recursiveIds") public List<String> recursiveIds
Optional list of folder ids, for which the children shall be fetched (ignored if recursive is false). The ids might be composed as nodeId/folderId to get children for folders in specific channels only.
-
addPrivileges
@QueryParam("addPrivileges") @DefaultValue("false") public boolean addPrivileges
Whether the privileges shall be added to the folders.
-
privilegeMap
@QueryParam("privilegeMap") @DefaultValue("false") public boolean privilegeMap
Whether the privileges shall be added to the folders as map.
-
-
Method Detail
-
setNodeId
public FolderListParameterBean setNodeId(Integer nodeId)
-
setInherited
public FolderListParameterBean setInherited(Boolean inherited)
-
setTree
public FolderListParameterBean setTree(boolean tree)
-
setRecursiveIds
public FolderListParameterBean setRecursiveIds(List<String> recursiveIds)
-
setAddPrivileges
public FolderListParameterBean setAddPrivileges(boolean addPrivileges)
-
setPrivilegeMap
public FolderListParameterBean setPrivilegeMap(boolean privilegeMap)
-
clone
public FolderListParameterBean clone()
Create a clone of this parameter bean.
-
-