Class SearchDocumentsVdrJson
java.lang.Object
com.blackberry.workspaces.sdk.api.json.BaseJson
com.blackberry.workspaces.sdk.api.json.SearchDocumentsVdrJson
- All Implemented Interfaces:
Serializable
public class SearchDocumentsVdrJson extends BaseJson
Used when searching files for a string
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description SearchDocumentsVdrJson()
-
Method Summary
Modifier and Type Method Description DeviceType
getDeviceType()
Device typeApiDocumentOrderVDR
getDocumentOrder()
File order, if left empty set to LAST_UPDATED.String
getFolderGuid()
Folder guidInteger
getFolderId()
Folder idString
getFolderPath()
For search in specific folder, leave empty for entire workspace(s).String
getOrderByTagName()
If ordering by tag name, specify which tag name here.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.TrueFalseEither
getRead()
When searching for only read or un-read files, if omitted will return both.List<String>
getRoomGuids()
List<String>
getRoomIds()
List of workspaces to include in the search, if left null will search in all workspaces that user has access to.String
getSearchString()
The query search string.TrueFalseEither
getStarred()
When searching for only starred or un-starred files, if omitted will return both.Set<String>
getWorkspaceTypes()
boolean
isAdminMode()
For backwards compatibility, switches between admin and non admin view - admin sees all , non admin only personal filesboolean
isOrderAscending()
File order ascending, if left empty set to true.void
setAdminMode(boolean adminMode)
For backwards compatibility, switches between admin and non admin view - admin sees all , non admin only personal filesvoid
setDeviceType(DeviceType deviceType)
Device typevoid
setDocumentOrder(ApiDocumentOrderVDR documentOrder)
File order, if left empty set to LAST_UPDATED.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
setOrderAscending(boolean orderAscending)
File order ascending, if left empty set to true.void
setOrderByTagName(String orderByTagName)
If ordering by tag name, specify which tag name here.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
setRead(TrueFalseEither read)
When searching for only read or un-read files, if omitted will return both.void
setRoomGuids(List<String> roomGuids)
void
setRoomIds(List<String> roomIds)
List of workspaces to include in the search, if left null will search in all workspaces that user has access to.void
setSearchString(String searchString)
The query search string.void
setStarred(TrueFalseEither starred)
When searching for only starred or un-starred files, if omitted will return both.void
setWorkspaceTypes(Set<String> workspaceTypes)
Methods inherited from class com.blackberry.workspaces.sdk.api.json.BaseJson
getObjType, setObjType, toString
-
Constructor Details
-
SearchDocumentsVdrJson
public SearchDocumentsVdrJson()
-
-
Method Details
-
getRoomGuids
-
setRoomGuids
-
getDeviceType
Device type- Returns:
- Device type
-
setDeviceType
Device type- Parameters:
deviceType
- Device type
-
getRoomIds
List of workspaces to include in the search, if left null will search in all workspaces that user has access to.- Returns:
- List of workspaces to include in the search, if left null will search in all workspaces that user has access to.
-
setRoomIds
List of workspaces to include in the search, if left null will search in all workspaces that user has access to.- Parameters:
roomIds
- List of workspaces to include in the search, if left null will search in all workspaces that user has access to.
-
getRead
When searching for only read or un-read files, if omitted will return both.- Returns:
- When searching for only read or un-read files, if omitted will return both.
-
setRead
When searching for only read or un-read files, if omitted will return both.- Parameters:
read
- When searching for only read or un-read files, if omitted will return both.
-
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.
-
getOrderByTagName
If ordering by tag name, specify which tag name here.- Returns:
- If ordering by tag name, specify which tag name here.
-
setOrderByTagName
If ordering by tag name, specify which tag name here.- Parameters:
orderByTagName
- If ordering by tag name, specify which tag name here.
-
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). Workspace list must contain only one workspace to use this function.- Returns:
- For search in specific folder, leave empty for entire workspace(s). Workspace list must contain only one workspace to use this function.
-
setFolderPath
For search in specific folder, leave empty for entire workspace(s). Workspace list must contain only one workspace to use this function.- Parameters:
folderPath
- For search in specific folder, leave empty for entire workspace(s). Workspace list must contain only one workspace to use this function.
-
getWorkspaceTypes
-
setWorkspaceTypes
-
getSearchString
The query search string.- Returns:
- The query search string.
-
setSearchString
The query search string.- Parameters:
searchString
- The query search string.
-
getStarred
When searching for only starred or un-starred files, if omitted will return both.- Returns:
- When searching for only starred or un-starred files, if omitted will return both.
-
setStarred
When searching for only starred or un-starred files, if omitted will return both.- Parameters:
starred
- When searching for only starred or un-starred files, if omitted will return both.
-
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
-