com.hellosign.sdk.resource

Class TemplateSignatureRequest

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.AbstractRequest

com.hellosign.sdk.resource.TemplateSignatureRequest

public class TemplateSignatureRequest
extends AbstractRequest

Represents a HelloSign signature request based on one or more Templates. Unlike the SignatureRequest, this object is only used to submit the request. A successfully submitted TemplateSignatureRequest will return a SignatureRequest object from the server.

Author:

"Chris Paul (chris@hellosign.com)"

Field Summary

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

REQUEST_ALLOW_DECLINE, REQUEST_CLIENT_ID, REQUEST_HIDE_TEXT_TAGS, REQUEST_MESSAGE, REQUEST_METADATA, REQUEST_REDIRECT_URL, REQUEST_SUBJECT, REQUEST_TEST_MODE, REQUEST_TITLE, REQUEST_USE_PREEXISTING_FIELDS, REQUEST_USE_TEXT_TAGS, REQUEST_UX_VERSION, UX_VERSION_1, UX_VERSION_2

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

dataObj, warnings

Constructor Summary

Constructors

Constructor and Description
TemplateSignatureRequest()
TemplateSignatureRequest(List<Template> templates) Convenience constructor that accepts a list of Templates.
TemplateSignatureRequest(Template template) Convenience constructor that accepts a single Template.

Method Summary

Modifier and Type	Method and Description
void	addCustomField(CustomField field) Add the custom field to this request.
void	addTemplateId(String id) Adds the template ID to be used in this request.
void	addTemplateId(String id, Integer index) Add the template ID to be used at the specified index.
void	clearCCs() Clears the list of current CC email addresses.
void	clearCustomFields() Clears the current custom fields for this request.
Map<String,String>	getCCs() Returns a reference to the map of current roles to CC email addresses.
Map<String,String>	getCustomFields() Returns the map of custom fields for the template.
List<CustomField>	getCustomFieldsList() Returns a list of CustomField objects for this template.
String	getId()
Map<String,Serializable>	getPostFields() Internal method used to retrieve the necessary POST fields to submit the signature request.
Map<String,Signer>	getSigners() Returns a reference to the signers list.
String	getTemplateId() Get the template ID that will be used with this request.
List<String>	getTemplateIds() Get the list of template IDs that are used for this request.
boolean	hasHideTextTags() Not implemented for templates.
boolean	hasUseTextTags() Not implemented for templates.
Boolean	isHidingTextTags() Not implemented for templates.
Boolean	isUsingTextTags() Not implemented for templates.
void	removeSignerByEmail(String email) Removes signer(s) from this request by email address.
void	setCC(String role, String email) Sets the CC email address for the provided role.
void	setCCs(Map<String,String> newCCs) Overwrites the map of roles to CC email addresses.
void	setCustomFields(Map<String,String> fields) Overwrites the current map of custom fields to the provided map.
void	setCustomFieldValue(String fieldNameOrApiId, String value) Adds the value to fill in for a custom field with the given field name.
void	setHideTextTags(boolean hideTextTags) Not implemented for templates.
void	setSigner(String role, String email, String name) Adds the signer to the list of signers for this request.
void	setSigners(Map<String,Signer> signers) Overwrites the current list of signers for this request with the given list.
void	setTemplateId(String id) Set the template ID of the template that should be used with this request.
void	setUseTextTags(boolean useTextTags) Not implemented for templates.

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

addDocument, addDocument, addFile, addFile, addFileUrl, addMetadata, clearDocuments, getClientId, getDocuments, getFileUrls, getIsDeclinable, getMessage, getMetadata, getMetadata, getOrderMatters, getRedirectUrl, getSubject, getTitle, getUxVersion, hasMessage, hasRedirectUrl, hasSubject, hasTitle, hasUsePreexistingFields, isTestMode, isUsingPreexistingFields, setClientId, setDocuments, setFileUrls, setIsDeclinable, setMessage, setOrderMatters, setRedirectUrl, setSubject, setTestMode, setTitle, setUsePreexistingFields, setUxVersion

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, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateSignatureRequest

public TemplateSignatureRequest()

TemplateSignatureRequest

public TemplateSignatureRequest(Template template)
                         throws HelloSignException

Convenience constructor that accepts a single Template.

Parameters:

template - Template

Throws:

HelloSignException - thrown if there is a problem adding the template ID.

TemplateSignatureRequest

public TemplateSignatureRequest(List<Template> templates)
                         throws HelloSignException

Convenience constructor that accepts a list of Templates.

Parameters:

templates - List

Throws:

HelloSignException - thrown if there is a problem adding the template ID.

Method Detail

getCCs

public Map<String,String> getCCs()

Returns a reference to the map of current roles to CC email addresses.

Returns:

Map

setCCs

public void setCCs(Map<String,String> newCCs)

Overwrites the map of roles to CC email addresses.

Parameters:

newCCs - Map

setCC

public void setCC(String role,
                  String email)

Sets the CC email address for the provided role.

Parameters:

role - String

email - String

clearCCs

public void clearCCs()

Clears the list of current CC email addresses.

setSigner

public void setSigner(String role,
                      String email,
                      String name)
               throws HelloSignException

Adds the signer to the list of signers for this request.

Parameters:

role - String

email - String

name - String

Throws:

HelloSignException - thrown if there is a problem setting the signer.

getSigners

public Map<String,Signer> getSigners()

Returns a reference to the signers list. This can be modified and re-added to the request using setSigners(). Useful for more explicit modification.

Returns:

List

setSigners

public void setSigners(Map<String,Signer> signers)

Overwrites the current list of signers for this request with the given list.

Parameters:

signers - List

removeSignerByEmail

public void removeSignerByEmail(String email)
                         throws HelloSignException

Removes signer(s) from this request by email address. If more than one signer is listed by the given email, it will remove all instances of that signer. If no user is listed by the given email, nothing will happen.

Parameters:

email - String

Throws:

HelloSignException - if there is a problem removing the signer by email.

addCustomField

public void addCustomField(CustomField field)

Add the custom field to this request. This is useful for specifying a pre-filled value and/or a field editor.

Parameters:

field - CustomField

setCustomFieldValue

public void setCustomFieldValue(String fieldNameOrApiId,
                                String value)

Adds the value to fill in for a custom field with the given field name.

Parameters:

fieldNameOrApiId - String name (or "Field Label") of the custom field to be filled in. The "api_id" can also be used instead of the name.

value - String value

getCustomFields

public Map<String,String> getCustomFields()

Returns the map of custom fields for the template. This is a map of String field names to String field values.

Returns:

Map

getCustomFieldsList

public List<CustomField> getCustomFieldsList()

Returns a list of CustomField objects for this template.

Returns:

List of CustomFields

setCustomFields

public void setCustomFields(Map<String,String> fields)

Overwrites the current map of custom fields to the provided map. This is a map of String field names to String field values.

Parameters:

fields - Map

clearCustomFields

public void clearCustomFields()

Clears the current custom fields for this request.

setTemplateId

public void setTemplateId(String id)
                   throws HelloSignException

Set the template ID of the template that should be used with this request.

Parameters:

id - String

Throws:

HelloSignException - thrown if the template ID cannot be added.

getTemplateId

public String getTemplateId()
                     throws HelloSignException

Get the template ID that will be used with this request.

Returns:

String

Throws:

HelloSignException - thrown if there is a problem parsing the backing JSON object.

addTemplateId

public void addTemplateId(String id)
                   throws HelloSignException

Adds the template ID to be used in this request.

Parameters:

id - String

Throws:

HelloSignException - thrown if there is a problem parsing the backing JSON object.

addTemplateId

public void addTemplateId(String id,
                          Integer index)
                   throws HelloSignException

Add the template ID to be used at the specified index.

Parameters:

id - String

index - Integer

Throws:

HelloSignException - thrown if therer is a problem adding the given template ID.

getTemplateIds

public List<String> getTemplateIds()

Get the list of template IDs that are used for this request.

Returns:

List

getPostFields

public Map<String,Serializable> getPostFields()
                                       throws HelloSignException

Internal method used to retrieve the necessary POST fields to submit the signature request.

Overrides:

getPostFields in class AbstractRequest

Returns:

Map

Throws:

HelloSignException - thrown if there is a problem parsing the POST fields.

getId

public String getId()

Specified by:

getId in class AbstractRequest

hasUseTextTags

public boolean hasUseTextTags()

Not implemented for templates.

Overrides:

hasUseTextTags in class AbstractRequest

isUsingTextTags

public Boolean isUsingTextTags()

Not implemented for templates.

Overrides:

isUsingTextTags in class AbstractRequest

setUseTextTags

public void setUseTextTags(boolean useTextTags)

Not implemented for templates.

Overrides:

setUseTextTags in class AbstractRequest

hasHideTextTags

public boolean hasHideTextTags()

Not implemented for templates.

Overrides:

hasHideTextTags in class AbstractRequest

isHidingTextTags

public Boolean isHidingTextTags()

Not implemented for templates.

Overrides:

isHidingTextTags in class AbstractRequest

setHideTextTags

public void setHideTextTags(boolean hideTextTags)

Not implemented for templates.

Overrides:

setHideTextTags in class AbstractRequest