com.hellosign.sdk.resource.support

Class Document

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.support.Document

public class Document
extends AbstractResource

Represents a document and its associated (optional) form fields and custom fields. It is also populated based on the API response. This response typically contains the file name and index of the document within the signature request.

Author:

"Chris Paul ([email protected])"

Field Summary

Fields inherited from class com.hellosign.sdk.resource.AbstractResource

dataObj, warnings

Constructor Summary

Constructors

Constructor and Description
Document()
Document(org.json.JSONObject json)

Method Summary

Modifier and Type	Method and Description
void	addFormField(FormField formField) Adds the form field to this document.
List<CustomField>	getCustomFields() Returns the custom fields for this document.
File	getFile() Returns the File associated with this document.
List<FormField>	getFormFields() Returns the form fields for this document.
Integer	getIndex()
String	getName()
boolean	hasName()
void	setFile(File file) Sets the file associated with this document.
void	setFormFields(List<FormField> formFields) Overwrites the form fields for this document.
void	setIndex(Integer index)
void	setName(String name)

Methods inherited from class com.hellosign.sdk.resource.AbstractResource

add, addToList, clearList, get, getBoolean, getConstructor, getDate, getInteger, getJSONObject, getList, getList, getLong, getString, getWarnings, has, hasString, set, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Document

public Document()

Document

public Document(org.json.JSONObject json)
         throws HelloSignException

Throws:

HelloSignException

Method Detail

getFormFields

public List<FormField> getFormFields()

Returns the form fields for this document.

Returns:

List

setFormFields

public void setFormFields(List<FormField> formFields)
                   throws HelloSignException

Overwrites the form fields for this document. This is useful when manually migrating form fields from a template.

Parameters:

formFields - List

Throws:

HelloSignException - thrown if there is a problem adding the FormFields to this Document.

addFormField

public void addFormField(FormField formField)
                  throws HelloSignException

Adds the form field to this document.

Parameters:

formField - FormField

Throws:

HelloSignException - thrown if there is a problem adding the FormFields to this Document.

getCustomFields

public List<CustomField> getCustomFields()

Returns the custom fields for this document.

Returns:

List

getFile

public File getFile()

Returns the File associated with this document.

Returns:

File, or null if it hasn't been set

setFile

public void setFile(File file)

Sets the file associated with this document.

Parameters:

file - File

getName

public String getName()

setName

public void setName(String name)

hasName

public boolean hasName()

getIndex

public Integer getIndex()

setIndex

public void setIndex(Integer index)