Class ListDocumentsVdrJson
java.lang.Object
com.blackberry.workspaces.sdk.api.json.BaseJson
com.blackberry.workspaces.sdk.api.json.ListDocumentsVdrJson
- All Implemented Interfaces:
Serializable
public class ListDocumentsVdrJson extends BaseJson
Details of how to obtain a list of files
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description ListDocumentsVdrJson()
-
Method Summary
Modifier and Type Method 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 guidInteger
getFolderId()
Folder idString
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 filesboolean
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 filesvoid
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 guidvoid
setFolderId(Integer folderId)
Folder idvoid
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)
Methods inherited from class com.blackberry.workspaces.sdk.api.json.BaseJson
getObjType, setObjType, toString
-
Constructor Details
-
ListDocumentsVdrJson
public ListDocumentsVdrJson()
-
-
Method Details
-
isIncludeExternalRepository
public boolean isIncludeExternalRepository() -
getIncludeExternalRepository
Deprecated. -
setIncludeExternalRepository
public void setIncludeExternalRepository(boolean includeExternalRepository) -
getDocumentFilter
Filter expired files, default is to show ALL files.- Returns:
- Filter expired files, default is to show ALL files.
-
setDocumentFilter
Filter expired files, default is to show ALL files.- Parameters:
documentFilter
- Filter expired files, default is to show ALL files.
-
isNoTags
public boolean isNoTags()Will omit the files' tags (saves bandwidth).- Returns:
- Will omit the files' tags (saves bandwidth).
-
setNoTags
public void setNoTags(boolean noTags)Will omit the files' tags (saves bandwidth).- Parameters:
noTags
- Will omit the files' tags (saves bandwidth).
-
isFolders
public boolean isFolders()List folders with files, folders will always appear first.- Returns:
- List folders with files, folders will always appear first.
-
setFolders
public void setFolders(boolean folders)List folders with files, folders will always appear first.- Parameters:
folders
- List folders with files, folders will always appear first.
-
getPageNumber
Current page to fetch, if left empty set to 0.- Returns:
- Current page to fetch, if left empty set to 0.
-
setPageNumber
Current page to fetch, if left empty set to 0.- Parameters:
pageNumber
- Current page to fetch, if left empty set to 0.
-
getFolderGuid
Folder guid- Returns:
- Folder guid
-
setFolderGuid
Folder guid- Parameters:
folderGuid
- Folder guid
-
getPageSize
Page size for search results, if left empty set to 25.- Returns:
- Page size for search results, if left empty set to 25.
-
setPageSize
Page size for search results, if left empty set to 25.- Parameters:
pageSize
- Page size for search results, if left empty set to 25.
-
getDocumentOrder
File order, if left empty set to LAST_UPDATED.- Returns:
- File order, if left empty set to LAST_UPDATED.
-
setDocumentOrder
File order, if left empty set to LAST_UPDATED.- Parameters:
documentOrder
- File order, if left empty set to LAST_UPDATED.
-
getFolderId
Folder id- Returns:
- Folder id
-
setFolderId
Folder id- Parameters:
folderId
- Folder id
-
getFolderPath
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 folderId- Returns:
- 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 folderId
-
setFolderPath
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 folderId- Parameters:
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 folderId
-
isOrderAscending
public boolean isOrderAscending()File order ascending, if left empty set to true.- Returns:
- File order ascending, if left empty set to true.
-
setOrderAscending
public void setOrderAscending(boolean orderAscending)File order ascending, if left empty set to true.- Parameters:
orderAscending
- File order ascending, if left empty set to true.
-
isAdminMode
public boolean isAdminMode()For backwards compatibility, switches between admin and non admin view - admin sees all , non admin only personal files- Returns:
- For backwards compatibility, switches between admin and non admin view - admin sees all , non admin only personal files
-
setAdminMode
public void setAdminMode(boolean adminMode)For backwards compatibility, switches between admin and non admin view - admin sees all , non admin only personal files- Parameters:
adminMode
- For backwards compatibility, switches between admin and non admin view - admin sees all , non admin only personal files
-
getLastVersionUploaderUserAddress
-
setLastVersionUploaderUserAddress
-
isShortJson
public boolean isShortJson() -
setShortJson
public void setShortJson(boolean shortJson) -
getFilterScope
Filter scope, default is specific folder, if all files from workspace are needed change to ENTIRE_ROOM.- Returns:
- Filter scope, default is specific folder, if all files from workspace are needed change to ENTIRE_ROOM.
-
setFilterScope
Filter scope, default is specific folder, if all files from workspace are needed change to ENTIRE_ROOM.- Parameters:
filterScope
- Filter scope, default is specific folder, if all files from workspace are needed change to ENTIRE_ROOM.
-