com.docusign.esign.model

Class Document

java.lang.Object

com.docusign.esign.model.Document

public class Document
extends Object

Document

Constructor Summary

Constructors

Constructor and Description
Document()

Method Summary

Methods

Modifier and Type	Method and Description
Document	addDocumentFieldsItem(NameValue documentFieldsItem)
Document	addMatchBoxesItem(MatchBox matchBoxesItem)
Document	addPageSizesItem(PageSize pageSizesItem)
Document	applyAnchorTabs(String applyAnchorTabs)
Document	display(String display)
Document	documentBase64(String documentBase64)
Document	documentFields(List<NameValue> documentFields)
Document	documentGroup(String documentGroup)
Document	documentId(String documentId)
Document	encryptedWithKeyManager(String encryptedWithKeyManager)
boolean	equals(Object o)
Document	fileExtension(String fileExtension)
Document	fileFormatHint(String fileFormatHint)
String	getApplyAnchorTabs() Reserved: TBD
String	getDisplay()
String	getDocumentBase64() The document's bytes.
List<NameValue>	getDocumentFields()
String	getDocumentGroup()
String	getDocumentId() Specifies the document ID number that the tab is placed on.
String	getEncryptedWithKeyManager() When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.
String	getFileExtension() The file extension type of the document.
String	getFileFormatHint()
DocumentHtmlDefinition	getHtmlDefinition() Get htmlDefinition
String	getIncludeInDownload()
List<MatchBox>	getMatchBoxes() Matchboxes define areas in a document for document matching when you are creating envelopes.
String	getName()
String	getOrder()
String	getPageCount()
String	getPages()
List<PageSize>	getPageSizes()
String	getPassword()
String	getPdfFormFieldOption()
String	getRemoteUrl() The file id from the cloud storage service where the document is located.
String	getSignerMustAcknowledge()
Tabs	getTabs() Get tabs
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	getTransformPdfFields() When set to **true**, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel.
String	getUri()
int	hashCode()
Document	htmlDefinition(DocumentHtmlDefinition htmlDefinition)
Document	includeInDownload(String includeInDownload)
Document	matchBoxes(List<MatchBox> matchBoxes)
Document	name(String name)
Document	order(String order)
Document	pageCount(String pageCount)
Document	pages(String pages)
Document	pageSizes(List<PageSize> pageSizes)
Document	password(String password)
Document	pdfFormFieldOption(String pdfFormFieldOption)
Document	remoteUrl(String remoteUrl)
void	setApplyAnchorTabs(String applyAnchorTabs)
void	setDisplay(String display)
void	setDocumentBase64(String documentBase64)
void	setDocumentFields(List<NameValue> documentFields)
void	setDocumentGroup(String documentGroup)
void	setDocumentId(String documentId)
void	setEncryptedWithKeyManager(String encryptedWithKeyManager)
void	setFileExtension(String fileExtension)
void	setFileFormatHint(String fileFormatHint)
void	setHtmlDefinition(DocumentHtmlDefinition htmlDefinition)
void	setIncludeInDownload(String includeInDownload)
void	setMatchBoxes(List<MatchBox> matchBoxes)
void	setName(String name)
void	setOrder(String order)
void	setPageCount(String pageCount)
void	setPages(String pages)
void	setPageSizes(List<PageSize> pageSizes)
void	setPassword(String password)
void	setPdfFormFieldOption(String pdfFormFieldOption)
void	setRemoteUrl(String remoteUrl)
void	setSignerMustAcknowledge(String signerMustAcknowledge)
void	setTabs(Tabs tabs)
void	setTemplateLocked(String templateLocked)
void	setTemplateRequired(String templateRequired)
void	setTransformPdfFields(String transformPdfFields)
void	setUri(String uri)
Document	signerMustAcknowledge(String signerMustAcknowledge)
Document	tabs(Tabs tabs)
Document	templateLocked(String templateLocked)
Document	templateRequired(String templateRequired)
String	toString()
Document	transformPdfFields(String transformPdfFields)
Document	uri(String uri)

Methods inherited from class java.lang.Object

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

Constructor Detail

Document

public Document()

Method Detail

applyAnchorTabs

public Document applyAnchorTabs(String applyAnchorTabs)

getApplyAnchorTabs

public String getApplyAnchorTabs()

Reserved: TBD

Returns:

applyAnchorTabs

setApplyAnchorTabs

public void setApplyAnchorTabs(String applyAnchorTabs)

display

public Document display(String display)

getDisplay

public String getDisplay()

Returns:

display

setDisplay

public void setDisplay(String display)

documentBase64

public Document documentBase64(String documentBase64)

getDocumentBase64

public String getDocumentBase64()

The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.

Returns:

documentBase64

setDocumentBase64

public void setDocumentBase64(String documentBase64)

documentFields

public Document documentFields(List<NameValue> documentFields)

addDocumentFieldsItem

public Document addDocumentFieldsItem(NameValue documentFieldsItem)

getDocumentFields

public List<NameValue> getDocumentFields()

Returns:

documentFields

setDocumentFields

public void setDocumentFields(List<NameValue> documentFields)

documentGroup

public Document documentGroup(String documentGroup)

getDocumentGroup

public String getDocumentGroup()

Returns:

documentGroup

setDocumentGroup

public void setDocumentGroup(String documentGroup)

documentId

public Document 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)

encryptedWithKeyManager

public Document encryptedWithKeyManager(String encryptedWithKeyManager)

getEncryptedWithKeyManager

public String getEncryptedWithKeyManager()

When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.

Returns:

encryptedWithKeyManager

setEncryptedWithKeyManager

public void setEncryptedWithKeyManager(String encryptedWithKeyManager)

fileExtension

public Document fileExtension(String fileExtension)

getFileExtension

public String getFileExtension()

The file extension type of the document. If the document is not a PDF it is converted to a PDF.

Returns:

fileExtension

setFileExtension

public void setFileExtension(String fileExtension)

fileFormatHint

public Document fileFormatHint(String fileFormatHint)

getFileFormatHint

public String getFileFormatHint()

Returns:

fileFormatHint

setFileFormatHint

public void setFileFormatHint(String fileFormatHint)

htmlDefinition

public Document htmlDefinition(DocumentHtmlDefinition htmlDefinition)

getHtmlDefinition

public DocumentHtmlDefinition getHtmlDefinition()

Get htmlDefinition

Returns:

htmlDefinition

setHtmlDefinition

public void setHtmlDefinition(DocumentHtmlDefinition htmlDefinition)

includeInDownload

public Document includeInDownload(String includeInDownload)

getIncludeInDownload

public String getIncludeInDownload()

Returns:

includeInDownload

setIncludeInDownload

public void setIncludeInDownload(String includeInDownload)

matchBoxes

public Document matchBoxes(List<MatchBox> matchBoxes)

addMatchBoxesItem

public Document addMatchBoxesItem(MatchBox matchBoxesItem)

getMatchBoxes

public List<MatchBox> getMatchBoxes()

Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox.

Returns:

matchBoxes

setMatchBoxes

public void setMatchBoxes(List<MatchBox> matchBoxes)

name

public Document name(String name)

getName

public String getName()

Returns:

name

setName

public void setName(String name)

order

public Document order(String order)

getOrder

public String getOrder()

Returns:

order

setOrder

public void setOrder(String order)

pageCount

public Document pageCount(String pageCount)

getPageCount

public String getPageCount()

Returns:

pageCount

setPageCount

public void setPageCount(String pageCount)

pages

public Document pages(String pages)

getPages

public String getPages()

Returns:

pages

setPages

public void setPages(String pages)

pageSizes

public Document pageSizes(List<PageSize> pageSizes)

addPageSizesItem

public Document addPageSizesItem(PageSize pageSizesItem)

getPageSizes

public List<PageSize> getPageSizes()

Returns:

pageSizes

setPageSizes

public void setPageSizes(List<PageSize> pageSizes)

password

public Document password(String password)

getPassword

public String getPassword()

Returns:

password

setPassword

public void setPassword(String password)

pdfFormFieldOption

public Document pdfFormFieldOption(String pdfFormFieldOption)

getPdfFormFieldOption

public String getPdfFormFieldOption()

Returns:

pdfFormFieldOption

setPdfFormFieldOption

public void setPdfFormFieldOption(String pdfFormFieldOption)

remoteUrl

public Document remoteUrl(String remoteUrl)

getRemoteUrl

public String getRemoteUrl()

The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}].

Returns:

remoteUrl

setRemoteUrl

public void setRemoteUrl(String remoteUrl)

signerMustAcknowledge

public Document signerMustAcknowledge(String signerMustAcknowledge)

getSignerMustAcknowledge

public String getSignerMustAcknowledge()

Returns:

signerMustAcknowledge

setSignerMustAcknowledge

public void setSignerMustAcknowledge(String signerMustAcknowledge)

tabs

public Document tabs(Tabs tabs)

getTabs

public Tabs getTabs()

Get tabs

Returns:

tabs

setTabs

public void setTabs(Tabs tabs)

templateLocked

public Document 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 Document 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)

transformPdfFields

public Document transformPdfFields(String transformPdfFields)

getTransformPdfFields

public String getTransformPdfFields()

When set to **true**, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs.

Returns:

transformPdfFields

setTransformPdfFields

public void setTransformPdfFields(String transformPdfFields)

uri

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