com.docusign.esign.model

Class EnvelopeFormData

java.lang.Object

com.docusign.esign.model.EnvelopeFormData

public class EnvelopeFormData
extends Object

EnvelopeFormData

Constructor Summary

Constructors

Constructor and Description
EnvelopeFormData()

Method Summary

Methods

Modifier and Type	Method and Description
EnvelopeFormData	addFormDataItem(NameValue formDataItem)
EnvelopeFormData	addRecipientFormDataItem(RecipientFormData recipientFormDataItem)
EnvelopeFormData	emailSubject(String emailSubject)
EnvelopeFormData	envelopeId(String envelopeId)
boolean	equals(Object o)
EnvelopeFormData	formData(List<NameValue> 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<NameValue>	getFormData()
List<RecipientFormData>	getRecipientFormData()
String	getSentDateTime() The date and time the envelope was sent.
String	getStatus() Indicates the envelope status.
int	hashCode()
EnvelopeFormData	recipientFormData(List<RecipientFormData> recipientFormData)
EnvelopeFormData	sentDateTime(String sentDateTime)
void	setEmailSubject(String emailSubject)
void	setEnvelopeId(String envelopeId)
void	setFormData(List<NameValue> formData)
void	setRecipientFormData(List<RecipientFormData> recipientFormData)
void	setSentDateTime(String sentDateTime)
void	setStatus(String status)
EnvelopeFormData	status(String status)
String	toString()

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)

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)

envelopeId

public EnvelopeFormData envelopeId(String envelopeId)

getEnvelopeId

public String getEnvelopeId()

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

Returns:

envelopeId

setEnvelopeId

public void setEnvelopeId(String envelopeId)

formData

public EnvelopeFormData formData(List<NameValue> formData)

addFormDataItem

public EnvelopeFormData addFormDataItem(NameValue formDataItem)

getFormData

public List<NameValue> getFormData()

Returns:

formData

setFormData

public void setFormData(List<NameValue> formData)

recipientFormData

public EnvelopeFormData recipientFormData(List<RecipientFormData> recipientFormData)

addRecipientFormDataItem

public EnvelopeFormData addRecipientFormDataItem(RecipientFormData recipientFormDataItem)

getRecipientFormData

public List<RecipientFormData> getRecipientFormData()

Returns:

recipientFormData

setRecipientFormData

public void setRecipientFormData(List<RecipientFormData> recipientFormData)

sentDateTime

public EnvelopeFormData sentDateTime(String sentDateTime)

getSentDateTime

public String getSentDateTime()

The date and time the envelope was sent.

Returns:

sentDateTime

setSentDateTime

public void setSentDateTime(String sentDateTime)

status

public EnvelopeFormData status(String status)

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)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object