com.docusign.esign.model

Class BulkEnvelope

java.lang.Object

com.docusign.esign.model.BulkEnvelope

public class BulkEnvelope
extends Object

BulkEnvelope

Constructor Summary

Constructors

Constructor and Description
BulkEnvelope()

Method Summary

Methods

Modifier and Type	Method and Description
BulkEnvelope	bulkRecipientRow(String bulkRecipientRow)
BulkEnvelope	bulkStatus(String bulkStatus)
BulkEnvelope	email(String email)
BulkEnvelope	envelopeId(String envelopeId)
BulkEnvelope	envelopeUri(String envelopeUri)
boolean	equals(Object o)
BulkEnvelope	errorDetails(ErrorDetails errorDetails)
String	getBulkRecipientRow() Reserved: TBD
String	getBulkStatus() Indicates the status of the bulk send operation.
String	getEmail()
String	getEnvelopeId() The envelope ID of the envelope status that failed to post.
String	getEnvelopeUri() Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
ErrorDetails	getErrorDetails() Get errorDetails
String	getName()
String	getSubmittedDateTime()
String	getTransactionId() Used to identify an envelope.
int	hashCode()
BulkEnvelope	name(String name)
void	setBulkRecipientRow(String bulkRecipientRow)
void	setBulkStatus(String bulkStatus)
void	setEmail(String email)
void	setEnvelopeId(String envelopeId)
void	setEnvelopeUri(String envelopeUri)
void	setErrorDetails(ErrorDetails errorDetails)
void	setName(String name)
void	setSubmittedDateTime(String submittedDateTime)
void	setTransactionId(String transactionId)
BulkEnvelope	submittedDateTime(String submittedDateTime)
String	toString()
BulkEnvelope	transactionId(String transactionId)

Methods inherited from class java.lang.Object

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

Constructor Detail

BulkEnvelope

public BulkEnvelope()

Method Detail

bulkRecipientRow

public BulkEnvelope bulkRecipientRow(String bulkRecipientRow)

getBulkRecipientRow

public String getBulkRecipientRow()

Reserved: TBD

Returns:

bulkRecipientRow

setBulkRecipientRow

public void setBulkRecipientRow(String bulkRecipientRow)

bulkStatus

public BulkEnvelope bulkStatus(String bulkStatus)

getBulkStatus

public String getBulkStatus()

Indicates the status of the bulk send operation. Returned values can be: * queued * processing * sent * failed

Returns:

bulkStatus

setBulkStatus

public void setBulkStatus(String bulkStatus)

email

public BulkEnvelope email(String email)

getEmail

public String getEmail()

Returns:

email

setEmail

public void setEmail(String email)

envelopeId

public BulkEnvelope 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)

envelopeUri

public BulkEnvelope envelopeUri(String envelopeUri)

getEnvelopeUri

public String getEnvelopeUri()

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.

Returns:

envelopeUri

setEnvelopeUri

public void setEnvelopeUri(String envelopeUri)

errorDetails

public BulkEnvelope errorDetails(ErrorDetails errorDetails)

getErrorDetails

public ErrorDetails getErrorDetails()

Get errorDetails

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

name

public BulkEnvelope name(String name)

getName

public String getName()

Returns:

name

setName

public void setName(String name)

submittedDateTime

public BulkEnvelope submittedDateTime(String submittedDateTime)

getSubmittedDateTime

public String getSubmittedDateTime()

Returns:

submittedDateTime

setSubmittedDateTime

public void setSubmittedDateTime(String submittedDateTime)

transactionId

public BulkEnvelope transactionId(String transactionId)

getTransactionId

public String getTransactionId()

Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.

Returns:

transactionId

setTransactionId

public void setTransactionId(String transactionId)

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