Class 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 Detail

      • ListIManageFoldersAndDocumentsJson

        public ListIManageFoldersAndDocumentsJson()
    • Method Detail

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

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

        public void setFolderItemId​(String 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
        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.
      • getWorkspaceGuid

        public String getWorkspaceGuid()
        Workspace guid
        Returns:
        Workspace guid
      • setWorkspaceGuid

        public void setWorkspaceGuid​(String workspaceGuid)
        Workspace guid
        Parameters:
        workspaceGuid - Workspace guid
      • getApiDocumentOrderVDR

        public ApiDocumentOrderVDR getApiDocumentOrderVDR()
        File order, if left empty set to NAME.
        Returns:
        File order, if left empty set to NAME.
      • setApiDocumentOrderVDR

        public void setApiDocumentOrderVDR​(ApiDocumentOrderVDR apiDocumentOrderVDR)
        File order, if left empty set to NAME.
        Parameters:
        apiDocumentOrderVDR - File order, if left empty set to NAME.
      • 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.
      • getIncludeSharedDocuments

        public Boolean getIncludeSharedDocuments()
        Include Shared Documents Functionality
        Returns:
        Include Shared Documents Functionality
      • setIncludeSharedDocuments

        public void setIncludeSharedDocuments​(Boolean includeSharedDocuments)
        Include Shared Documents Functionality
        Parameters:
        includeSharedDocuments - Include Shared Documents Functionality