com.hellosign.sdk.resource

Class UnclaimedDraft

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.AbstractRequest

com.hellosign.sdk.resource.UnclaimedDraft

public class UnclaimedDraft
extends AbstractRequest

Represents an unclaimed draft response and request. The UnclaimedDraft object essentially "wraps" a SignatureRequest. There are two types of unclaimed drafts that can be created:

1. "send_document" - simply creates a claimable file. Use the addFile(File) and addFile(File, int) methods to add files to be claimed.
2. "request_signature" - creates a claimable signature request. If this type is chosen, the signers name(s) and email address(es) are not optional.

Author:

"Chris Paul (chris@hellosign.com)"

Field Summary

Fields

Modifier and Type	Field and Description
static String	UNCLAIMED_DRAFT_CLAIM_URL
static String	UNCLAIMED_DRAFT_EXPIRES_AT
static String	UNCLAIMED_DRAFT_IS_FOR_EMBEDDED_SIGNING
static String	UNCLAIMED_DRAFT_KEY
static String	UNCLAIMED_DRAFT_REQUESTER_EMAIL
static String	UNCLAIMED_DRAFT_SIGNATURE_REQUEST_ID
static String	UNCLAIMED_DRAFT_TEST_MODE
static String	UNCLAIMED_DRAFT_TYPE

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

REQUEST_ALLOW_DECLINE, REQUEST_ALLOW_REASSIGN, REQUEST_CLIENT_ID, REQUEST_CUSTOM_FIELDS, 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
UnclaimedDraft() Default constructor.
UnclaimedDraft(AbstractRequest request) Creates an unclaimed draft with the provided AbstractRequest, and defaults the type to UnclaimedDraftType.send_document.
UnclaimedDraft(AbstractRequest request, UnclaimedDraftType type) Creates an unclaimed draft with the provided AbstractRequest and UnclaimedDraftType.
UnclaimedDraft(org.json.JSONObject json) Constructor to provide a way to store the API response JSON information.

Method Summary

Modifier and Type	Method and Description
void	addCustomField(CustomField field) Add the custom field to this request.
void	addFile(File file) Adds a file to the unclaimed draft.
void	addFile(File file, int order) Adds a file to the unclaimed draft at the given document order.
void	clearCustomFields() Clears the current custom fields for this request.
void	clearFiles() Removes all files from this request.
String	getClaimUrl() Gets the claim URL if the draft has been created.
List<CustomField>	getCustomFields() Gets the custom fields associated with this request, set when sending the request.
Map<String,String>	getCustomFieldsMap() Returns the map of custom fields for the request.
Date	getExpiresAt()
String	getId()
String	getMessage()
Map<String,Serializable>	getPostFields()
String	getRedirectUrl()
AbstractRequest	getRequest() Gets the associated request object.
String	getRequesterEmail()
String	getSignatureRequestId()
String	getSubject()
String	getTitle()
UnclaimedDraftType	getType() Gets the unclaimed draft type.
String	getTypeString() Gets the string value of the unclaimed draft type.
boolean	hasClaimUrl() Returns true if the draft has been created and a claim URL exists.
boolean	hasMessage()
boolean	hasRedirectUrl()
boolean	hasRequesterEmail()
boolean	hasSignatureRequestId()
boolean	hasSubject()
boolean	hasTitle()
boolean	isForEmbeddedSigning() Returns true if this Unclaimed Draft is to be embedded.
boolean	isTestMode()
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	setIsForEmbeddedSigning(boolean b) Sets whether this Unclaimed Draft is to be embedded.
void	setMessage(String message)
void	setRedirectUrl(String url)
void	setRequest(AbstractRequest request) Sets the associated request object from which this unclaimed draft will be created.
void	setRequesterEmail(String email)
void	setSubject(String subject)
void	setTestMode(boolean testMode)
void	setTitle(String title)
void	setType(UnclaimedDraftType type) Sets the unclaimed draft type.

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

addDocument, addDocument, addFile, addFileUrl, addMetadata, clearDocuments, getClientId, getCustomFieldsList, getDocuments, getFileUrls, getIsDeclinable, getMetadata, getMetadata, getOrderMatters, getUxVersion, hasAllowReassign, hasHideTextTags, hasUsePreexistingFields, hasUseTextTags, isAllowReassign, isHidingTextTags, isUsingPreexistingFields, isUsingTextTags, setAllowReassign, setClientId, setDocuments, setFileUrls, setHideTextTags, setIsDeclinable, setOrderMatters, setUsePreexistingFields, setUseTextTags, 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

Field Detail

UNCLAIMED_DRAFT_KEY

public static final String UNCLAIMED_DRAFT_KEY

See Also:

Constant Field Values

UNCLAIMED_DRAFT_CLAIM_URL

public static final String UNCLAIMED_DRAFT_CLAIM_URL

See Also:

Constant Field Values

UNCLAIMED_DRAFT_TYPE

public static final String UNCLAIMED_DRAFT_TYPE

See Also:

Constant Field Values

UNCLAIMED_DRAFT_REQUESTER_EMAIL

public static final String UNCLAIMED_DRAFT_REQUESTER_EMAIL

See Also:

Constant Field Values

UNCLAIMED_DRAFT_IS_FOR_EMBEDDED_SIGNING

public static final String UNCLAIMED_DRAFT_IS_FOR_EMBEDDED_SIGNING

See Also:

Constant Field Values

UNCLAIMED_DRAFT_SIGNATURE_REQUEST_ID

public static final String UNCLAIMED_DRAFT_SIGNATURE_REQUEST_ID

See Also:

Constant Field Values

UNCLAIMED_DRAFT_EXPIRES_AT

public static final String UNCLAIMED_DRAFT_EXPIRES_AT

See Also:

Constant Field Values

UNCLAIMED_DRAFT_TEST_MODE

public static final String UNCLAIMED_DRAFT_TEST_MODE

See Also:

Constant Field Values

Constructor Detail

UnclaimedDraft

public UnclaimedDraft()

Default constructor. This will instantiate the unclaimed draft with a SignatureRequest and the UnclaimedDraftType.send_document.

UnclaimedDraft

public UnclaimedDraft(AbstractRequest request)

Creates an unclaimed draft with the provided AbstractRequest, and defaults the type to UnclaimedDraftType.send_document.

Parameters:

request - AbstractRequest

UnclaimedDraft

public UnclaimedDraft(AbstractRequest request,
                      UnclaimedDraftType type)

Creates an unclaimed draft with the provided AbstractRequest and UnclaimedDraftType.

Parameters:

request - AbstractRequest

type - UnclaimedDraftType

UnclaimedDraft

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

Constructor to provide a way to store the API response JSON information.

Parameters:

json - JSONObject API response object

Throws:

HelloSignException - thrown if there is a problem parsing the JSONObject.

Method Detail

setType

public void setType(UnclaimedDraftType type)

Sets the unclaimed draft type. Use the public enum: UnclaimedDraft.UNCLAIMED_DRAFT_TYPE.

Parameters:

type - UnclaimedDraft.UNCLAIMED_DRAFT_TYPE

getTypeString

public String getTypeString()

Gets the string value of the unclaimed draft type.

Returns:

String

getType

public UnclaimedDraftType getType()

Gets the unclaimed draft type.

Returns:

UnclaimedDraft.UNCLAIMED_DRAFT_TYPE

setRequest

public void setRequest(AbstractRequest request)

Sets the associated request object from which this unclaimed draft will be created.

Parameters:

request - AbstractRequest

getRequest

public AbstractRequest getRequest()

Gets the associated request object. Currently this will always be a SignatureRequest.

Returns:

AbstractRequest

getClaimUrl

public String getClaimUrl()

Gets the claim URL if the draft has been created.

Returns:

String claim URL

hasClaimUrl

public boolean hasClaimUrl()

Returns true if the draft has been created and a claim URL exists.

Returns:

true or false, if not set

addFile

public void addFile(File file)
             throws HelloSignException

Adds a file to the unclaimed draft.

Overrides:

addFile in class AbstractRequest

Parameters:

file - File

Throws:

HelloSignException - thrown if there is a problem adding the File.

addFile

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

Adds a file to the unclaimed draft at the given document order.

Parameters:

file - File

order - int

Throws:

HelloSignException - thrown if there is a problem adding the File.

clearFiles

public void clearFiles()
                throws HelloSignException

Removes all files from this request.

Throws:

HelloSignException - thrown if there is a problem clearing the Files

isForEmbeddedSigning

public boolean isForEmbeddedSigning()

Returns true if this Unclaimed Draft is to be embedded.

Returns:

true if this Unclaimed Draft is to be embedded, false otherwise

setIsForEmbeddedSigning

public void setIsForEmbeddedSigning(boolean b)

Sets whether this Unclaimed Draft is to be embedded.

Parameters:

b - boolean

hasSignatureRequestId

public boolean hasSignatureRequestId()

getSignatureRequestId

public String getSignatureRequestId()

getPostFields

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

Overrides:

getPostFields in class AbstractRequest

Throws:

HelloSignException

getRequesterEmail

public String getRequesterEmail()

hasRequesterEmail

public boolean hasRequesterEmail()

setRequesterEmail

public void setRequesterEmail(String email)

getTitle

public String getTitle()

Overrides:

getTitle in class AbstractRequest

setTitle

public void setTitle(String title)

Overrides:

setTitle in class AbstractRequest

hasTitle

public boolean hasTitle()

Overrides:

hasTitle in class AbstractRequest

getSubject

public String getSubject()

Overrides:

getSubject in class AbstractRequest

setSubject

public void setSubject(String subject)

Overrides:

setSubject in class AbstractRequest

hasSubject

public boolean hasSubject()

Overrides:

hasSubject in class AbstractRequest

getMessage

public String getMessage()

Overrides:

getMessage in class AbstractRequest

setMessage

public void setMessage(String message)

Overrides:

setMessage in class AbstractRequest

hasMessage

public boolean hasMessage()

Overrides:

hasMessage in class AbstractRequest

setTestMode

public void setTestMode(boolean testMode)

Overrides:

setTestMode in class AbstractRequest

isTestMode

public boolean isTestMode()

Overrides:

isTestMode in class AbstractRequest

getRedirectUrl

public String getRedirectUrl()

Overrides:

getRedirectUrl in class AbstractRequest

setRedirectUrl

public void setRedirectUrl(String url)

Overrides:

setRedirectUrl in class AbstractRequest

hasRedirectUrl

public boolean hasRedirectUrl()

Overrides:

hasRedirectUrl in class AbstractRequest

getId

public String getId()

Specified by:

getId in class AbstractRequest

addCustomField

public void addCustomField(CustomField field)

Description copied from class: AbstractRequest

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

Overrides:

addCustomField in class AbstractRequest

Parameters:

field - CustomField

setCustomFieldValue

public void setCustomFieldValue(String fieldNameOrApiId,
                                String value)

Description copied from class: AbstractRequest

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

Overrides:

setCustomFieldValue in class AbstractRequest

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 List<CustomField> getCustomFields()

Description copied from class: AbstractRequest

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

Overrides:

getCustomFields in class AbstractRequest

Returns:

List CustomFields

getCustomFieldsMap

public Map<String,String> getCustomFieldsMap()

Description copied from class: AbstractRequest

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

Overrides:

getCustomFieldsMap in class AbstractRequest

Returns:

Map

setCustomFields

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

Description copied from class: AbstractRequest

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

Overrides:

setCustomFields in class AbstractRequest

Parameters:

fields - Map

clearCustomFields

public void clearCustomFields()

Description copied from class: AbstractRequest

Clears the current custom fields for this request.

Overrides:

clearCustomFields in class AbstractRequest

getExpiresAt

public Date getExpiresAt()