Package com.docusign.esign.model

Class TemplateTabs

  • public class TemplateTabs
extends Object
    TemplateTabs.

    • Constructor Detail

      • TemplateTabs

        public TemplateTabs()

    • Method Detail

      • addApproveTabsItem

        public TemplateTabs addApproveTabsItem​(Approve approveTabsItem)
        addApproveTabsItem.
        Returns:
        TemplateTabs

      • getApproveTabs

        public List<Approve> getApproveTabs()
        Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history..
        Returns:
        approveTabs

      • setApproveTabs

        public void setApproveTabs​(List<Approve> approveTabs)
        setApproveTabs.

      • addCheckboxTabsItem

        public TemplateTabs addCheckboxTabsItem​(Checkbox checkboxTabsItem)
        addCheckboxTabsItem.
        Returns:
        TemplateTabs

      • getCheckboxTabs

        public List<Checkbox> getCheckboxTabs()
        Specifies a tag on the document in a location where the recipient can select an option..
        Returns:
        checkboxTabs

      • setCheckboxTabs

        public void setCheckboxTabs​(List<Checkbox> checkboxTabs)
        setCheckboxTabs.

      • addCommentThreadTabsItem

        public TemplateTabs addCommentThreadTabsItem​(CommentThread commentThreadTabsItem)
        addCommentThreadTabsItem.
        Returns:
        TemplateTabs

      • getCommentThreadTabs

        public List<CommentThread> getCommentThreadTabs()
        .
        Returns:
        commentThreadTabs

      • setCommentThreadTabs

        public void setCommentThreadTabs​(List<CommentThread> commentThreadTabs)
        setCommentThreadTabs.

      • addCommissionCountyTabsItem

        public TemplateTabs addCommissionCountyTabsItem​(CommissionCounty commissionCountyTabsItem)
        addCommissionCountyTabsItem.
        Returns:
        TemplateTabs

      • getCommissionCountyTabs

        public List<CommissionCounty> getCommissionCountyTabs()
        .
        Returns:
        commissionCountyTabs

      • setCommissionCountyTabs

        public void setCommissionCountyTabs​(List<CommissionCounty> commissionCountyTabs)
        setCommissionCountyTabs.

      • addCommissionExpirationTabsItem

        public TemplateTabs addCommissionExpirationTabsItem​(CommissionExpiration commissionExpirationTabsItem)
        addCommissionExpirationTabsItem.
        Returns:
        TemplateTabs

      • getCommissionExpirationTabs

        public List<CommissionExpiration> getCommissionExpirationTabs()
        .
        Returns:
        commissionExpirationTabs

      • setCommissionExpirationTabs

        public void setCommissionExpirationTabs​(List<CommissionExpiration> commissionExpirationTabs)
        setCommissionExpirationTabs.

      • addCommissionNumberTabsItem

        public TemplateTabs addCommissionNumberTabsItem​(CommissionNumber commissionNumberTabsItem)
        addCommissionNumberTabsItem.
        Returns:
        TemplateTabs

      • getCommissionNumberTabs

        public List<CommissionNumber> getCommissionNumberTabs()
        .
        Returns:
        commissionNumberTabs

      • setCommissionNumberTabs

        public void setCommissionNumberTabs​(List<CommissionNumber> commissionNumberTabs)
        setCommissionNumberTabs.

      • addCommissionStateTabsItem

        public TemplateTabs addCommissionStateTabsItem​(CommissionState commissionStateTabsItem)
        addCommissionStateTabsItem.
        Returns:
        TemplateTabs

      • getCommissionStateTabs

        public List<CommissionState> getCommissionStateTabs()
        .
        Returns:
        commissionStateTabs

      • setCommissionStateTabs

        public void setCommissionStateTabs​(List<CommissionState> commissionStateTabs)
        setCommissionStateTabs.

      • addCompanyTabsItem

        public TemplateTabs addCompanyTabsItem​(Company companyTabsItem)
        addCompanyTabsItem.
        Returns:
        TemplateTabs

      • getCompanyTabs

        public List<Company> getCompanyTabs()
        Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response..
        Returns:
        companyTabs

      • setCompanyTabs

        public void setCompanyTabs​(List<Company> companyTabs)
        setCompanyTabs.

      • addCurrencyTabsItem

        public TemplateTabs addCurrencyTabsItem​(Currency currencyTabsItem)
        addCurrencyTabsItem.
        Returns:
        TemplateTabs

      • getCurrencyTabs

        public List<Currency> getCurrencyTabs()
        .
        Returns:
        currencyTabs

      • setCurrencyTabs

        public void setCurrencyTabs​(List<Currency> currencyTabs)
        setCurrencyTabs.

      • addDateSignedTabsItem

        public TemplateTabs addDateSignedTabsItem​(DateSigned dateSignedTabsItem)
        addDateSignedTabsItem.
        Returns:
        TemplateTabs

      • getDateSignedTabs

        public List<DateSigned> getDateSignedTabs()
        Specifies a tab on the document where the date the document was signed will automatically appear..
        Returns:
        dateSignedTabs

      • setDateSignedTabs

        public void setDateSignedTabs​(List<DateSigned> dateSignedTabs)
        setDateSignedTabs.

      • addDateTabsItem

        public TemplateTabs addDateTabsItem​(Date dateTabsItem)
        addDateTabsItem.
        Returns:
        TemplateTabs

      • getDateTabs

        public List<Date> getDateTabs()
        Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format..
        Returns:
        dateTabs

      • setDateTabs

        public void setDateTabs​(List<Date> dateTabs)
        setDateTabs.

      • addDeclineTabsItem

        public TemplateTabs addDeclineTabsItem​(Decline declineTabsItem)
        addDeclineTabsItem.
        Returns:
        TemplateTabs

      • getDeclineTabs

        public List<Decline> getDeclineTabs()
        Specifies a tag on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tag during the signing process, the envelope is voided..
        Returns:
        declineTabs

      • setDeclineTabs

        public void setDeclineTabs​(List<Decline> declineTabs)
        setDeclineTabs.

      • addDrawTabsItem

        public TemplateTabs addDrawTabsItem​(Draw drawTabsItem)
        addDrawTabsItem.
        Returns:
        TemplateTabs

      • getDrawTabs

        public List<Draw> getDrawTabs()
        .
        Returns:
        drawTabs

      • setDrawTabs

        public void setDrawTabs​(List<Draw> drawTabs)
        setDrawTabs.

      • addEmailAddressTabsItem

        public TemplateTabs addEmailAddressTabsItem​(EmailAddress emailAddressTabsItem)
        addEmailAddressTabsItem.
        Returns:
        TemplateTabs

      • getEmailAddressTabs

        public List<EmailAddress> getEmailAddressTabs()
        Specifies a location on the document where you want where you want the recipient's email, as entered in the recipient information, to display..
        Returns:
        emailAddressTabs

      • setEmailAddressTabs

        public void setEmailAddressTabs​(List<EmailAddress> emailAddressTabs)
        setEmailAddressTabs.

      • addEmailTabsItem

        public TemplateTabs addEmailTabsItem​(Email emailTabsItem)
        addEmailTabsItem.
        Returns:
        TemplateTabs

      • getEmailTabs

        public List<Email> getEmailTabs()
        Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response..
        Returns:
        emailTabs

      • setEmailTabs

        public void setEmailTabs​(List<Email> emailTabs)
        setEmailTabs.

      • addEnvelopeIdTabsItem

        public TemplateTabs addEnvelopeIdTabsItem​(EnvelopeId envelopeIdTabsItem)
        addEnvelopeIdTabsItem.
        Returns:
        TemplateTabs

      • getEnvelopeIdTabs

        public List<EnvelopeId> getEnvelopeIdTabs()
        Specifies a tag on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab, it is for informational purposes only..
        Returns:
        envelopeIdTabs

      • setEnvelopeIdTabs

        public void setEnvelopeIdTabs​(List<EnvelopeId> envelopeIdTabs)
        setEnvelopeIdTabs.

      • addFirstNameTabsItem

        public TemplateTabs addFirstNameTabsItem​(FirstName firstNameTabsItem)
        addFirstNameTabsItem.
        Returns:
        TemplateTabs

      • getFirstNameTabs

        public List<FirstName> getFirstNameTabs()
        Specifies tag on a document where you want the recipient's first name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name..
        Returns:
        firstNameTabs

      • setFirstNameTabs

        public void setFirstNameTabs​(List<FirstName> firstNameTabs)
        setFirstNameTabs.

      • addFormulaTabsItem

        public TemplateTabs addFormulaTabsItem​(FormulaTab formulaTabsItem)
        addFormulaTabsItem.
        Returns:
        TemplateTabs

      • getFormulaTabs

        public List<FormulaTab> getFormulaTabs()
        Specifies a tag that is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tag; the formula tab calculates and displays a new value when changes are made to the reference tag values. The reference tag information and calculation operations are entered in the \"formula\" element. See the [ML:Using the Calculated Fields Feature] quick start guide or [ML:DocuSign Service User Guide] for more information about formulas..
        Returns:
        formulaTabs

      • setFormulaTabs

        public void setFormulaTabs​(List<FormulaTab> formulaTabs)
        setFormulaTabs.

      • addFullNameTabsItem

        public TemplateTabs addFullNameTabsItem​(FullName fullNameTabsItem)
        addFullNameTabsItem.
        Returns:
        TemplateTabs

      • getFullNameTabs

        public List<FullName> getFullNameTabs()
        Specifies a tag on the document where you want the recipient's name to appear..
        Returns:
        fullNameTabs

      • setFullNameTabs

        public void setFullNameTabs​(List<FullName> fullNameTabs)
        setFullNameTabs.

      • addInitialHereTabsItem

        public TemplateTabs addInitialHereTabsItem​(InitialHere initialHereTabsItem)
        addInitialHereTabsItem.
        Returns:
        TemplateTabs

      • getInitialHereTabs

        public List<InitialHere> getInitialHereTabs()
        Specifies a tag location in the document at which a recipient will place their initials. The `optional` parameter specifies whether the initials are required or optional..
        Returns:
        initialHereTabs

      • setInitialHereTabs

        public void setInitialHereTabs​(List<InitialHere> initialHereTabs)
        setInitialHereTabs.

      • addLastNameTabsItem

        public TemplateTabs addLastNameTabsItem​(LastName lastNameTabsItem)
        addLastNameTabsItem.
        Returns:
        TemplateTabs

      • getLastNameTabs

        public List<LastName> getLastNameTabs()
        Specifies a tag on a document where you want the recipient's last name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name..
        Returns:
        lastNameTabs

      • setLastNameTabs

        public void setLastNameTabs​(List<LastName> lastNameTabs)
        setLastNameTabs.

      • addListTabsItem

        public TemplateTabs addListTabsItem​(List listTabsItem)
        addListTabsItem.
        Returns:
        TemplateTabs

      • getListTabs

        public List<List> getListTabs()
        Specify this tag to give your recipient a list of options, presented as a drop-down list, from which they can select..
        Returns:
        listTabs

      • setListTabs

        public void setListTabs​(List<List> listTabs)
        setListTabs.

      • addNotarizeTabsItem

        public TemplateTabs addNotarizeTabsItem​(Notarize notarizeTabsItem)
        addNotarizeTabsItem.
        Returns:
        TemplateTabs

      • getNotarizeTabs

        public List<Notarize> getNotarizeTabs()
        .
        Returns:
        notarizeTabs

      • setNotarizeTabs

        public void setNotarizeTabs​(List<Notarize> notarizeTabs)
        setNotarizeTabs.

      • addNotarySealTabsItem

        public TemplateTabs addNotarySealTabsItem​(NotarySeal notarySealTabsItem)
        addNotarySealTabsItem.
        Returns:
        TemplateTabs

      • getNotarySealTabs

        public List<NotarySeal> getNotarySealTabs()
        .
        Returns:
        notarySealTabs

      • setNotarySealTabs

        public void setNotarySealTabs​(List<NotarySeal> notarySealTabs)
        setNotarySealTabs.

      • addNoteTabsItem

        public TemplateTabs addNoteTabsItem​(Note noteTabsItem)
        addNoteTabsItem.
        Returns:
        TemplateTabs

      • getNoteTabs

        public List<Note> getNoteTabs()
        Specifies a location on the document where you want to place additional information, in the form of a note, for a recipient..
        Returns:
        noteTabs

      • setNoteTabs

        public void setNoteTabs​(List<Note> noteTabs)
        setNoteTabs.

      • addNumberTabsItem

        public TemplateTabs addNumberTabsItem​(Number numberTabsItem)
        addNumberTabsItem.
        Returns:
        TemplateTabs

      • getNumberTabs

        public List<Number> getNumberTabs()
        Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. .
        Returns:
        numberTabs

      • setNumberTabs

        public void setNumberTabs​(List<Number> numberTabs)
        setNumberTabs.

      • addPhoneNumberTabsItem

        public TemplateTabs addPhoneNumberTabsItem​(PhoneNumber phoneNumberTabsItem)
        addPhoneNumberTabsItem.
        Returns:
        TemplateTabs

      • getPhoneNumberTabs

        public List<PhoneNumber> getPhoneNumberTabs()
        .
        Returns:
        phoneNumberTabs

      • setPhoneNumberTabs

        public void setPhoneNumberTabs​(List<PhoneNumber> phoneNumberTabs)
        setPhoneNumberTabs.

      • addPolyLineOverlayTabsItem

        public TemplateTabs addPolyLineOverlayTabsItem​(PolyLineOverlay polyLineOverlayTabsItem)
        addPolyLineOverlayTabsItem.
        Returns:
        TemplateTabs

      • getPolyLineOverlayTabs

        public List<PolyLineOverlay> getPolyLineOverlayTabs()
        .
        Returns:
        polyLineOverlayTabs

      • setPolyLineOverlayTabs

        public void setPolyLineOverlayTabs​(List<PolyLineOverlay> polyLineOverlayTabs)
        setPolyLineOverlayTabs.

      • getPrefillTabs

        public PrefillTabs getPrefillTabs()
        Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields.
        Returns:
        prefillTabs

      • setPrefillTabs

        public void setPrefillTabs​(PrefillTabs prefillTabs)
        setPrefillTabs.

      • addRadioGroupTabsItem

        public TemplateTabs addRadioGroupTabsItem​(RadioGroup radioGroupTabsItem)
        addRadioGroupTabsItem.
        Returns:
        TemplateTabs

      • getRadioGroupTabs

        public List<RadioGroup> getRadioGroupTabs()
        Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document..
        Returns:
        radioGroupTabs

      • setRadioGroupTabs

        public void setRadioGroupTabs​(List<RadioGroup> radioGroupTabs)
        setRadioGroupTabs.

      • addSignerAttachmentTabsItem

        public TemplateTabs addSignerAttachmentTabsItem​(SignerAttachment signerAttachmentTabsItem)
        addSignerAttachmentTabsItem.
        Returns:
        TemplateTabs

      • getSignerAttachmentTabs

        public List<SignerAttachment> getSignerAttachmentTabs()
        Specifies a tag on the document when you want the recipient to add supporting documents to an envelope..
        Returns:
        signerAttachmentTabs

      • setSignerAttachmentTabs

        public void setSignerAttachmentTabs​(List<SignerAttachment> signerAttachmentTabs)
        setSignerAttachmentTabs.

      • addSignHereTabsItem

        public TemplateTabs addSignHereTabsItem​(SignHere signHereTabsItem)
        addSignHereTabsItem.
        Returns:
        TemplateTabs

      • getSignHereTabs

        public List<SignHere> getSignHereTabs()
        A complex type the contains information about the tag that specifies where the recipient places their signature in the document. The \"optional\" parameter sets if the signature is required or optional. .
        Returns:
        signHereTabs

      • setSignHereTabs

        public void setSignHereTabs​(List<SignHere> signHereTabs)
        setSignHereTabs.

      • addSmartSectionTabsItem

        public TemplateTabs addSmartSectionTabsItem​(SmartSection smartSectionTabsItem)
        addSmartSectionTabsItem.
        Returns:
        TemplateTabs

      • getSmartSectionTabs

        public List<SmartSection> getSmartSectionTabs()
        .
        Returns:
        smartSectionTabs

      • setSmartSectionTabs

        public void setSmartSectionTabs​(List<SmartSection> smartSectionTabs)
        setSmartSectionTabs.

      • addSsnTabsItem

        public TemplateTabs addSsnTabsItem​(Ssn ssnTabsItem)
        addSsnTabsItem.
        Returns:
        TemplateTabs

      • getSsnTabs

        public List<Ssn> getSsnTabs()
        Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response..
        Returns:
        ssnTabs

      • setSsnTabs

        public void setSsnTabs​(List<Ssn> ssnTabs)
        setSsnTabs.

      • addTabGroupsItem

        public TemplateTabs addTabGroupsItem​(TabGroup tabGroupsItem)
        addTabGroupsItem.
        Returns:
        TemplateTabs

      • getTabGroups

        public List<TabGroup> getTabGroups()
        .
        Returns:
        tabGroups

      • setTabGroups

        public void setTabGroups​(List<TabGroup> tabGroups)
        setTabGroups.

      • addTextTabsItem

        public TemplateTabs addTextTabsItem​(Text textTabsItem)
        addTextTabsItem.
        Returns:
        TemplateTabs

      • getTextTabs

        public List<Text> getTextTabs()
        Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response..
        Returns:
        textTabs

      • setTextTabs

        public void setTextTabs​(List<Text> textTabs)
        setTextTabs.

      • addTitleTabsItem

        public TemplateTabs addTitleTabsItem​(Title titleTabsItem)
        addTitleTabsItem.
        Returns:
        TemplateTabs

      • getTitleTabs

        public List<Title> getTitleTabs()
        Specifies a tag on the document where you want the recipient's title to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response..
        Returns:
        titleTabs

      • setTitleTabs

        public void setTitleTabs​(List<Title> titleTabs)
        setTitleTabs.

      • addViewTabsItem

        public TemplateTabs addViewTabsItem​(View viewTabsItem)
        addViewTabsItem.
        Returns:
        TemplateTabs

      • getViewTabs

        public List<View> getViewTabs()
        .
        Returns:
        viewTabs

      • setViewTabs

        public void setViewTabs​(List<View> viewTabs)
        setViewTabs.

      • addZipTabsItem

        public TemplateTabs addZipTabsItem​(Zip zipTabsItem)
        addZipTabsItem.
        Returns:
        TemplateTabs

      • getZipTabs

        public List<Zip> getZipTabs()
        Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response..
        Returns:
        zipTabs

      • setZipTabs

        public void setZipTabs​(List<Zip> zipTabs)
        setZipTabs.

      • equals

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

      • hashCode

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

      • toString

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