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 Details

  • Method Details

    • getRoomGuids

      public List<String> getRoomGuids()
    • setRoomGuids

      public void setRoomGuids​(List<String> roomGuids)
    • getDeviceType

      public DeviceType getDeviceType()
      Device type
      Returns:
      Device type
    • setDeviceType

      public void setDeviceType​(DeviceType deviceType)
      Device type
      Parameters:
      deviceType - Device type
    • getRoomIds

      public List<String> 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

      public 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.
      Parameters:
      roomIds - List of workspaces to include in the search, if left null will search in all workspaces that user has access to.
    • getRead

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

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

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

      public String getOrderByTagName()
      If ordering by tag name, specify which tag name here.
      Returns:
      If ordering by tag name, specify which tag name here.
    • setOrderByTagName

      public void setOrderByTagName​(String orderByTagName)
      If ordering by tag name, specify which tag name here.
      Parameters:
      orderByTagName - If ordering by tag name, specify which tag name here.
    • getDocumentOrder

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

      public void setDocumentOrder​(ApiDocumentOrderVDR 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). 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

      public void setFolderPath​(String folderPath)
      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

      public Set<String> getWorkspaceTypes()
    • setWorkspaceTypes

      public void setWorkspaceTypes​(Set<String> workspaceTypes)
    • 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.
    • getStarred

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

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