Document (docusign-esign-java 2.1.0 API)

java.lang.Object
- com.docusign.esign.model.Document

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2017-03-06T16:42:36.211-08:00")
public class Document
extends Object

Constructor Summary

Constructors
Constructor and Description

Document()

Constructors
Constructor and Description
`Document()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`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`	`getIncludeInDownload()`
`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`	`getSignerMustAcknowledge()`
`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()`
`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`	`setIncludeInDownload(String includeInDownload)`
`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`	`setSignerMustAcknowledge(String signerMustAcknowledge)`
`void`	`setTemplateLocked(String templateLocked)`
`void`	`setTemplateRequired(String templateRequired)`
`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
  - getApplyAnchorTabs
```
public String getApplyAnchorTabs()
```
    Reserved: TBD
  - setApplyAnchorTabs
```
public void setApplyAnchorTabs(String applyAnchorTabs)
```
  - getDisplay
```
public String getDisplay()
```
  - setDisplay
```
public void setDisplay(String display)
```
  - 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.
  - setDocumentBase64
```
public void setDocumentBase64(String documentBase64)
```
  - getDocumentFields
```
public List<NameValue> getDocumentFields()
```
  - setDocumentFields
```
public void setDocumentFields(List<NameValue> documentFields)
```
  - getDocumentGroup
```
public String getDocumentGroup()
```
  - setDocumentGroup
```
public void setDocumentGroup(String documentGroup)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - getIncludeInDownload
```
public String getIncludeInDownload()
```
  - setIncludeInDownload
```
public void setIncludeInDownload(String includeInDownload)
```
  - 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)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - getOrder
```
public String getOrder()
```
  - setOrder
```
public void setOrder(String order)
```
  - getPages
```
public String getPages()
```
  - setPages
```
public void setPages(String pages)
```
  - getPassword
```
public String getPassword()
```
  - setPassword
```
public void setPassword(String password)
```
  - 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)
```
  - getSignerMustAcknowledge
```
public String getSignerMustAcknowledge()
```
  - setSignerMustAcknowledge
```
public void setSignerMustAcknowledge(String signerMustAcknowledge)
```
  - getTemplateLocked
```
public String getTemplateLocked()
```
    When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
  - setTemplateLocked
```
public void setTemplateLocked(String templateLocked)
```
  - getTemplateRequired
```
public String getTemplateRequired()
```
    When set to true, the sender may not remove the recipient. Used only when working with template recipients.
  - setTemplateRequired
```
public void setTemplateRequired(String templateRequired)
```
  - 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)
```
  - getUri
```
public String getUri()
```
  - 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

Class Document

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Document

Method Detail

getApplyAnchorTabs

setApplyAnchorTabs

getDisplay

setDisplay

getDocumentBase64

setDocumentBase64

getDocumentFields

setDocumentFields

getDocumentGroup

setDocumentGroup

getDocumentId

setDocumentId

getEncryptedWithKeyManager

setEncryptedWithKeyManager

getFileExtension

setFileExtension

getIncludeInDownload

setIncludeInDownload

getMatchBoxes

setMatchBoxes

getName

setName

getOrder

setOrder

getPages

setPages

getPassword

setPassword

getRemoteUrl

setRemoteUrl

getSignerMustAcknowledge

setSignerMustAcknowledge

getTemplateLocked

setTemplateLocked

getTemplateRequired

setTemplateRequired

getTransformPdfFields

setTransformPdfFields

getUri

setUri

equals

hashCode

toString