Package com.docusign.esign.model
Class EnvelopeSummary
- java.lang.Object
-
- com.docusign.esign.model.EnvelopeSummary
-
- All Implemented Interfaces:
Serializable
public class EnvelopeSummary extends Object implements Serializable
This object describes an envelope..- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description EnvelopeSummary()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description EnvelopeSummarybulkEnvelopeStatus(BulkEnvelopeStatus bulkEnvelopeStatus)bulkEnvelopeStatus.EnvelopeSummaryenvelopeId(String envelopeId)envelopeId.booleanequals(Object o)Compares objects.EnvelopeSummaryerrorDetails(ErrorDetails errorDetails)errorDetails.BulkEnvelopeStatusgetBulkEnvelopeStatus()An object that describes the status of the bulk send envelopes..StringgetEnvelopeId()The envelope ID of the envelope status that failed to post..ErrorDetailsgetErrorDetails()Array or errors..StringgetRecipientSigningUri().StringgetRecipientSigningUriError().StringgetStatus()Indicates the envelope status.StringgetStatusDateTime()The DateTime that the envelope changed status (i.e.StringgetUri().inthashCode()Returns the HashCode.EnvelopeSummaryrecipientSigningUri(String recipientSigningUri)recipientSigningUri.EnvelopeSummaryrecipientSigningUriError(String recipientSigningUriError)recipientSigningUriError.voidsetBulkEnvelopeStatus(BulkEnvelopeStatus bulkEnvelopeStatus)setBulkEnvelopeStatus.voidsetEnvelopeId(String envelopeId)setEnvelopeId.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetRecipientSigningUri(String recipientSigningUri)setRecipientSigningUri.voidsetRecipientSigningUriError(String recipientSigningUriError)setRecipientSigningUriError.voidsetStatus(String status)setStatus.voidsetStatusDateTime(String statusDateTime)setStatusDateTime.voidsetUri(String uri)setUri.EnvelopeSummarystatus(String status)status.EnvelopeSummarystatusDateTime(String statusDateTime)statusDateTime.StringtoString()Converts the given object to string.EnvelopeSummaryuri(String uri)uri.
-
-
-
Method Detail
-
bulkEnvelopeStatus
public EnvelopeSummary bulkEnvelopeStatus(BulkEnvelopeStatus bulkEnvelopeStatus)
bulkEnvelopeStatus.- Returns:
- EnvelopeSummary
-
getBulkEnvelopeStatus
public BulkEnvelopeStatus getBulkEnvelopeStatus()
An object that describes the status of the bulk send envelopes..- Returns:
- bulkEnvelopeStatus
-
setBulkEnvelopeStatus
public void setBulkEnvelopeStatus(BulkEnvelopeStatus bulkEnvelopeStatus)
setBulkEnvelopeStatus.
-
envelopeId
public EnvelopeSummary envelopeId(String envelopeId)
envelopeId.- Returns:
- EnvelopeSummary
-
getEnvelopeId
public String getEnvelopeId()
The envelope ID of the envelope status that failed to post..- Returns:
- envelopeId
-
setEnvelopeId
public void setEnvelopeId(String envelopeId)
setEnvelopeId.
-
errorDetails
public EnvelopeSummary errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- EnvelopeSummary
-
getErrorDetails
public ErrorDetails getErrorDetails()
Array or errors..- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
recipientSigningUri
public EnvelopeSummary recipientSigningUri(String recipientSigningUri)
recipientSigningUri.- Returns:
- EnvelopeSummary
-
getRecipientSigningUri
public String getRecipientSigningUri()
.- Returns:
- recipientSigningUri
-
setRecipientSigningUri
public void setRecipientSigningUri(String recipientSigningUri)
setRecipientSigningUri.
-
recipientSigningUriError
public EnvelopeSummary recipientSigningUriError(String recipientSigningUriError)
recipientSigningUriError.- Returns:
- EnvelopeSummary
-
getRecipientSigningUriError
public String getRecipientSigningUriError()
.- Returns:
- recipientSigningUriError
-
setRecipientSigningUriError
public void setRecipientSigningUriError(String recipientSigningUriError)
setRecipientSigningUriError.
-
status
public EnvelopeSummary status(String status)
status.- Returns:
- EnvelopeSummary
-
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.
-
statusDateTime
public EnvelopeSummary statusDateTime(String statusDateTime)
statusDateTime.- Returns:
- EnvelopeSummary
-
getStatusDateTime
public String getStatusDateTime()
The DateTime that the envelope changed status (i.e. was created or sent.).- Returns:
- statusDateTime
-
setStatusDateTime
public void setStatusDateTime(String statusDateTime)
setStatusDateTime.
-
uri
public EnvelopeSummary uri(String uri)
uri.- Returns:
- EnvelopeSummary
-
getUri
public String getUri()
.- Returns:
- uri
-
setUri
public void setUri(String uri)
setUri.
-
equals
public boolean equals(Object o)
Compares objects.
-
-