Package com.docusign.esign.model

Class EnvelopeFormData

java.lang.Object

com.docusign.esign.model.EnvelopeFormData

All Implemented Interfaces:

Serializable

public class EnvelopeFormData
extends Object
implements Serializable

Describes the form data of the envelope..

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
EnvelopeFormData()

Method Summary

Modifier and Type	Method	Description
EnvelopeFormData	addFormDataItem(FormDataItem formDataItem)	addFormDataItem.
EnvelopeFormData	addRecipientFormDataItem(RecipientFormData recipientFormDataItem)	addRecipientFormDataItem.
EnvelopeFormData	emailSubject(String emailSubject)	emailSubject.
EnvelopeFormData	envelopeId(String envelopeId)	envelopeId.
boolean	equals(Object o)	Compares objects.
EnvelopeFormData	formData(List<FormDataItem> formData)	formData.
String	getEmailSubject()	Specifies the subject of the email that is sent to all recipients.
String	getEnvelopeId()	The envelope ID of the envelope status that failed to post..
List<FormDataItem>	getFormData()	.
PrefillFormData	getPrefillFormData()	An array of `formDataItem` objects for [prefill tabs](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs).
List<RecipientFormData>	getRecipientFormData()	.
String	getSentDateTime()	The date and time the envelope was sent..
String	getStatus()	Indicates the envelope status.
int	hashCode()	Returns the HashCode.
EnvelopeFormData	prefillFormData(PrefillFormData prefillFormData)	prefillFormData.
EnvelopeFormData	recipientFormData(List<RecipientFormData> recipientFormData)	recipientFormData.
EnvelopeFormData	sentDateTime(String sentDateTime)	sentDateTime.
void	setEmailSubject(String emailSubject)	setEmailSubject.
void	setEnvelopeId(String envelopeId)	setEnvelopeId.
void	setFormData(List<FormDataItem> formData)	setFormData.
void	setPrefillFormData(PrefillFormData prefillFormData)	setPrefillFormData.
void	setRecipientFormData(List<RecipientFormData> recipientFormData)	setRecipientFormData.
void	setSentDateTime(String sentDateTime)	setSentDateTime.
void	setStatus(String status)	setStatus.
EnvelopeFormData	status(String status)	status.
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

EnvelopeFormData

public EnvelopeFormData()

Method Detail

emailSubject

public EnvelopeFormData emailSubject(String emailSubject)

emailSubject.

Returns:

EnvelopeFormData

getEmailSubject

public String getEmailSubject()

Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject..

Returns:

emailSubject

setEmailSubject

public void setEmailSubject(String emailSubject)

setEmailSubject.

envelopeId

public EnvelopeFormData envelopeId(String envelopeId)

envelopeId.

Returns:

EnvelopeFormData

getEnvelopeId

public String getEnvelopeId()

The envelope ID of the envelope status that failed to post..

Returns:

envelopeId

setEnvelopeId

public void setEnvelopeId(String envelopeId)

setEnvelopeId.

formData

public EnvelopeFormData formData(List<FormDataItem> formData)

formData.

Returns:

EnvelopeFormData

addFormDataItem

public EnvelopeFormData addFormDataItem(FormDataItem formDataItem)

addFormDataItem.

Returns:

EnvelopeFormData

getFormData

public List<FormDataItem> getFormData()

.

Returns:

formData

setFormData

public void setFormData(List<FormDataItem> formData)

setFormData.

prefillFormData

public EnvelopeFormData prefillFormData(PrefillFormData prefillFormData)

prefillFormData.

Returns:

EnvelopeFormData

getPrefillFormData

public PrefillFormData getPrefillFormData()

An array of `formDataItem` objects for [prefill tabs](/docs/esign-rest-api/reference/envelopes/envelopedocumenttabs/create/#definition__tabs_prefilltabs). .

Returns:

prefillFormData

setPrefillFormData

public void setPrefillFormData(PrefillFormData prefillFormData)

setPrefillFormData.

recipientFormData

public EnvelopeFormData recipientFormData(List<RecipientFormData> recipientFormData)

recipientFormData.

Returns:

EnvelopeFormData

addRecipientFormDataItem

public EnvelopeFormData addRecipientFormDataItem(RecipientFormData recipientFormDataItem)

addRecipientFormDataItem.

Returns:

EnvelopeFormData

getRecipientFormData

public List<RecipientFormData> getRecipientFormData()

.

Returns:

recipientFormData

setRecipientFormData

public void setRecipientFormData(List<RecipientFormData> recipientFormData)

setRecipientFormData.

sentDateTime

public EnvelopeFormData sentDateTime(String sentDateTime)

sentDateTime.

Returns:

EnvelopeFormData

getSentDateTime

public String getSentDateTime()

The date and time the envelope was sent..

Returns:

sentDateTime

setSentDateTime

public void setSentDateTime(String sentDateTime)

setSentDateTime.

status

public EnvelopeFormData status(String status)

status.

Returns:

EnvelopeFormData

getStatus

public String getStatus()

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..

Returns:

status

setStatus

public void setStatus(String status)

setStatus.

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