Document (docusign-esign-java 2.0.2 API)

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

@Generated(value="class io.swagger.codegen.languages.JavaClientCodegen",
           date="2016-07-18T18:11:15.675-07: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
`Document`	`applyAnchorTabs(String applyAnchorTabs)` Reserved: TBD
`Document`	`documentBase64(String documentBase64)` The document’s bytes.
`Document`	`documentFields(List<NameValue> documentFields)`
`Document`	`documentId(String documentId)` Specifies the document ID number that the tab is placed on.
`Document`	`encryptedWithKeyManager(String encryptedWithKeyManager)` When set to true, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.\n
`boolean`	`equals(Object o)`
`Document`	`fileExtension(String fileExtension)` The file extension type of the document.
`String`	`getApplyAnchorTabs()`
`String`	`getDocumentBase64()`
`List<NameValue>`	`getDocumentFields()`
`String`	`getDocumentId()`
`String`	`getEncryptedWithKeyManager()`
`String`	`getFileExtension()`
`List<MatchBox>`	`getMatchBoxes()`
`String`	`getName()`
`String`	`getOrder()`
`String`	`getPages()`
`String`	`getPassword()`
`String`	`getRemoteUrl()`
`String`	`getTransformPdfFields()`
`String`	`getUri()`
`int`	`hashCode()`
`Document`	`matchBoxes(List<MatchBox> matchBoxes)` Matchboxes define areas in a document for document matching when you are creating envelopes.
`Document`	`name(String name)`
`Document`	`order(String order)`
`Document`	`pages(String pages)`
`Document`	`password(String password)`
`Document`	`remoteUrl(String remoteUrl)` The file id from the cloud storage service where the document is located.
`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()`
`Document`	`transformPdfFields(String transformPdfFields)` 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.
`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
  - documentId
```
public Document documentId(String documentId)
```
    Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
  - getDocumentId
```
public String getDocumentId()
```
  - setDocumentId
```
public void setDocumentId(String documentId)
```
  - uri
```
public Document uri(String uri)
```
  - getUri
```
public String getUri()
```
  - setUri
```
public void setUri(String uri)
```
  - remoteUrl
```
public Document remoteUrl(String remoteUrl)
```
    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}].
  - getRemoteUrl
```
public String getRemoteUrl()
```
  - setRemoteUrl
```
public void setRemoteUrl(String remoteUrl)
```
  - name
```
public Document name(String name)
```
  - getName
```
public String getName()
```
  - setName
```
public void setName(String name)
```
  - password
```
public Document password(String password)
```
  - getPassword
```
public String getPassword()
```
  - setPassword
```
public void setPassword(String password)
```
  - transformPdfFields
```
public Document transformPdfFields(String transformPdfFields)
```
    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.
  - getTransformPdfFields
```
public String getTransformPdfFields()
```
  - setTransformPdfFields
```
public void setTransformPdfFields(String transformPdfFields)
```
  - fileExtension
```
public Document fileExtension(String fileExtension)
```
    The file extension type of the document. If the document is not a PDF it is converted to a PDF.\n
  - getFileExtension
```
public String getFileExtension()
```
  - setFileExtension
```
public void setFileExtension(String fileExtension)
```
  - matchBoxes
```
public Document matchBoxes(List<MatchBox> matchBoxes)
```
    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. \n
  - getMatchBoxes
```
public List<MatchBox> getMatchBoxes()
```
  - setMatchBoxes
```
public void setMatchBoxes(List<MatchBox> matchBoxes)
```
  - order
```
public Document order(String order)
```
  - getOrder
```
public String getOrder()
```
  - setOrder
```
public void setOrder(String order)
```
  - pages
```
public Document pages(String pages)
```
  - getPages
```
public String getPages()
```
  - setPages
```
public void setPages(String pages)
```
  - documentFields
```
public Document documentFields(List<NameValue> documentFields)
```
  - getDocumentFields
```
public List<NameValue> getDocumentFields()
```
  - setDocumentFields
```
public void setDocumentFields(List<NameValue> documentFields)
```
  - encryptedWithKeyManager
```
public Document encryptedWithKeyManager(String encryptedWithKeyManager)
```
    When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.\n
  - getEncryptedWithKeyManager
```
public String getEncryptedWithKeyManager()
```
  - setEncryptedWithKeyManager
```
public void setEncryptedWithKeyManager(String encryptedWithKeyManager)
```
  - documentBase64
```
public Document documentBase64(String documentBase64)
```
    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.
  - getDocumentBase64
```
public String getDocumentBase64()
```
  - setDocumentBase64
```
public void setDocumentBase64(String documentBase64)
```
  - applyAnchorTabs
```
public Document applyAnchorTabs(String applyAnchorTabs)
```
    Reserved: TBD
  - getApplyAnchorTabs
```
public String getApplyAnchorTabs()
```
  - 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

Class Document

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Document

Method Detail

documentId

getDocumentId

setDocumentId

uri

getUri

setUri

remoteUrl

getRemoteUrl

setRemoteUrl

name

getName

setName

password

getPassword

setPassword

transformPdfFields

getTransformPdfFields

setTransformPdfFields

fileExtension

getFileExtension

setFileExtension

matchBoxes

getMatchBoxes

setMatchBoxes

order

getOrder

setOrder

pages

getPages

setPages

documentFields

getDocumentFields

setDocumentFields

encryptedWithKeyManager

getEncryptedWithKeyManager

setEncryptedWithKeyManager

documentBase64

getDocumentBase64

setDocumentBase64

applyAnchorTabs

getApplyAnchorTabs

setApplyAnchorTabs

equals

hashCode

toString