com.docusign.esign.model

Class EnvelopeDocument

java.lang.Object

com.docusign.esign.model.EnvelopeDocument

public class EnvelopeDocument
extends Object

EnvelopeDocument

Constructor Summary

Constructors

Constructor and Description
EnvelopeDocument()

Method Summary

Methods

Modifier and Type	Method and Description
EnvelopeDocument	addAddedRecipientIdsItem(String addedRecipientIdsItem)
EnvelopeDocument	addAvailableDocumentTypesItem(SignatureType availableDocumentTypesItem)
EnvelopeDocument	addDocumentFieldsItem(NameValue documentFieldsItem)
EnvelopeDocument	addedRecipientIds(List<String> addedRecipientIds)
EnvelopeDocument	addPagesItem(Page pagesItem)
EnvelopeDocument	attachmentTabId(String attachmentTabId)
EnvelopeDocument	authoritativeCopy(String authoritativeCopy)
EnvelopeDocument	authoritativeCopyMetadata(PropertyMetadata authoritativeCopyMetadata)
EnvelopeDocument	availableDocumentTypes(List<SignatureType> availableDocumentTypes)
EnvelopeDocument	containsPdfFormFields(String containsPdfFormFields)
EnvelopeDocument	display(String display)
EnvelopeDocument	displayMetadata(PropertyMetadata displayMetadata)
EnvelopeDocument	documentFields(List<NameValue> documentFields)
EnvelopeDocument	documentGroup(String documentGroup)
EnvelopeDocument	documentId(String documentId)
EnvelopeDocument	documentIdGuid(String documentIdGuid)
boolean	equals(Object o)
EnvelopeDocument	errorDetails(ErrorDetails errorDetails)
List<String>	getAddedRecipientIds()
String	getAttachmentTabId()
String	getAuthoritativeCopy() Specifies the Authoritative copy feature.
PropertyMetadata	getAuthoritativeCopyMetadata() Get authoritativeCopyMetadata
List<SignatureType>	getAvailableDocumentTypes()
String	getContainsPdfFormFields()
String	getDisplay()
PropertyMetadata	getDisplayMetadata() Get displayMetadata
List<NameValue>	getDocumentFields()
String	getDocumentGroup()
String	getDocumentId() Specifies the document ID number that the tab is placed on.
String	getDocumentIdGuid()
ErrorDetails	getErrorDetails() Get errorDetails
String	getIncludeInDownload()
PropertyMetadata	getIncludeInDownloadMetadata() Get includeInDownloadMetadata
String	getName()
PropertyMetadata	getNameMetadata() Get nameMetadata
String	getOrder()
List<Page>	getPages()
String	getSignerMustAcknowledge()
PropertyMetadata	getSignerMustAcknowledgeMetadata() Get signerMustAcknowledgeMetadata
String	getTemplateLocked() When set to **true**, the sender cannot change any attributes of the recipient.
String	getTemplateRequired() When set to **true**, the sender may not remove the recipient.
String	getType()
String	getUri()
int	hashCode()
EnvelopeDocument	includeInDownload(String includeInDownload)
EnvelopeDocument	includeInDownloadMetadata(PropertyMetadata includeInDownloadMetadata)
EnvelopeDocument	name(String name)
EnvelopeDocument	nameMetadata(PropertyMetadata nameMetadata)
EnvelopeDocument	order(String order)
EnvelopeDocument	pages(List<Page> pages)
void	setAddedRecipientIds(List<String> addedRecipientIds)
void	setAttachmentTabId(String attachmentTabId)
void	setAuthoritativeCopy(String authoritativeCopy)
void	setAuthoritativeCopyMetadata(PropertyMetadata authoritativeCopyMetadata)
void	setAvailableDocumentTypes(List<SignatureType> availableDocumentTypes)
void	setContainsPdfFormFields(String containsPdfFormFields)
void	setDisplay(String display)
void	setDisplayMetadata(PropertyMetadata displayMetadata)
void	setDocumentFields(List<NameValue> documentFields)
void	setDocumentGroup(String documentGroup)
void	setDocumentId(String documentId)
void	setDocumentIdGuid(String documentIdGuid)
void	setErrorDetails(ErrorDetails errorDetails)
void	setIncludeInDownload(String includeInDownload)
void	setIncludeInDownloadMetadata(PropertyMetadata includeInDownloadMetadata)
void	setName(String name)
void	setNameMetadata(PropertyMetadata nameMetadata)
void	setOrder(String order)
void	setPages(List<Page> pages)
void	setSignerMustAcknowledge(String signerMustAcknowledge)
void	setSignerMustAcknowledgeMetadata(PropertyMetadata signerMustAcknowledgeMetadata)
void	setTemplateLocked(String templateLocked)
void	setTemplateRequired(String templateRequired)
void	setType(String type)
void	setUri(String uri)
EnvelopeDocument	signerMustAcknowledge(String signerMustAcknowledge)
EnvelopeDocument	signerMustAcknowledgeMetadata(PropertyMetadata signerMustAcknowledgeMetadata)
EnvelopeDocument	templateLocked(String templateLocked)
EnvelopeDocument	templateRequired(String templateRequired)
String	toString()
EnvelopeDocument	type(String type)
EnvelopeDocument	uri(String uri)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnvelopeDocument

public EnvelopeDocument()

Method Detail

addedRecipientIds

public EnvelopeDocument addedRecipientIds(List<String> addedRecipientIds)

addAddedRecipientIdsItem

public EnvelopeDocument addAddedRecipientIdsItem(String addedRecipientIdsItem)

getAddedRecipientIds

public List<String> getAddedRecipientIds()

Returns:

addedRecipientIds

setAddedRecipientIds

public void setAddedRecipientIds(List<String> addedRecipientIds)

attachmentTabId

public EnvelopeDocument attachmentTabId(String attachmentTabId)

getAttachmentTabId

public String getAttachmentTabId()

Returns:

attachmentTabId

setAttachmentTabId

public void setAttachmentTabId(String attachmentTabId)

authoritativeCopy

public EnvelopeDocument authoritativeCopy(String authoritativeCopy)

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)

authoritativeCopyMetadata

public EnvelopeDocument authoritativeCopyMetadata(PropertyMetadata authoritativeCopyMetadata)

getAuthoritativeCopyMetadata

public PropertyMetadata getAuthoritativeCopyMetadata()

Get authoritativeCopyMetadata

Returns:

authoritativeCopyMetadata

setAuthoritativeCopyMetadata

public void setAuthoritativeCopyMetadata(PropertyMetadata authoritativeCopyMetadata)

availableDocumentTypes

public EnvelopeDocument availableDocumentTypes(List<SignatureType> availableDocumentTypes)

addAvailableDocumentTypesItem

public EnvelopeDocument addAvailableDocumentTypesItem(SignatureType availableDocumentTypesItem)

getAvailableDocumentTypes

public List<SignatureType> getAvailableDocumentTypes()

Returns:

availableDocumentTypes

setAvailableDocumentTypes

public void setAvailableDocumentTypes(List<SignatureType> availableDocumentTypes)

containsPdfFormFields

public EnvelopeDocument containsPdfFormFields(String containsPdfFormFields)

getContainsPdfFormFields

public String getContainsPdfFormFields()

Returns:

containsPdfFormFields

setContainsPdfFormFields

public void setContainsPdfFormFields(String containsPdfFormFields)

display

public EnvelopeDocument display(String display)

getDisplay

public String getDisplay()

Returns:

display

setDisplay

public void setDisplay(String display)

displayMetadata

public EnvelopeDocument displayMetadata(PropertyMetadata displayMetadata)

getDisplayMetadata

public PropertyMetadata getDisplayMetadata()

Get displayMetadata

Returns:

displayMetadata

setDisplayMetadata

public void setDisplayMetadata(PropertyMetadata displayMetadata)

documentFields

public EnvelopeDocument documentFields(List<NameValue> documentFields)

addDocumentFieldsItem

public EnvelopeDocument addDocumentFieldsItem(NameValue documentFieldsItem)

getDocumentFields

public List<NameValue> getDocumentFields()

Returns:

documentFields

setDocumentFields

public void setDocumentFields(List<NameValue> documentFields)

documentGroup

public EnvelopeDocument documentGroup(String documentGroup)

getDocumentGroup

public String getDocumentGroup()

Returns:

documentGroup

setDocumentGroup

public void setDocumentGroup(String documentGroup)

documentId

public EnvelopeDocument documentId(String documentId)

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)

documentIdGuid

public EnvelopeDocument documentIdGuid(String documentIdGuid)

getDocumentIdGuid

public String getDocumentIdGuid()

Returns:

documentIdGuid

setDocumentIdGuid

public void setDocumentIdGuid(String documentIdGuid)

errorDetails

public EnvelopeDocument errorDetails(ErrorDetails errorDetails)

getErrorDetails

public ErrorDetails getErrorDetails()

Get errorDetails

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

includeInDownload

public EnvelopeDocument includeInDownload(String includeInDownload)

getIncludeInDownload

public String getIncludeInDownload()

Returns:

includeInDownload

setIncludeInDownload

public void setIncludeInDownload(String includeInDownload)

includeInDownloadMetadata

public EnvelopeDocument includeInDownloadMetadata(PropertyMetadata includeInDownloadMetadata)

getIncludeInDownloadMetadata

public PropertyMetadata getIncludeInDownloadMetadata()

Get includeInDownloadMetadata

Returns:

includeInDownloadMetadata

setIncludeInDownloadMetadata

public void setIncludeInDownloadMetadata(PropertyMetadata includeInDownloadMetadata)

name

public EnvelopeDocument name(String name)

getName

public String getName()

Returns:

name

setName

public void setName(String name)

nameMetadata

public EnvelopeDocument nameMetadata(PropertyMetadata nameMetadata)

getNameMetadata

public PropertyMetadata getNameMetadata()

Get nameMetadata

Returns:

nameMetadata

setNameMetadata

public void setNameMetadata(PropertyMetadata nameMetadata)

order

public EnvelopeDocument order(String order)

getOrder

public String getOrder()

Returns:

order

setOrder

public void setOrder(String order)

pages

public EnvelopeDocument pages(List<Page> pages)

addPagesItem

public EnvelopeDocument addPagesItem(Page pagesItem)

getPages

public List<Page> getPages()

Returns:

pages

setPages

public void setPages(List<Page> pages)

signerMustAcknowledge

public EnvelopeDocument signerMustAcknowledge(String signerMustAcknowledge)

getSignerMustAcknowledge

public String getSignerMustAcknowledge()

Returns:

signerMustAcknowledge

setSignerMustAcknowledge

public void setSignerMustAcknowledge(String signerMustAcknowledge)

signerMustAcknowledgeMetadata

public EnvelopeDocument signerMustAcknowledgeMetadata(PropertyMetadata signerMustAcknowledgeMetadata)

getSignerMustAcknowledgeMetadata

public PropertyMetadata getSignerMustAcknowledgeMetadata()

Get signerMustAcknowledgeMetadata

Returns:

signerMustAcknowledgeMetadata

setSignerMustAcknowledgeMetadata

public void setSignerMustAcknowledgeMetadata(PropertyMetadata signerMustAcknowledgeMetadata)

templateLocked

public EnvelopeDocument templateLocked(String templateLocked)

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)

templateRequired

public EnvelopeDocument templateRequired(String templateRequired)

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)

type

public EnvelopeDocument type(String type)

getType

public String getType()

Returns:

type

setType

public void setType(String type)

uri

public EnvelopeDocument uri(String uri)

getUri

public String getUri()

Returns:

uri

setUri

public void setUri(String uri)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object