com.hellosign.sdk.resource.support

Class Signature

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.support.Signature

public class Signature
extends AbstractResource

Contains information related to a signature / signer.

Author:

"Chris Paul ([email protected])"

Field Summary

Fields

Modifier and Type	Field and Description
static String	SIGNATURE_ID
static String	SIGNATURE_KEY
static String	SIGNER_DECLINE_REASON
static String	SIGNER_EMAIL_ADDRESS
static String	SIGNER_LAST_REMINDED_AT
static String	SIGNER_LAST_VIEWED_AT
static String	SIGNER_NAME
static String	SIGNER_ORDER
static String	SIGNER_SIGNED_AT
static String	SIGNER_STATUS_CODE

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

dataObj, warnings

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
Date	getDateSigned() Returns the date the signer signed the request.
String	getDeclineReason() Returns the reason the signer declined this request.
String	getEmail() Returns the email address of the signer.
String	getId() Returns the ID of the signer.
Date	getLastReminded() Returns the date at which the last reminder was sent to this signer.
Date	getLastViewed() Returns the date the signer last viewed the request.
String	getName() Returns the name of the signer.
Integer	getOrder() Returns the order of this signer.
SignatureStatus	getStatus() Returns the status of this signature/signer.
String	getStatusString() Returns the status in string format.
boolean	hasEmail() Returns true if this signature object has an email address.
boolean	hasId() Returns true if this signature object has a signature ID.
boolean	hasName() Returns true if this signature object has a 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, toString

Methods inherited from class java.lang.Object

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

Field Detail

SIGNATURE_KEY

public static final String SIGNATURE_KEY

See Also:

Constant Field Values

SIGNATURE_ID

public static final String SIGNATURE_ID

See Also:

Constant Field Values

SIGNER_EMAIL_ADDRESS

public static final String SIGNER_EMAIL_ADDRESS

See Also:

Constant Field Values

SIGNER_NAME

public static final String SIGNER_NAME

See Also:

Constant Field Values

SIGNER_ORDER

public static final String SIGNER_ORDER

See Also:

Constant Field Values

SIGNER_STATUS_CODE

public static final String SIGNER_STATUS_CODE

See Also:

Constant Field Values

SIGNER_SIGNED_AT

public static final String SIGNER_SIGNED_AT

See Also:

Constant Field Values

SIGNER_LAST_VIEWED_AT

public static final String SIGNER_LAST_VIEWED_AT

See Also:

Constant Field Values

SIGNER_LAST_REMINDED_AT

public static final String SIGNER_LAST_REMINDED_AT

See Also:

Constant Field Values

SIGNER_DECLINE_REASON

public static final String SIGNER_DECLINE_REASON

See Also:

Constant Field Values

Constructor Detail

Signature

public Signature()

Signature

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

Throws:

HelloSignException

Method Detail

getId

public String getId()

Returns the ID of the signer.

Returns:

String ID

hasId

public boolean hasId()

Returns true if this signature object has a signature ID.

Returns:

boolean

getEmail

public String getEmail()

Returns the email address of the signer.

Returns:

String email address

hasEmail

public boolean hasEmail()

Returns true if this signature object has an email address.

Returns:

boolean

getName

public String getName()

Returns the name of the signer.

Returns:

String signer name

hasName

public boolean hasName()

Returns true if this signature object has a name

Returns:

boolean

getOrder

public Integer getOrder()

Returns the order of this signer.

Returns:

Integer signer order

getStatus

public SignatureStatus getStatus()

Returns the status of this signature/signer.

Returns:

SignatureStatus status

getStatusString

public String getStatusString()

Returns the status in string format.

Returns:

String status

getDateSigned

public Date getDateSigned()

Returns the date the signer signed the request.

Returns:

Date date the signer signed

getLastViewed

public Date getLastViewed()

Returns the date the signer last viewed the request.

Returns:

Date date the signer last viewed

getLastReminded

public Date getLastReminded()

Returns the date at which the last reminder was sent to this signer.

Returns:

Date date the last reminder was sent

getDeclineReason

public String getDeclineReason()

Returns the reason the signer declined this request.

Returns:

string or null if the request does not have a decline_reason