Package com.docusign.webforms.model

Class WebFormInstance

java.lang.Object

com.docusign.webforms.model.WebFormInstance

public class WebFormInstance
extends Object

An object that contains the Web Form Instance required to render it and its metadata such as created by, created time.

Constructor Summary

Constructors

Constructor	Description
WebFormInstance()

Method Summary

Modifier and Type	Method	Description
WebFormInstance	accountId(String accountId)	accountId.
WebFormInstance	addEnvelopesItem(WebFormInstanceEnvelopes envelopesItem)	addEnvelopesItem.
WebFormInstance	addTagsItem(String tagsItem)	addTagsItem.
WebFormInstance	clientUserId(String clientUserId)	clientUserId.
WebFormInstance	envelopes(List<WebFormInstanceEnvelopes> envelopes)	envelopes.
boolean	equals(Object o)	Compares objects.
WebFormInstance	formId(String formId)	formId.
WebFormInstance	formUrl(String formUrl)	formUrl.
WebFormInstance	formValues(WebFormValues formValues)	formValues.
String	getAccountId()	Get accountId.
String	getClientUserId()	Get clientUserId.
List<WebFormInstanceEnvelopes>	getEnvelopes()	The associated envelope that is created when the instance is submitted.
String	getFormId()	Web form from which the instance is created.
String	getFormUrl()	Get formUrl.
WebFormValues	getFormValues()	Get formValues.
String	getId()	Get id.
WebFormInstanceMetadata	getInstanceMetadata()	Get instanceMetadata.
String	getInstanceToken()	Get instanceToken.
InstanceStatus	getStatus()	Get status.
List<String>	getTags()	List of tags provided by the user with each request.
String	getTokenExpirationDateTime()	Get tokenExpirationDateTime.
int	hashCode()	Returns the HashCode.
WebFormInstance	id(String id)	id.
WebFormInstance	instanceMetadata(WebFormInstanceMetadata instanceMetadata)	instanceMetadata.
WebFormInstance	instanceToken(String instanceToken)	instanceToken.
void	setAccountId(String accountId)	setAccountId.
void	setClientUserId(String clientUserId)	setClientUserId.
void	setEnvelopes(List<WebFormInstanceEnvelopes> envelopes)	setEnvelopes.
void	setFormId(String formId)	setFormId.
void	setFormUrl(String formUrl)	setFormUrl.
void	setFormValues(WebFormValues formValues)	setFormValues.
void	setId(String id)	setId.
void	setInstanceMetadata(WebFormInstanceMetadata instanceMetadata)	setInstanceMetadata.
void	setInstanceToken(String instanceToken)	setInstanceToken.
void	setStatus(InstanceStatus status)	setStatus.
void	setTags(List<String> tags)	setTags.
void	setTokenExpirationDateTime(String tokenExpirationDateTime)	setTokenExpirationDateTime.
WebFormInstance	status(InstanceStatus status)	status.
WebFormInstance	tags(List<String> tags)	tags.
WebFormInstance	tokenExpirationDateTime(String tokenExpirationDateTime)	tokenExpirationDateTime.
String	toString()	Converts the given object to string.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

WebFormInstance

public WebFormInstance()

Method Detail

formUrl

public WebFormInstance formUrl(String formUrl)

formUrl.

Returns:

WebFormInstance

getFormUrl

public String getFormUrl()

Get formUrl.

Returns:

formUrl

setFormUrl

public void setFormUrl(String formUrl)

setFormUrl.

instanceToken

public WebFormInstance instanceToken(String instanceToken)

instanceToken.

Returns:

WebFormInstance

getInstanceToken

public String getInstanceToken()

Get instanceToken.

Returns:

instanceToken

setInstanceToken

public void setInstanceToken(String instanceToken)

setInstanceToken.

tokenExpirationDateTime

public WebFormInstance tokenExpirationDateTime(String tokenExpirationDateTime)

tokenExpirationDateTime.

Returns:

WebFormInstance

getTokenExpirationDateTime

public String getTokenExpirationDateTime()

Get tokenExpirationDateTime.

Returns:

tokenExpirationDateTime

setTokenExpirationDateTime

public void setTokenExpirationDateTime(String tokenExpirationDateTime)

setTokenExpirationDateTime.

id

public WebFormInstance id(String id)

id.

Returns:

WebFormInstance

getId

public String getId()

Get id.

Returns:

id

setId

public void setId(String id)

setId.

formId

public WebFormInstance formId(String formId)

formId.

Returns:

WebFormInstance

getFormId

public String getFormId()

Web form from which the instance is created.

Returns:

formId

setFormId

public void setFormId(String formId)

setFormId.

accountId

public WebFormInstance accountId(String accountId)

accountId.

Returns:

WebFormInstance

getAccountId

public String getAccountId()

Get accountId.

Returns:

accountId

setAccountId

public void setAccountId(String accountId)

setAccountId.

clientUserId

public WebFormInstance clientUserId(String clientUserId)

clientUserId.

Returns:

WebFormInstance

getClientUserId

public String getClientUserId()

Get clientUserId.

Returns:

clientUserId

setClientUserId

public void setClientUserId(String clientUserId)

setClientUserId.

tags

public WebFormInstance tags(List<String> tags)

tags.

Returns:

WebFormInstance

addTagsItem

public WebFormInstance addTagsItem(String tagsItem)

addTagsItem.

Returns:

WebFormInstance

getTags

public List<String> getTags()

List of tags provided by the user with each request. This field is optional..

Returns:

tags

setTags

public void setTags(List<String> tags)

setTags.

status

public WebFormInstance status(InstanceStatus status)

status.

Returns:

WebFormInstance

getStatus

public InstanceStatus getStatus()

Get status.

Returns:

status

setStatus

public void setStatus(InstanceStatus status)

setStatus.

envelopes

public WebFormInstance envelopes(List<WebFormInstanceEnvelopes> envelopes)

envelopes.

Returns:

WebFormInstance

addEnvelopesItem

public WebFormInstance addEnvelopesItem(WebFormInstanceEnvelopes envelopesItem)

addEnvelopesItem.

Returns:

WebFormInstance

getEnvelopes

public List<WebFormInstanceEnvelopes> getEnvelopes()

The associated envelope that is created when the instance is submitted.

Returns:

envelopes

setEnvelopes

public void setEnvelopes(List<WebFormInstanceEnvelopes> envelopes)

setEnvelopes.

instanceMetadata

public WebFormInstance instanceMetadata(WebFormInstanceMetadata instanceMetadata)

instanceMetadata.

Returns:

WebFormInstance

getInstanceMetadata

public WebFormInstanceMetadata getInstanceMetadata()

Get instanceMetadata.

Returns:

instanceMetadata

setInstanceMetadata

public void setInstanceMetadata(WebFormInstanceMetadata instanceMetadata)

setInstanceMetadata.

formValues

public WebFormInstance formValues(WebFormValues formValues)

formValues.

Returns:

WebFormInstance

getFormValues

public WebFormValues getFormValues()

Get formValues.

Returns:

formValues

setFormValues

public void setFormValues(WebFormValues formValues)

setFormValues.

equals

public boolean equals(Object o)

Compares objects.

Overrides:

equals in class Object

Returns:

true or false depending on comparison result.

hashCode

public int hashCode()

Returns the HashCode.

Overrides:

hashCode in class Object

toString

public String toString()

Converts the given object to string.

Overrides:

toString in class Object