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 Details

  • Method Details

    • getIncludeStarredTransientDocuments

      public Boolean getIncludeStarredTransientDocuments()
      Include transient files in the results
      Returns:
      Include transient files in the results
    • setIncludeStarredTransientDocuments

      public void setIncludeStarredTransientDocuments​(Boolean includeStarredTransientDocuments)
      Include transient files in the results
      Parameters:
      includeStarredTransientDocuments - Include transient files in the results
    • getSearchString

      public String getSearchString()
      The query search string.
      Returns:
      The query search string.
    • setSearchString

      public void setSearchString​(String searchString)
      The query search string.
      Parameters:
      searchString - The query search string.
    • getWorkspaceTypes

      public Set<String> getWorkspaceTypes()
      Workspace types
      Returns:
      Workspace types
    • setWorkspaceTypes

      public void setWorkspaceTypes​(Set<String> workspaceTypes)
      Workspace types
      Parameters:
      workspaceTypes - Workspace types
    • getRead

      public TrueFalseEither 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

      public void setRead​(TrueFalseEither read)
      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

      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.
    • getStarred

      public TrueFalseEither 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

      public void setStarred​(TrueFalseEither starred)
      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

      public TrueFalseEither 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

      public void setHidden​(TrueFalseEither hidden)
      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

      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.
    • getAllStarredDocuments

      public Boolean 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

      public void setAllStarredDocuments​(Boolean allStarredDocuments)
      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

      public ApiDocumentOrderSDS getDocumentOrder()
      Document order, if left empty set to LAST_UPDATED.
      Returns:
      Document order, if left empty set to LAST_UPDATED.
    • setDocumentOrder

      public void setDocumentOrder​(ApiDocumentOrderSDS documentOrder)
      Document order, if left empty set to LAST_UPDATED.
      Parameters:
      documentOrder - Document order, if left empty set to LAST_UPDATED.