com.docusign.esign.model

Class Recipients

java.lang.Object

com.docusign.esign.model.Recipients

public class Recipients
extends Object

Specifies the envelope recipients.

Constructor Summary

Constructors

Constructor and Description
Recipients()

Method Summary

Methods

Modifier and Type	Method and Description
Recipients	addAgentsItem(Agent agentsItem)
Recipients	addCarbonCopiesItem(CarbonCopy carbonCopiesItem)
Recipients	addCertifiedDeliveriesItem(CertifiedDelivery certifiedDeliveriesItem)
Recipients	addEditorsItem(Editor editorsItem)
Recipients	addInPersonSignersItem(InPersonSigner inPersonSignersItem)
Recipients	addIntermediariesItem(Intermediary intermediariesItem)
Recipients	addSealsItem(SealSign sealsItem)
Recipients	addSignersItem(Signer signersItem)
Recipients	agents(List<Agent> agents)
Recipients	carbonCopies(List<CarbonCopy> carbonCopies)
Recipients	certifiedDeliveries(List<CertifiedDelivery> certifiedDeliveries)
Recipients	currentRoutingOrder(String currentRoutingOrder)
Recipients	editors(List<Editor> editors)
boolean	equals(Object o)
Recipients	errorDetails(ErrorDetails errorDetails)
List<Agent>	getAgents() A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document.
List<CarbonCopy>	getCarbonCopies() A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it.
List<CertifiedDelivery>	getCertifiedDeliveries() A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.
String	getCurrentRoutingOrder()
List<Editor>	getEditors() A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document.
ErrorDetails	getErrorDetails() Get errorDetails
List<InPersonSigner>	getInPersonSigners() Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction.
List<Intermediary>	getIntermediaries() Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).
String	getRecipientCount()
List<SealSign>	getSeals()
List<Signer>	getSigners() A complex type containing information about the Signer recipient.
int	hashCode()
Recipients	inPersonSigners(List<InPersonSigner> inPersonSigners)
Recipients	intermediaries(List<Intermediary> intermediaries)
Recipients	recipientCount(String recipientCount)
Recipients	seals(List<SealSign> seals)
void	setAgents(List<Agent> agents)
void	setCarbonCopies(List<CarbonCopy> carbonCopies)
void	setCertifiedDeliveries(List<CertifiedDelivery> certifiedDeliveries)
void	setCurrentRoutingOrder(String currentRoutingOrder)
void	setEditors(List<Editor> editors)
void	setErrorDetails(ErrorDetails errorDetails)
void	setInPersonSigners(List<InPersonSigner> inPersonSigners)
void	setIntermediaries(List<Intermediary> intermediaries)
void	setRecipientCount(String recipientCount)
void	setSeals(List<SealSign> seals)
void	setSigners(List<Signer> signers)
Recipients	signers(List<Signer> signers)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

Recipients

public Recipients()

Method Detail

agents

public Recipients agents(List<Agent> agents)

addAgentsItem

public Recipients addAgentsItem(Agent agentsItem)

getAgents

public List<Agent> getAgents()

A complex type defining the management and access rights of a recipient assigned assigned as an agent on the document.

Returns:

agents

setAgents

public void setAgents(List<Agent> agents)

carbonCopies

public Recipients carbonCopies(List<CarbonCopy> carbonCopies)

addCarbonCopiesItem

public Recipients addCarbonCopiesItem(CarbonCopy carbonCopiesItem)

getCarbonCopies

public List<CarbonCopy> getCarbonCopies()

A complex type containing information about recipients who should receive a copy of the envelope, but does not need to sign it.

Returns:

carbonCopies

setCarbonCopies

public void setCarbonCopies(List<CarbonCopy> carbonCopies)

certifiedDeliveries

public Recipients certifiedDeliveries(List<CertifiedDelivery> certifiedDeliveries)

addCertifiedDeliveriesItem

public Recipients addCertifiedDeliveriesItem(CertifiedDelivery certifiedDeliveriesItem)

getCertifiedDeliveries

public List<CertifiedDelivery> getCertifiedDeliveries()

A complex type containing information on a recipient the must receive the completed documents for the envelope to be completed, but the recipient does not need to sign, initial, date, or add information to any of the documents.

Returns:

certifiedDeliveries

setCertifiedDeliveries

public void setCertifiedDeliveries(List<CertifiedDelivery> certifiedDeliveries)

currentRoutingOrder

public Recipients currentRoutingOrder(String currentRoutingOrder)

getCurrentRoutingOrder

public String getCurrentRoutingOrder()

Returns:

currentRoutingOrder

setCurrentRoutingOrder

public void setCurrentRoutingOrder(String currentRoutingOrder)

editors

public Recipients editors(List<Editor> editors)

addEditorsItem

public Recipients addEditorsItem(Editor editorsItem)

getEditors

public List<Editor> getEditors()

A complex type defining the management and access rights of a recipient assigned assigned as an editor on the document.

Returns:

editors

setEditors

public void setEditors(List<Editor> editors)

errorDetails

public Recipients errorDetails(ErrorDetails errorDetails)

getErrorDetails

public ErrorDetails getErrorDetails()

Get errorDetails

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

inPersonSigners

public Recipients inPersonSigners(List<InPersonSigner> inPersonSigners)

addInPersonSignersItem

public Recipients addInPersonSignersItem(InPersonSigner inPersonSignersItem)

getInPersonSigners

public List<InPersonSigner> getInPersonSigners()

Specifies a signer that is in the same physical location as a DocuSign user who will act as a Signing Host for the transaction. The recipient added is the Signing Host and new separate Signer Name field appears after Sign in person is selected.

Returns:

inPersonSigners

setInPersonSigners

public void setInPersonSigners(List<InPersonSigner> inPersonSigners)

intermediaries

public Recipients intermediaries(List<Intermediary> intermediaries)

addIntermediariesItem

public Recipients addIntermediariesItem(Intermediary intermediariesItem)

getIntermediaries

public List<Intermediary> getIntermediaries()

Identifies a recipient that can, but is not required to, add name and email information for recipients at the same or subsequent level in the routing order (until subsequent Agents, Editors or Intermediaries recipient types are added).

Returns:

intermediaries

setIntermediaries

public void setIntermediaries(List<Intermediary> intermediaries)

recipientCount

public Recipients recipientCount(String recipientCount)

getRecipientCount

public String getRecipientCount()

Returns:

recipientCount

setRecipientCount

public void setRecipientCount(String recipientCount)

seals

public Recipients seals(List<SealSign> seals)

addSealsItem

public Recipients addSealsItem(SealSign sealsItem)

getSeals

public List<SealSign> getSeals()

Returns:

seals

setSeals

public void setSeals(List<SealSign> seals)

signers

public Recipients signers(List<Signer> signers)

addSignersItem

public Recipients addSignersItem(Signer signersItem)

getSigners

public List<Signer> getSigners()

A complex type containing information about the Signer recipient.

Returns:

signers

setSigners

public void setSigners(List<Signer> signers)

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