Package com.docusign.esign.model

Class Recipients

  • public class Recipients
extends java.lang.Object
    Specifies the envelope recipients..

    • Constructor Detail

      • Recipients

        public Recipients()

    • Method Detail

      • agents

        public Recipients agents​(java.util.List<Agent> agents)
        agents.
        Returns:
        Recipients

      • addAgentsItem

        public Recipients addAgentsItem​(Agent agentsItem)
        addAgentsItem.
        Returns:
        Recipients

      • getAgents

        public java.util.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​(java.util.List<Agent> agents)
        setAgents.

      • carbonCopies

        public Recipients carbonCopies​(java.util.List<CarbonCopy> carbonCopies)
        carbonCopies.
        Returns:
        Recipients

      • addCarbonCopiesItem

        public Recipients addCarbonCopiesItem​(CarbonCopy carbonCopiesItem)
        addCarbonCopiesItem.
        Returns:
        Recipients

      • getCarbonCopies

        public java.util.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​(java.util.List<CarbonCopy> carbonCopies)
        setCarbonCopies.

      • certifiedDeliveries

        public Recipients certifiedDeliveries​(java.util.List<CertifiedDelivery> certifiedDeliveries)
        certifiedDeliveries.
        Returns:
        Recipients

      • addCertifiedDeliveriesItem

        public Recipients addCertifiedDeliveriesItem​(CertifiedDelivery certifiedDeliveriesItem)
        addCertifiedDeliveriesItem.
        Returns:
        Recipients

      • getCertifiedDeliveries

        public java.util.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​(java.util.List<CertifiedDelivery> certifiedDeliveries)
        setCertifiedDeliveries.

      • currentRoutingOrder

        public Recipients currentRoutingOrder​(java.lang.String currentRoutingOrder)
        currentRoutingOrder.
        Returns:
        Recipients

      • getCurrentRoutingOrder

        public java.lang.String getCurrentRoutingOrder()
        .
        Returns:
        currentRoutingOrder

      • setCurrentRoutingOrder

        public void setCurrentRoutingOrder​(java.lang.String currentRoutingOrder)
        setCurrentRoutingOrder.

      • editors

        public Recipients editors​(java.util.List<Editor> editors)
        editors.
        Returns:
        Recipients

      • addEditorsItem

        public Recipients addEditorsItem​(Editor editorsItem)
        addEditorsItem.
        Returns:
        Recipients

      • getEditors

        public java.util.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​(java.util.List<Editor> editors)
        setEditors.

      • errorDetails

        public Recipients errorDetails​(ErrorDetails errorDetails)
        errorDetails.
        Returns:
        Recipients

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Get errorDetails.
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • inPersonSigners

        public Recipients inPersonSigners​(java.util.List<InPersonSigner> inPersonSigners)
        inPersonSigners.
        Returns:
        Recipients

      • addInPersonSignersItem

        public Recipients addInPersonSignersItem​(InPersonSigner inPersonSignersItem)
        addInPersonSignersItem.
        Returns:
        Recipients

      • getInPersonSigners

        public java.util.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​(java.util.List<InPersonSigner> inPersonSigners)
        setInPersonSigners.

      • intermediaries

        public Recipients intermediaries​(java.util.List<Intermediary> intermediaries)
        intermediaries.
        Returns:
        Recipients

      • addIntermediariesItem

        public Recipients addIntermediariesItem​(Intermediary intermediariesItem)
        addIntermediariesItem.
        Returns:
        Recipients

      • getIntermediaries

        public java.util.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​(java.util.List<Intermediary> intermediaries)
        setIntermediaries.

      • getNotaries

        public java.util.List<NotaryRecipient> getNotaries()
        .
        Returns:
        notaries

      • setNotaries

        public void setNotaries​(java.util.List<NotaryRecipient> notaries)
        setNotaries.

      • recipientCount

        public Recipients recipientCount​(java.lang.String recipientCount)
        recipientCount.
        Returns:
        Recipients

      • getRecipientCount

        public java.lang.String getRecipientCount()
        .
        Returns:
        recipientCount

      • setRecipientCount

        public void setRecipientCount​(java.lang.String recipientCount)
        setRecipientCount.

      • seals

        public Recipients seals​(java.util.List<SealSign> seals)
        seals.
        Returns:
        Recipients

      • addSealsItem

        public Recipients addSealsItem​(SealSign sealsItem)
        addSealsItem.
        Returns:
        Recipients

      • getSeals

        public java.util.List<SealSign> getSeals()
        .
        Returns:
        seals

      • setSeals

        public void setSeals​(java.util.List<SealSign> seals)
        setSeals.

      • signers

        public Recipients signers​(java.util.List<Signer> signers)
        signers.
        Returns:
        Recipients

      • addSignersItem

        public Recipients addSignersItem​(Signer signersItem)
        addSignersItem.
        Returns:
        Recipients

      • getSigners

        public java.util.List<Signer> getSigners()
        A complex type containing information about the Signer recipient..
        Returns:
        signers

      • setSigners

        public void setSigners​(java.util.List<Signer> signers)
        setSigners.

      • witnesses

        public Recipients witnesses​(java.util.List<Witness> witnesses)
        witnesses.
        Returns:
        Recipients

      • addWitnessesItem

        public Recipients addWitnessesItem​(Witness witnessesItem)
        addWitnessesItem.
        Returns:
        Recipients

      • getWitnesses

        public java.util.List<Witness> getWitnesses()
        .
        Returns:
        witnesses

      • setWitnesses

        public void setWitnesses​(java.util.List<Witness> witnesses)
        setWitnesses.

      • equals

        public boolean equals​(java.lang.Object o)
        Compares objects.
        Overrides:
        equals in class java.lang.Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Converts the given object to string.
        Overrides:
        toString in class java.lang.Object