Package com.docusign.esign.model
Class EnvelopeFormData
- java.lang.Object
-
- com.docusign.esign.model.EnvelopeFormData
-
public class EnvelopeFormData extends java.lang.ObjectEnvelopeFormData.
-
-
Constructor Summary
Constructors Constructor Description EnvelopeFormData()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EnvelopeFormDataaddFormDataItem(FormDataItem formDataItem)addFormDataItem.EnvelopeFormDataaddRecipientFormDataItem(RecipientFormData recipientFormDataItem)addRecipientFormDataItem.EnvelopeFormDataemailSubject(java.lang.String emailSubject)emailSubject.EnvelopeFormDataenvelopeId(java.lang.String envelopeId)envelopeId.booleanequals(java.lang.Object o)Compares objects.EnvelopeFormDataformData(java.util.List<FormDataItem> formData)formData.java.lang.StringgetEmailSubject()Specifies the subject of the email that is sent to all recipients.java.lang.StringgetEnvelopeId()The envelope ID of the envelope status that failed to post..java.util.List<FormDataItem>getFormData().PrefillFormDatagetPrefillFormData()Get prefillFormData.java.util.List<RecipientFormData>getRecipientFormData().java.lang.StringgetSentDateTime()The date and time the envelope was sent..java.lang.StringgetStatus()Indicates the envelope status.inthashCode()Returns the HashCode.EnvelopeFormDataprefillFormData(PrefillFormData prefillFormData)prefillFormData.EnvelopeFormDatarecipientFormData(java.util.List<RecipientFormData> recipientFormData)recipientFormData.EnvelopeFormDatasentDateTime(java.lang.String sentDateTime)sentDateTime.voidsetEmailSubject(java.lang.String emailSubject)setEmailSubject.voidsetEnvelopeId(java.lang.String envelopeId)setEnvelopeId.voidsetFormData(java.util.List<FormDataItem> formData)setFormData.voidsetPrefillFormData(PrefillFormData prefillFormData)setPrefillFormData.voidsetRecipientFormData(java.util.List<RecipientFormData> recipientFormData)setRecipientFormData.voidsetSentDateTime(java.lang.String sentDateTime)setSentDateTime.voidsetStatus(java.lang.String status)setStatus.EnvelopeFormDatastatus(java.lang.String status)status.java.lang.StringtoString()Converts the given object to string.
-
-
-
Method Detail
-
emailSubject
public EnvelopeFormData emailSubject(java.lang.String emailSubject)
emailSubject.- Returns:
- EnvelopeFormData
-
getEmailSubject
public java.lang.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(java.lang.String emailSubject)
setEmailSubject.
-
envelopeId
public EnvelopeFormData envelopeId(java.lang.String envelopeId)
envelopeId.- Returns:
- EnvelopeFormData
-
getEnvelopeId
public java.lang.String getEnvelopeId()
The envelope ID of the envelope status that failed to post..- Returns:
- envelopeId
-
setEnvelopeId
public void setEnvelopeId(java.lang.String envelopeId)
setEnvelopeId.
-
formData
public EnvelopeFormData formData(java.util.List<FormDataItem> formData)
formData.- Returns:
- EnvelopeFormData
-
addFormDataItem
public EnvelopeFormData addFormDataItem(FormDataItem formDataItem)
addFormDataItem.- Returns:
- EnvelopeFormData
-
getFormData
public java.util.List<FormDataItem> getFormData()
.- Returns:
- formData
-
setFormData
public void setFormData(java.util.List<FormDataItem> formData)
setFormData.
-
prefillFormData
public EnvelopeFormData prefillFormData(PrefillFormData prefillFormData)
prefillFormData.- Returns:
- EnvelopeFormData
-
getPrefillFormData
public PrefillFormData getPrefillFormData()
Get prefillFormData.- Returns:
- prefillFormData
-
setPrefillFormData
public void setPrefillFormData(PrefillFormData prefillFormData)
setPrefillFormData.
-
recipientFormData
public EnvelopeFormData recipientFormData(java.util.List<RecipientFormData> recipientFormData)
recipientFormData.- Returns:
- EnvelopeFormData
-
addRecipientFormDataItem
public EnvelopeFormData addRecipientFormDataItem(RecipientFormData recipientFormDataItem)
addRecipientFormDataItem.- Returns:
- EnvelopeFormData
-
getRecipientFormData
public java.util.List<RecipientFormData> getRecipientFormData()
.- Returns:
- recipientFormData
-
setRecipientFormData
public void setRecipientFormData(java.util.List<RecipientFormData> recipientFormData)
setRecipientFormData.
-
sentDateTime
public EnvelopeFormData sentDateTime(java.lang.String sentDateTime)
sentDateTime.- Returns:
- EnvelopeFormData
-
getSentDateTime
public java.lang.String getSentDateTime()
The date and time the envelope was sent..- Returns:
- sentDateTime
-
setSentDateTime
public void setSentDateTime(java.lang.String sentDateTime)
setSentDateTime.
-
status
public EnvelopeFormData status(java.lang.String status)
status.- Returns:
- EnvelopeFormData
-
getStatus
public java.lang.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(java.lang.String status)
setStatus.
-
equals
public boolean equals(java.lang.Object o)
Compares objects.- Overrides:
equalsin classjava.lang.Object- Returns:
- true or false depending on comparison result.
-
hashCode
public int hashCode()
Returns the HashCode.- Overrides:
hashCodein classjava.lang.Object
-
toString
public java.lang.String toString()
Converts the given object to string.- Overrides:
toStringin classjava.lang.Object
-
-