Package com.docusign.esign.model

Class EnvelopeDocument

  • public class EnvelopeDocument
extends Object
    This object contains details about the envelope document..

    • Constructor Detail

      • EnvelopeDocument

        public EnvelopeDocument()

    • Method Detail

      • addedRecipientIds

        public EnvelopeDocument addedRecipientIds​(List<String> addedRecipientIds)
        addedRecipientIds.
        Returns:
        EnvelopeDocument

      • addAddedRecipientIdsItem

        public EnvelopeDocument addAddedRecipientIdsItem​(String addedRecipientIdsItem)
        addAddedRecipientIdsItem.
        Returns:
        EnvelopeDocument

      • getAddedRecipientIds

        public List<String> getAddedRecipientIds()
        .
        Returns:
        addedRecipientIds

      • setAddedRecipientIds

        public void setAddedRecipientIds​(List<String> addedRecipientIds)
        setAddedRecipientIds.

      • attachmentTabId

        public EnvelopeDocument attachmentTabId​(String attachmentTabId)
        attachmentTabId.
        Returns:
        EnvelopeDocument

      • getAttachmentTabId

        public String getAttachmentTabId()
        .
        Returns:
        attachmentTabId

      • setAttachmentTabId

        public void setAttachmentTabId​(String attachmentTabId)
        setAttachmentTabId.

      • authoritativeCopy

        public EnvelopeDocument authoritativeCopy​(String authoritativeCopy)
        authoritativeCopy.
        Returns:
        EnvelopeDocument

      • getAuthoritativeCopy

        public String getAuthoritativeCopy()
        Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled..
        Returns:
        authoritativeCopy

      • setAuthoritativeCopy

        public void setAuthoritativeCopy​(String authoritativeCopy)
        setAuthoritativeCopy.

      • authoritativeCopyMetadata

        public EnvelopeDocument authoritativeCopyMetadata​(PropertyMetadata authoritativeCopyMetadata)
        authoritativeCopyMetadata.
        Returns:
        EnvelopeDocument

      • getAuthoritativeCopyMetadata

        public PropertyMetadata getAuthoritativeCopyMetadata()
        Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents..
        Returns:
        authoritativeCopyMetadata

      • setAuthoritativeCopyMetadata

        public void setAuthoritativeCopyMetadata​(PropertyMetadata authoritativeCopyMetadata)
        setAuthoritativeCopyMetadata.

      • availableDocumentTypes

        public EnvelopeDocument availableDocumentTypes​(List<SignatureType> availableDocumentTypes)
        availableDocumentTypes.
        Returns:
        EnvelopeDocument

      • addAvailableDocumentTypesItem

        public EnvelopeDocument addAvailableDocumentTypesItem​(SignatureType availableDocumentTypesItem)
        addAvailableDocumentTypesItem.
        Returns:
        EnvelopeDocument

      • getAvailableDocumentTypes

        public List<SignatureType> getAvailableDocumentTypes()
        .
        Returns:
        availableDocumentTypes

      • setAvailableDocumentTypes

        public void setAvailableDocumentTypes​(List<SignatureType> availableDocumentTypes)
        setAvailableDocumentTypes.

      • containsPdfFormFields

        public EnvelopeDocument containsPdfFormFields​(String containsPdfFormFields)
        containsPdfFormFields.
        Returns:
        EnvelopeDocument

      • getContainsPdfFormFields

        public String getContainsPdfFormFields()
        .
        Returns:
        containsPdfFormFields

      • setContainsPdfFormFields

        public void setContainsPdfFormFields​(String containsPdfFormFields)
        setContainsPdfFormFields.

      • getDisplay

        public String getDisplay()
        .
        Returns:
        display

      • setDisplay

        public void setDisplay​(String display)
        setDisplay.

      • getDisplayMetadata

        public PropertyMetadata getDisplayMetadata()
        Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents..
        Returns:
        displayMetadata

      • setDisplayMetadata

        public void setDisplayMetadata​(PropertyMetadata displayMetadata)
        setDisplayMetadata.

      • documentBase64

        public EnvelopeDocument documentBase64​(String documentBase64)
        documentBase64.
        Returns:
        EnvelopeDocument

      • getDocumentBase64

        public String getDocumentBase64()
        .
        Returns:
        documentBase64

      • setDocumentBase64

        public void setDocumentBase64​(String documentBase64)
        setDocumentBase64.

      • addDocumentFieldsItem

        public EnvelopeDocument addDocumentFieldsItem​(NameValue documentFieldsItem)
        addDocumentFieldsItem.
        Returns:
        EnvelopeDocument

      • getDocumentFields

        public List<NameValue> getDocumentFields()
        .
        Returns:
        documentFields

      • setDocumentFields

        public void setDocumentFields​(List<NameValue> documentFields)
        setDocumentFields.

      • documentId

        public EnvelopeDocument documentId​(String documentId)
        documentId.
        Returns:
        EnvelopeDocument

      • getDocumentId

        public String getDocumentId()
        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute..
        Returns:
        documentId

      • setDocumentId

        public void setDocumentId​(String documentId)
        setDocumentId.

      • documentIdGuid

        public EnvelopeDocument documentIdGuid​(String documentIdGuid)
        documentIdGuid.
        Returns:
        EnvelopeDocument

      • getDocumentIdGuid

        public String getDocumentIdGuid()
        .
        Returns:
        documentIdGuid

      • setDocumentIdGuid

        public void setDocumentIdGuid​(String documentIdGuid)
        setDocumentIdGuid.

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        This object describes errors that occur. It is only valid for responses and ignored in requests..
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • includeInDownload

        public EnvelopeDocument includeInDownload​(String includeInDownload)
        includeInDownload.
        Returns:
        EnvelopeDocument

      • getIncludeInDownload

        public String getIncludeInDownload()
        .
        Returns:
        includeInDownload

      • setIncludeInDownload

        public void setIncludeInDownload​(String includeInDownload)
        setIncludeInDownload.

      • includeInDownloadMetadata

        public EnvelopeDocument includeInDownloadMetadata​(PropertyMetadata includeInDownloadMetadata)
        includeInDownloadMetadata.
        Returns:
        EnvelopeDocument

      • getIncludeInDownloadMetadata

        public PropertyMetadata getIncludeInDownloadMetadata()
        Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents..
        Returns:
        includeInDownloadMetadata

      • setIncludeInDownloadMetadata

        public void setIncludeInDownloadMetadata​(PropertyMetadata includeInDownloadMetadata)
        setIncludeInDownloadMetadata.

      • getName

        public String getName()
        .
        Returns:
        name

      • setName

        public void setName​(String name)
        setName.

      • getNameMetadata

        public PropertyMetadata getNameMetadata()
        Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents..
        Returns:
        nameMetadata

      • setNameMetadata

        public void setNameMetadata​(PropertyMetadata nameMetadata)
        setNameMetadata.

      • getOrder

        public String getOrder()
        .
        Returns:
        order

      • setOrder

        public void setOrder​(String order)
        setOrder.

      • addPagesItem

        public EnvelopeDocument addPagesItem​(Page pagesItem)
        addPagesItem.
        Returns:
        EnvelopeDocument

      • getPages

        public List<Page> getPages()
        .
        Returns:
        pages

      • setPages

        public void setPages​(List<Page> pages)
        setPages.

      • signerMustAcknowledge

        public EnvelopeDocument signerMustAcknowledge​(String signerMustAcknowledge)
        signerMustAcknowledge.
        Returns:
        EnvelopeDocument

      • getSignerMustAcknowledge

        public String getSignerMustAcknowledge()
        .
        Returns:
        signerMustAcknowledge

      • setSignerMustAcknowledge

        public void setSignerMustAcknowledge​(String signerMustAcknowledge)
        setSignerMustAcknowledge.

      • signerMustAcknowledgeMetadata

        public EnvelopeDocument signerMustAcknowledgeMetadata​(PropertyMetadata signerMustAcknowledgeMetadata)
        signerMustAcknowledgeMetadata.
        Returns:
        EnvelopeDocument

      • getSignerMustAcknowledgeMetadata

        public PropertyMetadata getSignerMustAcknowledgeMetadata()
        Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents..
        Returns:
        signerMustAcknowledgeMetadata

      • setSignerMustAcknowledgeMetadata

        public void setSignerMustAcknowledgeMetadata​(PropertyMetadata signerMustAcknowledgeMetadata)
        setSignerMustAcknowledgeMetadata.

      • getSizeBytes

        public String getSizeBytes()
        .
        Returns:
        sizeBytes

      • setSizeBytes

        public void setSizeBytes​(String sizeBytes)
        setSizeBytes.

      • templateLocked

        public EnvelopeDocument templateLocked​(String templateLocked)
        templateLocked.
        Returns:
        EnvelopeDocument

      • getTemplateLocked

        public String getTemplateLocked()
        When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. .
        Returns:
        templateLocked

      • setTemplateLocked

        public void setTemplateLocked​(String templateLocked)
        setTemplateLocked.

      • templateRequired

        public EnvelopeDocument templateRequired​(String templateRequired)
        templateRequired.
        Returns:
        EnvelopeDocument

      • getTemplateRequired

        public String getTemplateRequired()
        When set to **true**, the sender may not remove the recipient. Used only when working with template recipients..
        Returns:
        templateRequired

      • setTemplateRequired

        public void setTemplateRequired​(String templateRequired)
        setTemplateRequired.

      • getType

        public String getType()
        .
        Returns:
        type

      • setType

        public void setType​(String type)
        setType.

      • getUri

        public String getUri()
        .
        Returns:
        uri

      • setUri

        public void setUri​(String uri)
        setUri.

      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object