Class SearchDocumentsSdsJson
java.lang.Object
com.blackberry.workspaces.sdk.api.json.BaseJson
com.blackberry.workspaces.sdk.api.json.SearchDocumentsSdsJson
- All Implemented Interfaces:
Serializable
public class SearchDocumentsSdsJson extends BaseJson
Used when searching a file for a string
- See Also:
- Serialized Form
-
Constructor Summary
Constructors Constructor Description SearchDocumentsSdsJson()
-
Method Summary
Modifier and Type Method Description Boolean
getAllStarredDocuments()
Ignore workspace id, return results from SDS and VDR in case of trueApiDocumentOrderSDS
getDocumentOrder()
Document order, if left empty set to LAST_UPDATED.TrueFalseEither
getHidden()
When searching only for hidden or un-starred files, if omitted will return only visible.Boolean
getIncludeStarredTransientDocuments()
Include transient files in the resultsInteger
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 only for read or un-read files, if omitted will return both.String
getSearchString()
The query search string.TrueFalseEither
getStarred()
When searching only for starred or un-starred files, if omitted will return both.Set<String>
getWorkspaceTypes()
Workspace typesboolean
isOrderAscending()
File order ascending, if left empty set to false.void
setAllStarredDocuments(Boolean allStarredDocuments)
Ignore workspace id, return results from SDS and VDR in case of truevoid
setDocumentOrder(ApiDocumentOrderSDS documentOrder)
Document order, if left empty set to LAST_UPDATED.void
setHidden(TrueFalseEither hidden)
When searching only for hidden or un-starred files, if omitted will return only visible.void
setIncludeStarredTransientDocuments(Boolean includeStarredTransientDocuments)
Include transient files in the resultsvoid
setOrderAscending(boolean orderAscending)
File order ascending, if left empty set to false.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 only for read or un-read files, if omitted will return both.void
setSearchString(String searchString)
The query search string.void
setStarred(TrueFalseEither starred)
When searching only for starred or un-starred files, if omitted will return both.void
setWorkspaceTypes(Set<String> workspaceTypes)
Workspace typesMethods inherited from class com.blackberry.workspaces.sdk.api.json.BaseJson
getObjType, setObjType, toString
-
Constructor Details
-
SearchDocumentsSdsJson
public SearchDocumentsSdsJson()
-
-
Method Details
-
getIncludeStarredTransientDocuments
Include transient files in the results- Returns:
- Include transient files in the results
-
setIncludeStarredTransientDocuments
Include transient files in the results- Parameters:
includeStarredTransientDocuments
- Include transient files in the results
-
getSearchString
The query search string.- Returns:
- The query search string.
-
setSearchString
The query search string.- Parameters:
searchString
- The query search string.
-
getWorkspaceTypes
Workspace types- Returns:
- Workspace types
-
setWorkspaceTypes
Workspace types- Parameters:
workspaceTypes
- Workspace types
-
getRead
When searching only for read or un-read files, if omitted will return both.- Returns:
- When searching only for read or un-read files, if omitted will return both.
-
setRead
When searching only for read or un-read files, if omitted will return both.- Parameters:
read
- When searching only for 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.
-
getStarred
When searching only for starred or un-starred files, if omitted will return both.- Returns:
- When searching only for starred or un-starred files, if omitted will return both.
-
setStarred
When searching only for starred or un-starred files, if omitted will return both.- Parameters:
starred
- When searching only for starred or un-starred files, if omitted will return both.
-
getHidden
When searching only for hidden or un-starred files, if omitted will return only visible.- Returns:
- When searching only for hidden or un-starred files, if omitted will return only visible.
-
setHidden
When searching only for hidden or un-starred files, if omitted will return only visible.- Parameters:
hidden
- When searching only for hidden or un-starred files, if omitted will return only visible.
-
isOrderAscending
public boolean isOrderAscending()File order ascending, if left empty set to false.- Returns:
- File order ascending, if left empty set to false.
-
setOrderAscending
public void setOrderAscending(boolean orderAscending)File order ascending, if left empty set to false.- Parameters:
orderAscending
- File order ascending, if left empty set to false.
-
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.
-
getAllStarredDocuments
Ignore workspace id, return results from SDS and VDR in case of true- Returns:
- Ignore workspace id, return results from SDS and VDR in case of true
-
setAllStarredDocuments
Ignore workspace id, return results from SDS and VDR in case of true- Parameters:
allStarredDocuments
- Ignore workspace id, return results from SDS and VDR in case of true
-
getDocumentOrder
Document order, if left empty set to LAST_UPDATED.- Returns:
- Document order, if left empty set to LAST_UPDATED.
-
setDocumentOrder
Document order, if left empty set to LAST_UPDATED.- Parameters:
documentOrder
- Document order, if left empty set to LAST_UPDATED.
-