com.hellosign.sdk.resource

Class Template

java.lang.Object

com.hellosign.sdk.resource.AbstractResource

com.hellosign.sdk.resource.Template

public class Template
extends AbstractResource

POJO that represents a HelloSign Template resource.

Author:

"Chris Paul ([email protected])"

Field Summary

Fields

Modifier and Type	Field and Description
static String	TEMPLATE_ACCOUNTS
static String	TEMPLATE_CAN_EDIT
static String	TEMPLATE_CC_ROLES
static String	TEMPLATE_CUSTOM_FIELDS
static String	TEMPLATE_DOCUMENTS
static String	TEMPLATE_ID
static String	TEMPLATE_IS_CREATOR
static String	TEMPLATE_IS_EMBEDDED
static String	TEMPLATE_KEY
static String	TEMPLATE_MESSAGE
static String	TEMPLATE_SIGNER_ROLES
static String	TEMPLATE_TITLE

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

dataObj, warnings

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canEdit()
List<Account>	getAccounts()
List<TemplateRole>	getCCRoles()
List<CustomField>	getCustomFields()
List<Document>	getDocuments()
String	getId()
String	getMessage()
List<TemplateRole>	getSignerRoles() Returns a list of SignerRoles.
String	getTitle()
boolean	hasId()
boolean	hasMessage()
boolean	hasTitle()
boolean	isCreator()
boolean	isEmbedded() Returns true if this template was created on a site other than hellosign.com.

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

Field Detail

TEMPLATE_KEY

public static final String TEMPLATE_KEY

See Also:

Constant Field Values

TEMPLATE_ID

public static final String TEMPLATE_ID

See Also:

Constant Field Values

TEMPLATE_TITLE

public static final String TEMPLATE_TITLE

See Also:

Constant Field Values

TEMPLATE_MESSAGE

public static final String TEMPLATE_MESSAGE

See Also:

Constant Field Values

TEMPLATE_DOCUMENTS

public static final String TEMPLATE_DOCUMENTS

See Also:

Constant Field Values

TEMPLATE_SIGNER_ROLES

public static final String TEMPLATE_SIGNER_ROLES

See Also:

Constant Field Values

TEMPLATE_CC_ROLES

public static final String TEMPLATE_CC_ROLES

See Also:

Constant Field Values

TEMPLATE_ACCOUNTS

public static final String TEMPLATE_ACCOUNTS

See Also:

Constant Field Values

TEMPLATE_CAN_EDIT

public static final String TEMPLATE_CAN_EDIT

See Also:

Constant Field Values

TEMPLATE_IS_CREATOR

public static final String TEMPLATE_IS_CREATOR

See Also:

Constant Field Values

TEMPLATE_CUSTOM_FIELDS

public static final String TEMPLATE_CUSTOM_FIELDS

See Also:

Constant Field Values

TEMPLATE_IS_EMBEDDED

public static final String TEMPLATE_IS_EMBEDDED

See Also:

Constant Field Values

Constructor Detail

Template

public Template()

Template

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

Throws:

HelloSignException

Method Detail

getId

public String getId()

hasId

public boolean hasId()

getTitle

public String getTitle()

hasTitle

public boolean hasTitle()

getMessage

public String getMessage()

hasMessage

public boolean hasMessage()

getDocuments

public List<Document> getDocuments()

getSignerRoles

public List<TemplateRole> getSignerRoles()

Returns a list of SignerRoles. If they are ordered, the list is returned in order.

Returns:

List

getCCRoles

public List<TemplateRole> getCCRoles()

getAccounts

public List<Account> getAccounts()

canEdit

public boolean canEdit()

isCreator

public boolean isCreator()

getCustomFields

public List<CustomField> getCustomFields()

isEmbedded

public boolean isEmbedded()

Returns true if this template was created on a site other than hellosign.com.

Returns:

boolean