Class SubmitTransientDocumentResultJson

    • Constructor Detail

      • SubmitTransientDocumentResultJson

        public SubmitTransientDocumentResultJson()
    • Method Detail

      • getPercentCompleted

        public Integer getPercentCompleted()
        Progress status.
        Returns:
        Progress status.
      • setPercentCompleted

        public void setPercentCompleted​(Integer percentCompleted)
        Progress status.
        Parameters:
        percentCompleted - Progress status.
      • getExpires

        public Date getExpires()
        Use permissions instead
        Returns:
        Use permissions instead
      • setExpires

        public void setExpires​(Date expires)
        Use permissions instead
        Parameters:
        expires - Use permissions instead
      • getPreviewUrl

        public String getPreviewUrl()
        URL to preview the file
        Returns:
        URL to preview the file
      • setPreviewUrl

        public void setPreviewUrl​(String previewUrl)
        URL to preview the file
        Parameters:
        previewUrl - URL to preview the file
      • getDownloadPdfSize

        public long getDownloadPdfSize()
      • setDownloadPdfSize

        public void setDownloadPdfSize​(long downloadPdfSize)
      • getPendingRequests

        public Integer getPendingRequests()
        Number of pending requests to access the file
        Returns:
        Number of pending requests to access the file
      • setPendingRequests

        public void setPendingRequests​(Integer pendingRequests)
        Number of pending requests to access the file
        Parameters:
        pendingRequests - Number of pending requests to access the file
      • getLastUpdateDate

        public Date getLastUpdateDate()
        Use 'lastUpdated' instead
        Returns:
        Use 'lastUpdated' instead
      • setLastUpdateDate

        public void setLastUpdateDate​(Date lastUpdateDate)
        Use 'lastUpdated' instead
        Parameters:
        lastUpdateDate - Use 'lastUpdated' instead
      • getType

        public String getType()
        Use 'contentType' instead
        Returns:
        Use 'contentType' instead
      • setType

        public void setType​(String type)
        Use 'contentType' instead
        Parameters:
        type - Use 'contentType' instead
      • getPdfConversionStatus

        public PdfConversionStatus getPdfConversionStatus()
        The status of PDF conversion
        Returns:
        The status of PDF conversion
      • setPdfConversionStatus

        public void setPdfConversionStatus​(PdfConversionStatus pdfConversionStatus)
        The status of PDF conversion
        Parameters:
        pdfConversionStatus - The status of PDF conversion
      • getPath

        public String getPath()
        Path of the file in the transient external repository
        Returns:
        Path of the file in the transient external repository
      • setPath

        public void setPath​(String path)
        Path of the file in the transient external repository
        Parameters:
        path - Path of the file in the transient external repository
      • getLastUpdated

        public Date getLastUpdated()
        Date of creation or last update of the document.
        Returns:
        Date of creation or last update of the document.
      • setLastUpdated

        public void setLastUpdated​(Date lastUpdated)
        Date of creation or last update of the document.
        Parameters:
        lastUpdated - Date of creation or last update of the document.
      • getScore

        public Float getScore()
        The score of the file in the current search
        Returns:
        The score of the file in the current search
      • setScore

        public void setScore​(Float score)
        The score of the file in the current search
        Parameters:
        score - The score of the file in the current search
      • getStarred

        public Boolean getStarred()
        Will be true if the file was marked as starred (favorite).
        Returns:
        Will be true if the file was marked as starred (favorite).
      • setStarred

        public void setStarred​(Boolean starred)
        Will be true if the file was marked as starred (favorite).
        Parameters:
        starred - Will be true if the file was marked as starred (favorite).
      • getConvertedName

        public String getConvertedName()
        Converted name for file
        Returns:
        Converted name for file
      • setConvertedName

        public void setConvertedName​(String convertedName)
        Converted name for file
        Parameters:
        convertedName - Converted name for file
      • setId

        public void setId​(Integer id)
      • getOriginalSize

        public Long getOriginalSize()
        Original size of file (bytes)
        Returns:
        Original size of file (bytes)
      • setOriginalSize

        public void setOriginalSize​(Long originalSize)
        Original size of file (bytes)
        Parameters:
        originalSize - Original size of file (bytes)
      • getContentType

        public String getContentType()
      • setContentType

        public void setContentType​(String contentType)
      • getRead

        public Boolean getRead()
        Will be true if the last file was read since its last update.
        Returns:
        Will be true if the last file was read since its last update.
      • setRead

        public void setRead​(Boolean read)
        Will be true if the last file was read since its last update.
        Parameters:
        read - Will be true if the last file was read since its last update.
      • getAccessLevel

        public DocumentAccessLevel getAccessLevel()
        Document Access Level. Levels are FULL, VIEWER, TRACKING, NONE.
        Returns:
        Document Access Level. Levels are FULL, VIEWER, TRACKING, NONE.
      • setAccessLevel

        public void setAccessLevel​(DocumentAccessLevel accessLevel)
        Document Access Level. Levels are FULL, VIEWER, TRACKING, NONE.
        Parameters:
        accessLevel - Document Access Level. Levels are FULL, VIEWER, TRACKING, NONE.
      • getSecureTransferFile

        public Boolean getSecureTransferFile()
      • setSecureTransferFile

        public void setSecureTransferFile​(Boolean secureTransferFile)
      • getDocumentName

        public String getDocumentName()
        Use 'name' instead
        Returns:
        Use 'name' instead
      • setDocumentName

        public void setDocumentName​(String documentName)
        Use 'name' instead
        Parameters:
        documentName - Use 'name' instead
      • getViewerUrl

        public String getViewerUrl()
        URL of a (protected) file for viewing .
        Returns:
        URL of a (protected) file for viewing .
      • setViewerUrl

        public void setViewerUrl​(String viewerUrl)
        URL of a (protected) file for viewing .
        Parameters:
        viewerUrl - URL of a (protected) file for viewing .
      • getPermissionsJson

        public PermissionsToUserJson getPermissionsJson()
        Permissions, in some contexts may be null.
        Returns:
        Permissions, in some contexts may be null.
      • setPermissionsJson

        public void setPermissionsJson​(PermissionsToUserJson permissionsJson)
        Permissions, in some contexts may be null.
        Parameters:
        permissionsJson - Permissions, in some contexts may be null.
      • getClassification

        public String getClassification()
        Classification, if exists.
        Returns:
        Classification, if exists.
      • setClassification

        public void setClassification​(String classification)
        Classification, if exists.
        Parameters:
        classification - Classification, if exists.
      • getCreationDate

        public Date getCreationDate()
        Date of creation.
        Returns:
        Date of creation.
      • setCreationDate

        public void setCreationDate​(Date creationDate)
        Date of creation.
        Parameters:
        creationDate - Date of creation.
      • getDocumentCurrentVersion

        public DocumentCurrentVersionJson getDocumentCurrentVersion()
        A json which represents the current version of the file
        Returns:
        A json which represents the current version of the file
      • setDocumentCurrentVersion

        public void setDocumentCurrentVersion​(DocumentCurrentVersionJson documentCurrentVersion)
        A json which represents the current version of the file
        Parameters:
        documentCurrentVersion - A json which represents the current version of the file
      • getRoom

        public String getRoom()
        Id of the workspace the file has been submitted to.
        Returns:
        Id of the workspace the file has been submitted to.
      • setRoom

        public void setRoom​(String room)
        Id of the workspace the file has been submitted to.
        Parameters:
        room - Id of the workspace the file has been submitted to.
      • getUrl

        public String getUrl()
        URL of a (protected) file.
        Returns:
        URL of a (protected) file.
      • setUrl

        public void setUrl​(String url)
        URL of a (protected) file.
        Parameters:
        url - URL of a (protected) file.
      • getFolderId

        public Integer getFolderId()
      • setFolderId

        public void setFolderId​(Integer folderId)
      • getRecentlyViewed

        public Date getRecentlyViewed()
        Date file was most recently viewed. not supported any longer - info is meaningless
        Returns:
        Date file was most recently viewed. not supported any longer - info is meaningless
      • setRecentlyViewed

        public void setRecentlyViewed​(Date recentlyViewed)
        Date file was most recently viewed. not supported any longer - info is meaningless
        Parameters:
        recentlyViewed - Date file was most recently viewed. not supported any longer - info is meaningless
      • getTagList

        public TagListJson getTagList()
        Tags, if exist.
        Returns:
        Tags, if exist.
      • setTagList

        public void setTagList​(TagListJson tagList)
        Tags, if exist.
        Parameters:
        tagList - Tags, if exist.
      • getFilename

        public String getFilename()
        File name.
        Returns:
        File name.
      • setFilename

        public void setFilename​(String filename)
        File name.
        Parameters:
        filename - File name.
      • getDownloadSize

        public long getDownloadSize()
      • setDownloadSize

        public void setDownloadSize​(long downloadSize)
      • getFolder

        public String getFolder()
        File's folder, for example: /office/docs
        Returns:
        File's folder, for example: /office/docs
      • setFolder

        public void setFolder​(String folder)
        File's folder, for example: /office/docs
        Parameters:
        folder - File's folder, for example: /office/docs
      • getAnnotationsList

        public DocumentAnnotationsListJson getAnnotationsList()
        A json which represents the users who annotated the file, and the last update date of their annotation
        Returns:
        A json which represents the users who annotated the file, and the last update date of their annotation
      • setAnnotationsList

        public void setAnnotationsList​(DocumentAnnotationsListJson annotationsList)
        A json which represents the users who annotated the file, and the last update date of their annotation
        Parameters:
        annotationsList - A json which represents the users who annotated the file, and the last update date of their annotation
      • getSender

        public String getSender()
        Sender's email address
        Returns:
        Sender's email address
      • setSender

        public void setSender​(String sender)
        Sender's email address
        Parameters:
        sender - Sender's email address
      • getModifiedDate

        public Date getModifiedDate()
        Date of modified.
        Returns:
        Date of modified.
      • setModifiedDate

        public void setModifiedDate​(Date modifiedDate)
        Date of modified.
        Parameters:
        modifiedDate - Date of modified.
      • getName

        public String getName()
        File name
        Returns:
        File name
      • setName

        public void setName​(String name)
        File name
        Parameters:
        name - File name
      • getGuid

        public String getGuid()
        Signed GUID of a file, created by the server.
        Returns:
        Signed GUID of a file, created by the server.
      • setGuid

        public void setGuid​(String guid)
        Signed GUID of a file, created by the server.
        Parameters:
        guid - Signed GUID of a file, created by the server.
      • getStatus

        public StatusJson getStatus()
        Status, status number and error string in case of error.
        Returns:
        Status, status number and error string in case of error.
      • setStatus

        public void setStatus​(StatusJson status)
        Status, status number and error string in case of error.
        Parameters:
        status - Status, status number and error string in case of error.