public class ListDocumentsVdrJson extends BaseJson
Constructor and Description |
---|
ListDocumentsVdrJson() |
Modifier and Type | Method and Description |
---|---|
VdrDocumentFilter |
getDocumentFilter()
Filter expired files, default is to show ALL files.
|
VdrDocumentOrder |
getDocumentOrder()
File order, if left empty set to LAST_UPDATED.
|
ApiFilterScope |
getFilterScope()
Filter scope, default is specific folder, if all files from workspace
are needed change to ENTIRE_ROOM.
|
String |
getFolderGuid()
Folder guid
|
Integer |
getFolderId()
Folder id
|
String |
getFolderPath()
For search in specific folder, leave empty for entire workspace(s).
|
boolean |
getIncludeExternalRepository()
Deprecated.
|
String |
getLastVersionUploaderUserAddress() |
Integer |
getPageNumber()
Current page to fetch, if left empty set to 0.
|
Integer |
getPageSize()
Page size for search results, if left empty set to 25.
|
boolean |
isAdminMode()
For backwards compatibility, switches between admin and non admin view
- admin sees all , non admin only personal files
|
boolean |
isFolders()
List folders with files, folders will always appear first.
|
boolean |
isIncludeExternalRepository() |
boolean |
isNoTags()
Will omit the files' tags (saves bandwidth).
|
boolean |
isOrderAscending()
File order ascending, if left empty set to true.
|
boolean |
isShortJson() |
void |
setAdminMode(boolean adminMode)
For backwards compatibility, switches between admin and non admin view
- admin sees all , non admin only personal files
|
void |
setDocumentFilter(VdrDocumentFilter documentFilter)
Filter expired files, default is to show ALL files.
|
void |
setDocumentOrder(VdrDocumentOrder documentOrder)
File order, if left empty set to LAST_UPDATED.
|
void |
setFilterScope(ApiFilterScope filterScope)
Filter scope, default is specific folder, if all files from workspace
are needed change to ENTIRE_ROOM.
|
void |
setFolderGuid(String folderGuid)
Folder guid
|
void |
setFolderId(Integer folderId)
Folder id
|
void |
setFolderPath(String folderPath)
For search in specific folder, leave empty for entire workspace(s).
|
void |
setFolders(boolean folders)
List folders with files, folders will always appear first.
|
void |
setIncludeExternalRepository(boolean includeExternalRepository) |
void |
setLastVersionUploaderUserAddress(String lastVersionUploaderUserAddress) |
void |
setNoTags(boolean noTags)
Will omit the files' tags (saves bandwidth).
|
void |
setOrderAscending(boolean orderAscending)
File order ascending, if left empty set to true.
|
void |
setPageNumber(Integer pageNumber)
Current page to fetch, if left empty set to 0.
|
void |
setPageSize(Integer pageSize)
Page size for search results, if left empty set to 25.
|
void |
setShortJson(boolean shortJson) |
getObjType, setObjType, toString
public VdrDocumentFilter getDocumentFilter()
public void setDocumentFilter(VdrDocumentFilter documentFilter)
documentFilter
- Filter expired files, default is to show ALL
files.public boolean isIncludeExternalRepository()
@Deprecated public boolean getIncludeExternalRepository()
public void setIncludeExternalRepository(boolean includeExternalRepository)
public boolean isNoTags()
public void setNoTags(boolean noTags)
noTags
- Will omit the files' tags (saves bandwidth).public Integer getPageNumber()
public void setPageNumber(Integer pageNumber)
pageNumber
- Current page to fetch, if left empty set to 0.public boolean isFolders()
public void setFolders(boolean folders)
folders
- List folders with files, folders will always appear
first.public String getFolderGuid()
public void setFolderGuid(String folderGuid)
folderGuid
- Folder guidpublic Integer getPageSize()
public void setPageSize(Integer pageSize)
pageSize
- Page size for search results, if left empty set to 25.public VdrDocumentOrder getDocumentOrder()
public void setDocumentOrder(VdrDocumentOrder documentOrder)
documentOrder
- File order, if left empty set to LAST_UPDATED.public Integer getFolderId()
public void setFolderId(Integer folderId)
folderId
- Folder idpublic String getFolderPath()
public void setFolderPath(String folderPath)
folderPath
- For search in specific folder, leave empty for entire
workspace(s). For root folder use '/', and for a folder called folder1
in a folder called folder2. use '/folder2/folder1' alternatively use
folderIdpublic boolean isOrderAscending()
public void setOrderAscending(boolean orderAscending)
orderAscending
- File order ascending, if left empty set to true.public boolean isAdminMode()
public void setAdminMode(boolean adminMode)
adminMode
- For backwards compatibility, switches between admin
and non admin view - admin sees all , non admin only personal filespublic String getLastVersionUploaderUserAddress()
public void setLastVersionUploaderUserAddress(String lastVersionUploaderUserAddress)
public boolean isShortJson()
public void setShortJson(boolean shortJson)
public ApiFilterScope getFilterScope()
public void setFilterScope(ApiFilterScope filterScope)
filterScope
- Filter scope, default is specific folder, if all
files from workspace are needed change to ENTIRE_ROOM.Copyright © 2019. All rights reserved.