Class ListIManageFoldersAndDocumentsJson
java.lang.Object
com.blackberry.workspaces.sdk.api.json.BaseJson
com.blackberry.workspaces.sdk.api.json.ListIManageFoldersAndDocumentsJson
- All Implemented Interfaces:
Serializable
public class ListIManageFoldersAndDocumentsJson extends BaseJson
Information for retrieving a list of iManage files and folders for a
workspace or a folder.
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description ListIManageFoldersAndDocumentsJson()
-
Method Summary
Modifier and Type Method Description ApiDocumentOrderVDR
getApiDocumentOrderVDR()
File order, if left empty set to NAME.String
getFolderItemId()
iManage Item Id for a folder.Boolean
getIncludeSharedDocuments()
Include Shared Documents FunctionalityInteger
getPageNumber()
current page to fetch, if left empty set to 0.Integer
getPageSize()
Page size for search results, if left empty set to 25.String
getWorkspaceGuid()
Workspace guidboolean
isOrderAscending()
File order ascending, if left empty set to true.void
setApiDocumentOrderVDR(ApiDocumentOrderVDR apiDocumentOrderVDR)
File order, if left empty set to NAME.void
setFolderItemId(String folderItemId)
iManage Item Id for a folder.void
setIncludeSharedDocuments(Boolean includeSharedDocuments)
Include Shared Documents Functionalityvoid
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
setWorkspaceGuid(String workspaceGuid)
Workspace guidMethods inherited from class com.blackberry.workspaces.sdk.api.json.BaseJson
getObjType, setObjType, toString
-
Constructor Details
-
ListIManageFoldersAndDocumentsJson
public ListIManageFoldersAndDocumentsJson()
-
-
Method Details
-
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.
-
getFolderItemId
iManage Item Id for a folder. When it is empty, the list returned is for the workspace. When folderItemId="iManageSharedDocuments" display the documents shared with the user- Returns:
- iManage Item Id for a folder. When it is empty, the list returned is for the workspace. When folderItemId="iManageSharedDocuments" display the documents shared with the user
-
setFolderItemId
iManage Item Id for a folder. When it is empty, the list returned is for the workspace. When folderItemId="iManageSharedDocuments" display the documents shared with the user- Parameters:
folderItemId
- iManage Item Id for a folder. When it is empty, the list returned is for the workspace. When folderItemId="iManageSharedDocuments" display the documents shared with the user
-
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.
-
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.
-
getApiDocumentOrderVDR
File order, if left empty set to NAME.- Returns:
- File order, if left empty set to NAME.
-
setApiDocumentOrderVDR
File order, if left empty set to NAME.- Parameters:
apiDocumentOrderVDR
- File order, if left empty set to NAME.
-
getWorkspaceGuid
Workspace guid- Returns:
- Workspace guid
-
setWorkspaceGuid
Workspace guid- Parameters:
workspaceGuid
- Workspace guid
-
getIncludeSharedDocuments
Include Shared Documents Functionality- Returns:
- Include Shared Documents Functionality
-
setIncludeSharedDocuments
Include Shared Documents Functionality- Parameters:
includeSharedDocuments
- Include Shared Documents Functionality
-