com.docusign.esign.model

Class Document

java.lang.Object

com.docusign.esign.model.Document

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2015-12-14T16:41:01.888-08:00")
public class Document
extends Object

Constructor Summary

Constructors

Constructor and Description
Document()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object o)
String	getApplyAnchorTabs() Reserved: TBD
String	getDocumentBase64() The document byte stream.
List<NameValue>	getDocumentFields()
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.
List<MatchBox>	getMatchBoxes() Matchboxes define areas in a document for document matching when you are creating envelopes.
String	getName()
String	getOrder()
String	getPages()
String	getPassword()
String	getRemoteUrl() The file id from the cloud storage service where the document is located.
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()
void	setApplyAnchorTabs(String applyAnchorTabs)
void	setDocumentBase64(String documentBase64)
void	setDocumentFields(List<NameValue> documentFields)
void	setDocumentId(String documentId)
void	setEncryptedWithKeyManager(String encryptedWithKeyManager)
void	setFileExtension(String fileExtension)
void	setMatchBoxes(List<MatchBox> matchBoxes)
void	setName(String name)
void	setOrder(String order)
void	setPages(String pages)
void	setPassword(String password)
void	setRemoteUrl(String remoteUrl)
void	setTransformPdfFields(String transformPdfFields)
void	setUri(String uri)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Document

public Document()

Method Detail

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.

setDocumentId

public void setDocumentId(String documentId)

getUri

public String getUri()

setUri

public void setUri(String uri)

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}].

setRemoteUrl

public void setRemoteUrl(String remoteUrl)

getName

public String getName()

setName

public void setName(String name)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

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.

setTransformPdfFields

public void setTransformPdfFields(String transformPdfFields)

getFileExtension

public String getFileExtension()

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

setFileExtension

public void setFileExtension(String fileExtension)

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. \n\nA matchbox consists of 5 elements:\n\n* pageNumber - The document page number on which the matchbox will appear. \n* xPosition - The x position of the matchbox on a page. \n* yPosition - The y position of the matchbox on a page.\n* width - The width of the matchbox. \n* height - The height of the matchbox.

setMatchBoxes

public void setMatchBoxes(List<MatchBox> matchBoxes)

getOrder

public String getOrder()

setOrder

public void setOrder(String order)

getPages

public String getPages()

setPages

public void setPages(String pages)

getDocumentFields

public List<NameValue> getDocumentFields()

setDocumentFields

public void setDocumentFields(List<NameValue> documentFields)

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.

setEncryptedWithKeyManager

public void setEncryptedWithKeyManager(String encryptedWithKeyManager)

getDocumentBase64

public String getDocumentBase64()

The document byte stream. This allows putting a base64 version of document bytes into an envelope.

setDocumentBase64

public void setDocumentBase64(String documentBase64)

getApplyAnchorTabs

public String getApplyAnchorTabs()

Reserved: TBD

setApplyAnchorTabs

public void setApplyAnchorTabs(String applyAnchorTabs)

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