Package com.docusign.esign.model

Class PrefillTabs

  • public class PrefillTabs
extends Object
    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. Only the following tab types can be prefill tabs: - text - check boxes - radio buttons [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.

    • Constructor Detail

      • PrefillTabs

        public PrefillTabs()

    • Method Detail

      • checkboxTabs

        public PrefillTabs checkboxTabs​(List<Checkbox> checkboxTabs)
        checkboxTabs.
        Returns:
        PrefillTabs

      • addCheckboxTabsItem

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

      • 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.

      • dateTabs

        public PrefillTabs dateTabs​(List<Date> dateTabs)
        dateTabs.
        Returns:
        PrefillTabs

      • addDateTabsItem

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

      • 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.

      • emailTabs

        public PrefillTabs emailTabs​(List<Email> emailTabs)
        emailTabs.
        Returns:
        PrefillTabs

      • addEmailTabsItem

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

      • 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.

      • numberTabs

        public PrefillTabs numberTabs​(List<Number> numberTabs)
        numberTabs.
        Returns:
        PrefillTabs

      • addNumberTabsItem

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

      • 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.

      • radioGroupTabs

        public PrefillTabs radioGroupTabs​(List<RadioGroup> radioGroupTabs)
        radioGroupTabs.
        Returns:
        PrefillTabs

      • addRadioGroupTabsItem

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

      • 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.

      • senderCompanyTabs

        public PrefillTabs senderCompanyTabs​(List<SenderCompany> senderCompanyTabs)
        senderCompanyTabs.
        Returns:
        PrefillTabs

      • addSenderCompanyTabsItem

        public PrefillTabs addSenderCompanyTabsItem​(SenderCompany senderCompanyTabsItem)
        addSenderCompanyTabsItem.
        Returns:
        PrefillTabs

      • getSenderCompanyTabs

        public List<SenderCompany> getSenderCompanyTabs()
        .
        Returns:
        senderCompanyTabs

      • setSenderCompanyTabs

        public void setSenderCompanyTabs​(List<SenderCompany> senderCompanyTabs)
        setSenderCompanyTabs.

      • senderNameTabs

        public PrefillTabs senderNameTabs​(List<SenderName> senderNameTabs)
        senderNameTabs.
        Returns:
        PrefillTabs

      • addSenderNameTabsItem

        public PrefillTabs addSenderNameTabsItem​(SenderName senderNameTabsItem)
        addSenderNameTabsItem.
        Returns:
        PrefillTabs

      • getSenderNameTabs

        public List<SenderName> getSenderNameTabs()
        .
        Returns:
        senderNameTabs

      • setSenderNameTabs

        public void setSenderNameTabs​(List<SenderName> senderNameTabs)
        setSenderNameTabs.

      • ssnTabs

        public PrefillTabs ssnTabs​(List<Ssn> ssnTabs)
        ssnTabs.
        Returns:
        PrefillTabs

      • addSsnTabsItem

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

      • 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 PrefillTabs addTabGroupsItem​(TabGroup tabGroupsItem)
        addTabGroupsItem.
        Returns:
        PrefillTabs

      • getTabGroups

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

      • setTabGroups

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

      • textTabs

        public PrefillTabs textTabs​(List<Text> textTabs)
        textTabs.
        Returns:
        PrefillTabs

      • addTextTabsItem

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

      • 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.

      • zipTabs

        public PrefillTabs zipTabs​(List<Zip> zipTabs)
        zipTabs.
        Returns:
        PrefillTabs

      • addZipTabsItem

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

      • 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