public class FileListParameterBean extends Object
Modifier and Type | Field and Description |
---|---|
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
|
int |
createdBefore
(optional) timestamp for searching files created before a specific time
|
int |
createdSince
(optional) timestamp for searching files created after a specific time
|
String |
creator
(optional) pattern for searching files by creator
|
int |
editedBefore
(optional) timestamp for searching files edited before a specific time
|
int |
editedSince
(optional) timestamp for searching files edited after a specific time
|
String |
editor
(optional) pattern for searching files by editor
|
boolean |
folder
True to add the folder information to the returned objects
|
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
|
int |
maxItems
maximum number of items to be returned (paging).
|
Integer |
nodeId
node id for this folder - for use with multichannelling
|
Boolean |
online
true to only return online files, false to only get offline files, null to get both online and offline files
|
boolean |
recursive
(optional) true, if subfolders should be integrated into search
|
String |
search
(optional) string to search files for - this will filter the results if
either the ID, the name (partial match or the description (partial match)
matches the given search string.
|
int |
skipCount
number of items to skip from the start of the list (paging).
|
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.
|
Boolean |
used
true if only used files that are referenced somewhere shall be fetched,
false for unused files.
|
List<Integer> |
usedIn
optional list of channel IDs for extending the "used" filter to multiple channels.
|
WastebinSearch |
wastebinSearch
exclude (default) to exclude deleted objects, include to include deleted
objects, only to return only deleted objects
|
Constructor and Description |
---|
FileListParameterBean() |
@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="search") public String search
@QueryParam(value="recursive") public boolean recursive
@QueryParam(value="sortby") @DefaultValue(value="name") public String sortBy
@QueryParam(value="sortorder") @DefaultValue(value="asc") public String sortOrder
@QueryParam(value="editor") public String editor
@QueryParam(value="creator") public String creator
@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="inherited") public Boolean inherited
@QueryParam(value="online") public Boolean online
@QueryParam(value="broken") public Boolean broken
@QueryParam(value="used") public Boolean used
@QueryParam(value="usedIn") public List<Integer> usedIn
@QueryParam(value="wastebin") @DefaultValue(value="exclude") public WastebinSearch wastebinSearch
@QueryParam(value="folder") @DefaultValue(value="false") public boolean folder
public FileListParameterBean setSkipCount(int skipCount)
public FileListParameterBean setMaxItems(int maxItems)
public FileListParameterBean setNodeId(Integer nodeId)
public FileListParameterBean setSearch(String search)
public FileListParameterBean setRecursive(boolean recursive)
public FileListParameterBean setSortBy(String sortBy)
public FileListParameterBean setSortOrder(String sortOrder)
public FileListParameterBean setEditor(String editor)
public FileListParameterBean setCreator(String creator)
public FileListParameterBean setEditedBefore(int editedBefore)
public FileListParameterBean setEditedSince(int editedSince)
public FileListParameterBean setCreatedBefore(int createdBefore)
public FileListParameterBean setCreatedSince(int createdSince)
public FileListParameterBean setInherited(Boolean inherited)
public FileListParameterBean setOnline(Boolean online)
public FileListParameterBean setBroken(Boolean broken)
public FileListParameterBean setUsed(Boolean used)
public FileListParameterBean setUsedIn(List<Integer> usedIn)
public FileListParameterBean setWastebinSearch(WastebinSearch wastebinSearch)
public FileListParameterBean setFolder(boolean folder)
Copyright © 2019 Gentics Software. All rights reserved.