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
All Methods Instance Methods Concrete Methods Deprecated Methods 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
-
-
-
-
Method Detail
-
getDocumentFilter
public VdrDocumentFilter getDocumentFilter()
Filter expired files, default is to show ALL files.- Returns:
- Filter expired files, default is to show ALL files.
-
setDocumentFilter
public void setDocumentFilter(VdrDocumentFilter documentFilter)
Filter expired files, default is to show ALL files.- Parameters:
documentFilter
- Filter expired files, default is to show ALL files.
-
isIncludeExternalRepository
public boolean isIncludeExternalRepository()
-
getIncludeExternalRepository
@Deprecated public boolean getIncludeExternalRepository()
Deprecated.
-
setIncludeExternalRepository
public void setIncludeExternalRepository(boolean includeExternalRepository)
-
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
public Integer getPageNumber()
Current page to fetch, if left empty set to 0.- Returns:
- Current page to fetch, if left empty set to 0.
-
setPageNumber
public void setPageNumber(Integer pageNumber)
Current page to fetch, if left empty set to 0.- Parameters:
pageNumber
- Current page to fetch, if left empty set to 0.
-
getFolderGuid
public String getFolderGuid()
Folder guid- Returns:
- Folder guid
-
setFolderGuid
public void setFolderGuid(String folderGuid)
Folder guid- Parameters:
folderGuid
- Folder guid
-
getPageSize
public Integer 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
public void setPageSize(Integer pageSize)
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
public VdrDocumentOrder getDocumentOrder()
File order, if left empty set to LAST_UPDATED.- Returns:
- File order, if left empty set to LAST_UPDATED.
-
setDocumentOrder
public void setDocumentOrder(VdrDocumentOrder documentOrder)
File order, if left empty set to LAST_UPDATED.- Parameters:
documentOrder
- File order, if left empty set to LAST_UPDATED.
-
getFolderId
public Integer getFolderId()
Folder id- Returns:
- Folder id
-
setFolderId
public void setFolderId(Integer folderId)
Folder id- Parameters:
folderId
- Folder id
-
getFolderPath
public String 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
public void setFolderPath(String 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- 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
public String getLastVersionUploaderUserAddress()
-
setLastVersionUploaderUserAddress
public void setLastVersionUploaderUserAddress(String lastVersionUploaderUserAddress)
-
isShortJson
public boolean isShortJson()
-
setShortJson
public void setShortJson(boolean shortJson)
-
getFilterScope
public ApiFilterScope 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
public void setFilterScope(ApiFilterScope filterScope)
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.
-
-