com.hellosign.sdk.resource

Class AbstractRequest

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.AbstractRequest

Direct Known Subclasses:

EmbeddedRequest, SignatureRequest, TemplateDraft, TemplateSignatureRequest, UnclaimedDraft

public abstract class AbstractRequest
extends AbstractResource

Requests to HelloSign will have common fields such as a request title, subject, and message. This class centralizes those fields.

Author:

"Chris Paul ([email protected])"

Field Summary

Fields

Modifier and Type	Field and Description
static String	REQUEST_ALLOW_DECLINE
static String	REQUEST_ALLOW_REASSIGN
static String	REQUEST_CLIENT_ID
static String	REQUEST_CUSTOM_FIELDS
static String	REQUEST_HIDE_TEXT_TAGS
static String	REQUEST_MESSAGE
static String	REQUEST_METADATA
static String	REQUEST_REDIRECT_URL
static String	REQUEST_SUBJECT
static String	REQUEST_TEST_MODE
static String	REQUEST_TITLE
static String	REQUEST_USE_PREEXISTING_FIELDS
static String	REQUEST_USE_TEXT_TAGS
static String	REQUEST_UX_VERSION
static int	UX_VERSION_1
static int	UX_VERSION_2

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

dataObj, warnings

Constructor Summary

Constructors

Constructor and Description
AbstractRequest()
AbstractRequest(org.json.JSONObject json, String optionalKey)

Method Summary

Modifier and Type	Method and Description
void	addCustomField(CustomField field) Add the custom field to this request.
void	addDocument(Document doc) Adds a Document to the signature request.
void	addDocument(Document doc, int order) Adds a Document to the signature request at the specific order.
void	addFile(File file) Adds the file to the request.
void	addFile(File file, Integer order) Adds the file to the request in the given order.
void	addFileUrl(String url) Add a file_url to this request.
void	addMetadata(String key, String value)
void	clearCustomFields() Clears the current custom fields for this request.
void	clearDocuments() Remove all documents from this request.
String	getClientId() The API app client ID that has been associated with this signature request.
List<CustomField>	getCustomFields() Gets the custom fields associated with this request, set when sending the request.
List<CustomField>	getCustomFieldsList() Deprecated. Use getCustomFields() instead.
Map<String,String>	getCustomFieldsMap() Returns the map of custom fields for the request.
List<Document>	getDocuments() Returns a reference to the list of documents for this request.
List<String>	getFileUrls() Return the current file_url list.
abstract String	getId()
Boolean	getIsDeclinable() Retrieve the flag that designates whether this request is declinable by signers.
String	getMessage()
Metadata	getMetadata()
String	getMetadata(String key)
boolean	getOrderMatters() A flag that determines whether order of the signers list is enforced.
Map<String,Serializable>	getPostFields()
String	getRedirectUrl()
String	getSubject()
String	getTitle()
int	getUxVersion() Return the UX version for this request.
boolean	hasAllowReassign()
boolean	hasHideTextTags()
boolean	hasMessage()
boolean	hasRedirectUrl()
boolean	hasSubject()
boolean	hasTitle()
boolean	hasUsePreexistingFields()
boolean	hasUseTextTags()
boolean	isAllowReassign()
Boolean	isHidingTextTags()
boolean	isTestMode()
Boolean	isUsingPreexistingFields()
Boolean	isUsingTextTags()
void	setAllowReassign(boolean b)
void	setClientId(String clientId) Associates this request with an API app.
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	setDocuments(List<Document> docs) Overwrites this requests document list with the provided document list.
void	setFileUrls(List<String> fileUrls) Overwrite the current file_url list.
void	setHideTextTags(boolean hideTextTags)
void	setIsDeclinable(Boolean isDeclinable) Designate this request as declinable by signers.
void	setMessage(String message)
void	setOrderMatters(boolean b) Determines whether the order of the signers list is to be enforced.
void	setRedirectUrl(String url)
void	setSubject(String subject)
void	setTestMode(boolean testMode)
void	setTitle(String title)
void	setUsePreexistingFields(boolean usePreexistingFields)
void	setUseTextTags(boolean useTextTags)
void	setUxVersion(int uxVersion) Set the UX version for this request.

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

Field Detail

REQUEST_TITLE

public static final String REQUEST_TITLE

See Also:

Constant Field Values

REQUEST_SUBJECT

public static final String REQUEST_SUBJECT

See Also:

Constant Field Values

REQUEST_MESSAGE

public static final String REQUEST_MESSAGE

See Also:

Constant Field Values

REQUEST_REDIRECT_URL

public static final String REQUEST_REDIRECT_URL

See Also:

Constant Field Values

REQUEST_TEST_MODE

public static final String REQUEST_TEST_MODE

See Also:

Constant Field Values

REQUEST_USE_TEXT_TAGS

public static final String REQUEST_USE_TEXT_TAGS

See Also:

Constant Field Values

REQUEST_USE_PREEXISTING_FIELDS

public static final String REQUEST_USE_PREEXISTING_FIELDS

See Also:

Constant Field Values

REQUEST_HIDE_TEXT_TAGS

public static final String REQUEST_HIDE_TEXT_TAGS

See Also:

Constant Field Values

REQUEST_METADATA

public static final String REQUEST_METADATA

See Also:

Constant Field Values

REQUEST_UX_VERSION

public static final String REQUEST_UX_VERSION

See Also:

Constant Field Values

REQUEST_CLIENT_ID

public static final String REQUEST_CLIENT_ID

See Also:

Constant Field Values

REQUEST_ALLOW_DECLINE

public static final String REQUEST_ALLOW_DECLINE

See Also:

Constant Field Values

REQUEST_ALLOW_REASSIGN

public static final String REQUEST_ALLOW_REASSIGN

See Also:

Constant Field Values

REQUEST_CUSTOM_FIELDS

public static final String REQUEST_CUSTOM_FIELDS

See Also:

Constant Field Values

UX_VERSION_1

public static final int UX_VERSION_1

See Also:

Constant Field Values

UX_VERSION_2

public static final int UX_VERSION_2

See Also:

Constant Field Values

Constructor Detail

AbstractRequest

public AbstractRequest()

AbstractRequest

public AbstractRequest(org.json.JSONObject json,
                       String optionalKey)
                throws HelloSignException

Throws:

HelloSignException

Method Detail

getPostFields

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

Throws:

HelloSignException

getId

public abstract String getId()

getTitle

public String getTitle()

setTitle

public void setTitle(String title)

hasTitle

public boolean hasTitle()

getSubject

public String getSubject()

setSubject

public void setSubject(String subject)

hasSubject

public boolean hasSubject()

getMessage

public String getMessage()

setMessage

public void setMessage(String message)

hasMessage

public boolean hasMessage()

setTestMode

public void setTestMode(boolean testMode)

isTestMode

public boolean isTestMode()

getRedirectUrl

public String getRedirectUrl()

setRedirectUrl

public void setRedirectUrl(String url)

hasRedirectUrl

public boolean hasRedirectUrl()

hasUseTextTags

public boolean hasUseTextTags()

isUsingTextTags

public Boolean isUsingTextTags()

setUseTextTags

public void setUseTextTags(boolean useTextTags)

hasHideTextTags

public boolean hasHideTextTags()

isHidingTextTags

public Boolean isHidingTextTags()

setHideTextTags

public void setHideTextTags(boolean hideTextTags)

hasUsePreexistingFields

public boolean hasUsePreexistingFields()

isUsingPreexistingFields

public Boolean isUsingPreexistingFields()

setUsePreexistingFields

public void setUsePreexistingFields(boolean usePreexistingFields)

getMetadata

public Metadata getMetadata()

addMetadata

public void addMetadata(String key,
                        String value)

getMetadata

public String getMetadata(String key)

addFile

public void addFile(File file)
             throws HelloSignException

Adds the file to the request.

Parameters:

file - File

Throws:

HelloSignException - thrown if there is a problem attaching the File to this request.

addFile

public void addFile(File file,
                    Integer order)
             throws HelloSignException

Adds the file to the request in the given order. The order should be a 0-based index into the file list. Therefore, the first item of the file list is 0, and so forth. If order is null, the document is appended to the end of the file list.

Parameters:

file - File

order - Integer or null

Throws:

HelloSignException - thrown if there is a problem attaching the File to this request.

addDocument

public void addDocument(Document doc)
                 throws HelloSignException

Adds a Document to the signature request.

Parameters:

doc - Document

Throws:

HelloSignException - thrown if null is provided

addDocument

public void addDocument(Document doc,
                        int order)
                 throws HelloSignException

Adds a Document to the signature request at the specific order.

Parameters:

doc - Document

order - int

Throws:

HelloSignException - thrown if null is provided or there is a problem attaching the Document.

getDocuments

public List<Document> getDocuments()

Returns a reference to the list of documents for this request. Modifying this list will modify the list that will be sent with the request. Useful for more fine-grained modification.

Returns:

List

setDocuments

public void setDocuments(List<Document> docs)

Overwrites this requests document list with the provided document list.

Parameters:

docs - List

clearDocuments

public void clearDocuments()

Remove all documents from this request.

setOrderMatters

public void setOrderMatters(boolean b)

Determines whether the order of the signers list is to be enforced.

Parameters:

b - true if the order matters, false otherwise

getOrderMatters

public boolean getOrderMatters()

A flag that determines whether order of the signers list is enforced.

Returns:

true if the order matters, false otherwise

addFileUrl

public void addFileUrl(String url)

Add a file_url to this request.

Parameters:

url - String

getFileUrls

public List<String> getFileUrls()

Return the current file_url list.

Returns:

List

setFileUrls

public void setFileUrls(List<String> fileUrls)

Overwrite the current file_url list.

Parameters:

fileUrls - List

setUxVersion

public void setUxVersion(int uxVersion)

Set the UX version for this request. This determines the version of the signer page displayed to signer(s). The default is UX_VERSION_1 (non-responsive). Use UX_VERSION_2 for the responsive signer page.

Parameters:

uxVersion - int

getUxVersion

public int getUxVersion()

Return the UX version for this request.

Returns:

int UX version (UX_VERSION_1 or UX_VERSION_2)

setClientId

public void setClientId(String clientId)
                 throws HelloSignException

Associates this request with an API app.

Parameters:

clientId - String client ID of the API app.

Throws:

HelloSignException - thrown if clientId is null

getClientId

public String getClientId()

The API app client ID that has been associated with this signature request.

Returns:

String client ID

setIsDeclinable

public void setIsDeclinable(Boolean isDeclinable)

Designate this request as declinable by signers.

Parameters:

isDeclinable - true if declinable, false otherwise (null if the parameter should be left off)

getIsDeclinable

public Boolean getIsDeclinable()

Retrieve the flag that designates whether this request is declinable by signers.

Returns:

Boolean or null if the flag has not been set

hasAllowReassign

public boolean hasAllowReassign()

isAllowReassign

public boolean isAllowReassign()

setAllowReassign

public void setAllowReassign(boolean b)

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

getCustomFieldsMap

public Map<String,String> getCustomFieldsMap()

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

Returns:

Map

getCustomFields

public List<CustomField> getCustomFields()

Gets the custom fields associated with this request, set when sending the request.

Returns:

List CustomFields

getCustomFieldsList

public List<CustomField> getCustomFieldsList()

Deprecated. Use getCustomFields() instead.

Returns a list of CustomField objects for this request.

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.