Package com.docusign.esign.model

Class EnvelopeDocument

  • public class EnvelopeDocument
extends java.lang.Object
    EnvelopeDocument.

    • Constructor Detail

      • EnvelopeDocument

        public EnvelopeDocument()

    • Method Detail

      • addedRecipientIds

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

      • addAddedRecipientIdsItem

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

      • getAddedRecipientIds

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

      • setAddedRecipientIds

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

      • attachmentTabId

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

      • getAttachmentTabId

        public java.lang.String getAttachmentTabId()
        .
        Returns:
        attachmentTabId

      • setAttachmentTabId

        public void setAttachmentTabId​(java.lang.String attachmentTabId)
        setAttachmentTabId.

      • authoritativeCopy

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

      • getAuthoritativeCopy

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

      • setAuthoritativeCopy

        public void setAuthoritativeCopy​(java.lang.String authoritativeCopy)
        setAuthoritativeCopy.

      • authoritativeCopyMetadata

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

      • getAuthoritativeCopyMetadata

        public PropertyMetadata getAuthoritativeCopyMetadata()
        Get authoritativeCopyMetadata.
        Returns:
        authoritativeCopyMetadata

      • setAuthoritativeCopyMetadata

        public void setAuthoritativeCopyMetadata​(PropertyMetadata authoritativeCopyMetadata)
        setAuthoritativeCopyMetadata.

      • availableDocumentTypes

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

      • addAvailableDocumentTypesItem

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

      • getAvailableDocumentTypes

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

      • setAvailableDocumentTypes

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

      • containsPdfFormFields

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

      • getContainsPdfFormFields

        public java.lang.String getContainsPdfFormFields()
        .
        Returns:
        containsPdfFormFields

      • setContainsPdfFormFields

        public void setContainsPdfFormFields​(java.lang.String containsPdfFormFields)
        setContainsPdfFormFields.

      • display

        public EnvelopeDocument display​(java.lang.String display)
        display.
        Returns:
        EnvelopeDocument

      • getDisplay

        public java.lang.String getDisplay()
        .
        Returns:
        display

      • setDisplay

        public void setDisplay​(java.lang.String display)
        setDisplay.

      • getDisplayMetadata

        public PropertyMetadata getDisplayMetadata()
        Get displayMetadata.
        Returns:
        displayMetadata

      • setDisplayMetadata

        public void setDisplayMetadata​(PropertyMetadata displayMetadata)
        setDisplayMetadata.

      • documentBase64

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

      • getDocumentBase64

        public java.lang.String getDocumentBase64()
        .
        Returns:
        documentBase64

      • setDocumentBase64

        public void setDocumentBase64​(java.lang.String documentBase64)
        setDocumentBase64.

      • documentFields

        public EnvelopeDocument documentFields​(java.util.List<NameValue> documentFields)
        documentFields.
        Returns:
        EnvelopeDocument

      • addDocumentFieldsItem

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

      • getDocumentFields

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

      • setDocumentFields

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

      • documentId

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

      • getDocumentId

        public java.lang.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​(java.lang.String documentId)
        setDocumentId.

      • documentIdGuid

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

      • getDocumentIdGuid

        public java.lang.String getDocumentIdGuid()
        .
        Returns:
        documentIdGuid

      • setDocumentIdGuid

        public void setDocumentIdGuid​(java.lang.String documentIdGuid)
        setDocumentIdGuid.

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Get errorDetails.
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • includeInDownload

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

      • getIncludeInDownload

        public java.lang.String getIncludeInDownload()
        .
        Returns:
        includeInDownload

      • setIncludeInDownload

        public void setIncludeInDownload​(java.lang.String includeInDownload)
        setIncludeInDownload.

      • includeInDownloadMetadata

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

      • getIncludeInDownloadMetadata

        public PropertyMetadata getIncludeInDownloadMetadata()
        Get includeInDownloadMetadata.
        Returns:
        includeInDownloadMetadata

      • setIncludeInDownloadMetadata

        public void setIncludeInDownloadMetadata​(PropertyMetadata includeInDownloadMetadata)
        setIncludeInDownloadMetadata.

      • name

        public EnvelopeDocument name​(java.lang.String name)
        name.
        Returns:
        EnvelopeDocument

      • getName

        public java.lang.String getName()
        .
        Returns:
        name

      • setName

        public void setName​(java.lang.String name)
        setName.

      • getNameMetadata

        public PropertyMetadata getNameMetadata()
        Get nameMetadata.
        Returns:
        nameMetadata

      • setNameMetadata

        public void setNameMetadata​(PropertyMetadata nameMetadata)
        setNameMetadata.

      • order

        public EnvelopeDocument order​(java.lang.String order)
        order.
        Returns:
        EnvelopeDocument

      • getOrder

        public java.lang.String getOrder()
        .
        Returns:
        order

      • setOrder

        public void setOrder​(java.lang.String order)
        setOrder.

      • pages

        public EnvelopeDocument pages​(java.util.List<Page> pages)
        pages.
        Returns:
        EnvelopeDocument

      • addPagesItem

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

      • getPages

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

      • setPages

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

      • signerMustAcknowledge

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

      • getSignerMustAcknowledge

        public java.lang.String getSignerMustAcknowledge()
        .
        Returns:
        signerMustAcknowledge

      • setSignerMustAcknowledge

        public void setSignerMustAcknowledge​(java.lang.String signerMustAcknowledge)
        setSignerMustAcknowledge.

      • signerMustAcknowledgeMetadata

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

      • getSignerMustAcknowledgeMetadata

        public PropertyMetadata getSignerMustAcknowledgeMetadata()
        Get signerMustAcknowledgeMetadata.
        Returns:
        signerMustAcknowledgeMetadata

      • setSignerMustAcknowledgeMetadata

        public void setSignerMustAcknowledgeMetadata​(PropertyMetadata signerMustAcknowledgeMetadata)
        setSignerMustAcknowledgeMetadata.

      • sizeBytes

        public EnvelopeDocument sizeBytes​(java.lang.String sizeBytes)
        sizeBytes.
        Returns:
        EnvelopeDocument

      • getSizeBytes

        public java.lang.String getSizeBytes()
        .
        Returns:
        sizeBytes

      • setSizeBytes

        public void setSizeBytes​(java.lang.String sizeBytes)
        setSizeBytes.

      • templateLocked

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

      • getTemplateLocked

        public java.lang.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​(java.lang.String templateLocked)
        setTemplateLocked.

      • templateRequired

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

      • getTemplateRequired

        public java.lang.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​(java.lang.String templateRequired)
        setTemplateRequired.

      • type

        public EnvelopeDocument type​(java.lang.String type)
        type.
        Returns:
        EnvelopeDocument

      • getType

        public java.lang.String getType()
        .
        Returns:
        type

      • setType

        public void setType​(java.lang.String type)
        setType.

      • uri

        public EnvelopeDocument uri​(java.lang.String uri)
        uri.
        Returns:
        EnvelopeDocument

      • getUri

        public java.lang.String getUri()
        .
        Returns:
        uri

      • setUri

        public void setUri​(java.lang.String uri)
        setUri.

      • equals

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

      • hashCode

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

      • toString

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