Package com.docusign.esign.model

Class ModelList

  • public class ModelList
extends Object
    ModelList.

    • Constructor Detail

      • ModelList

        public ModelList()

    • Method Detail

      • anchorAllowWhiteSpaceInCharacters

        public ModelList anchorAllowWhiteSpaceInCharacters​(String anchorAllowWhiteSpaceInCharacters)
        anchorAllowWhiteSpaceInCharacters.
        Returns:
        ModelList

      • getAnchorAllowWhiteSpaceInCharacters

        public String getAnchorAllowWhiteSpaceInCharacters()
        .
        Returns:
        anchorAllowWhiteSpaceInCharacters

      • setAnchorAllowWhiteSpaceInCharacters

        public void setAnchorAllowWhiteSpaceInCharacters​(String anchorAllowWhiteSpaceInCharacters)
        setAnchorAllowWhiteSpaceInCharacters.

      • anchorAllowWhiteSpaceInCharactersMetadata

        public ModelList anchorAllowWhiteSpaceInCharactersMetadata​(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
        anchorAllowWhiteSpaceInCharactersMetadata.
        Returns:
        ModelList

      • getAnchorAllowWhiteSpaceInCharactersMetadata

        public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
        Get anchorAllowWhiteSpaceInCharactersMetadata.
        Returns:
        anchorAllowWhiteSpaceInCharactersMetadata

      • setAnchorAllowWhiteSpaceInCharactersMetadata

        public void setAnchorAllowWhiteSpaceInCharactersMetadata​(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
        setAnchorAllowWhiteSpaceInCharactersMetadata.

      • anchorCaseSensitive

        public ModelList anchorCaseSensitive​(String anchorCaseSensitive)
        anchorCaseSensitive.
        Returns:
        ModelList

      • getAnchorCaseSensitive

        public String getAnchorCaseSensitive()
        When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**..
        Returns:
        anchorCaseSensitive

      • setAnchorCaseSensitive

        public void setAnchorCaseSensitive​(String anchorCaseSensitive)
        setAnchorCaseSensitive.

      • anchorCaseSensitiveMetadata

        public ModelList anchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)
        anchorCaseSensitiveMetadata.
        Returns:
        ModelList

      • getAnchorCaseSensitiveMetadata

        public PropertyMetadata getAnchorCaseSensitiveMetadata()
        Get anchorCaseSensitiveMetadata.
        Returns:
        anchorCaseSensitiveMetadata

      • setAnchorCaseSensitiveMetadata

        public void setAnchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)
        setAnchorCaseSensitiveMetadata.

      • anchorHorizontalAlignment

        public ModelList anchorHorizontalAlignment​(String anchorHorizontalAlignment)
        anchorHorizontalAlignment.
        Returns:
        ModelList

      • getAnchorHorizontalAlignment

        public String getAnchorHorizontalAlignment()
        Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**..
        Returns:
        anchorHorizontalAlignment

      • setAnchorHorizontalAlignment

        public void setAnchorHorizontalAlignment​(String anchorHorizontalAlignment)
        setAnchorHorizontalAlignment.

      • anchorHorizontalAlignmentMetadata

        public ModelList anchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)
        anchorHorizontalAlignmentMetadata.
        Returns:
        ModelList

      • getAnchorHorizontalAlignmentMetadata

        public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
        Get anchorHorizontalAlignmentMetadata.
        Returns:
        anchorHorizontalAlignmentMetadata

      • setAnchorHorizontalAlignmentMetadata

        public void setAnchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)
        setAnchorHorizontalAlignmentMetadata.

      • anchorIgnoreIfNotPresent

        public ModelList anchorIgnoreIfNotPresent​(String anchorIgnoreIfNotPresent)
        anchorIgnoreIfNotPresent.
        Returns:
        ModelList

      • getAnchorIgnoreIfNotPresent

        public String getAnchorIgnoreIfNotPresent()
        When set to **true**, this tab is ignored if anchorString is not found in the document..
        Returns:
        anchorIgnoreIfNotPresent

      • setAnchorIgnoreIfNotPresent

        public void setAnchorIgnoreIfNotPresent​(String anchorIgnoreIfNotPresent)
        setAnchorIgnoreIfNotPresent.

      • anchorIgnoreIfNotPresentMetadata

        public ModelList anchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
        anchorIgnoreIfNotPresentMetadata.
        Returns:
        ModelList

      • getAnchorIgnoreIfNotPresentMetadata

        public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
        Get anchorIgnoreIfNotPresentMetadata.
        Returns:
        anchorIgnoreIfNotPresentMetadata

      • setAnchorIgnoreIfNotPresentMetadata

        public void setAnchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
        setAnchorIgnoreIfNotPresentMetadata.

      • anchorMatchWholeWord

        public ModelList anchorMatchWholeWord​(String anchorMatchWholeWord)
        anchorMatchWholeWord.
        Returns:
        ModelList

      • getAnchorMatchWholeWord

        public String getAnchorMatchWholeWord()
        When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**..
        Returns:
        anchorMatchWholeWord

      • setAnchorMatchWholeWord

        public void setAnchorMatchWholeWord​(String anchorMatchWholeWord)
        setAnchorMatchWholeWord.

      • anchorMatchWholeWordMetadata

        public ModelList anchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)
        anchorMatchWholeWordMetadata.
        Returns:
        ModelList

      • getAnchorMatchWholeWordMetadata

        public PropertyMetadata getAnchorMatchWholeWordMetadata()
        Get anchorMatchWholeWordMetadata.
        Returns:
        anchorMatchWholeWordMetadata

      • setAnchorMatchWholeWordMetadata

        public void setAnchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)
        setAnchorMatchWholeWordMetadata.

      • anchorString

        public ModelList anchorString​(String anchorString)
        anchorString.
        Returns:
        ModelList

      • getAnchorString

        public String getAnchorString()
        Anchor text information for a radio button..
        Returns:
        anchorString

      • setAnchorString

        public void setAnchorString​(String anchorString)
        setAnchorString.

      • anchorStringMetadata

        public ModelList anchorStringMetadata​(PropertyMetadata anchorStringMetadata)
        anchorStringMetadata.
        Returns:
        ModelList

      • getAnchorStringMetadata

        public PropertyMetadata getAnchorStringMetadata()
        Get anchorStringMetadata.
        Returns:
        anchorStringMetadata

      • setAnchorStringMetadata

        public void setAnchorStringMetadata​(PropertyMetadata anchorStringMetadata)
        setAnchorStringMetadata.

      • anchorTabProcessorVersion

        public ModelList anchorTabProcessorVersion​(String anchorTabProcessorVersion)
        anchorTabProcessorVersion.
        Returns:
        ModelList

      • getAnchorTabProcessorVersion

        public String getAnchorTabProcessorVersion()
        .
        Returns:
        anchorTabProcessorVersion

      • setAnchorTabProcessorVersion

        public void setAnchorTabProcessorVersion​(String anchorTabProcessorVersion)
        setAnchorTabProcessorVersion.

      • anchorTabProcessorVersionMetadata

        public ModelList anchorTabProcessorVersionMetadata​(PropertyMetadata anchorTabProcessorVersionMetadata)
        anchorTabProcessorVersionMetadata.
        Returns:
        ModelList

      • getAnchorTabProcessorVersionMetadata

        public PropertyMetadata getAnchorTabProcessorVersionMetadata()
        Get anchorTabProcessorVersionMetadata.
        Returns:
        anchorTabProcessorVersionMetadata

      • setAnchorTabProcessorVersionMetadata

        public void setAnchorTabProcessorVersionMetadata​(PropertyMetadata anchorTabProcessorVersionMetadata)
        setAnchorTabProcessorVersionMetadata.

      • anchorUnits

        public ModelList anchorUnits​(String anchorUnits)
        anchorUnits.
        Returns:
        ModelList

      • getAnchorUnits

        public String getAnchorUnits()
        Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches..
        Returns:
        anchorUnits

      • setAnchorUnits

        public void setAnchorUnits​(String anchorUnits)
        setAnchorUnits.

      • anchorUnitsMetadata

        public ModelList anchorUnitsMetadata​(PropertyMetadata anchorUnitsMetadata)
        anchorUnitsMetadata.
        Returns:
        ModelList

      • getAnchorUnitsMetadata

        public PropertyMetadata getAnchorUnitsMetadata()
        Get anchorUnitsMetadata.
        Returns:
        anchorUnitsMetadata

      • setAnchorUnitsMetadata

        public void setAnchorUnitsMetadata​(PropertyMetadata anchorUnitsMetadata)
        setAnchorUnitsMetadata.

      • anchorXOffset

        public ModelList anchorXOffset​(String anchorXOffset)
        anchorXOffset.
        Returns:
        ModelList

      • getAnchorXOffset

        public String getAnchorXOffset()
        Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..
        Returns:
        anchorXOffset

      • setAnchorXOffset

        public void setAnchorXOffset​(String anchorXOffset)
        setAnchorXOffset.

      • anchorXOffsetMetadata

        public ModelList anchorXOffsetMetadata​(PropertyMetadata anchorXOffsetMetadata)
        anchorXOffsetMetadata.
        Returns:
        ModelList

      • getAnchorXOffsetMetadata

        public PropertyMetadata getAnchorXOffsetMetadata()
        Get anchorXOffsetMetadata.
        Returns:
        anchorXOffsetMetadata

      • setAnchorXOffsetMetadata

        public void setAnchorXOffsetMetadata​(PropertyMetadata anchorXOffsetMetadata)
        setAnchorXOffsetMetadata.

      • anchorYOffset

        public ModelList anchorYOffset​(String anchorYOffset)
        anchorYOffset.
        Returns:
        ModelList

      • getAnchorYOffset

        public String getAnchorYOffset()
        Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..
        Returns:
        anchorYOffset

      • setAnchorYOffset

        public void setAnchorYOffset​(String anchorYOffset)
        setAnchorYOffset.

      • anchorYOffsetMetadata

        public ModelList anchorYOffsetMetadata​(PropertyMetadata anchorYOffsetMetadata)
        anchorYOffsetMetadata.
        Returns:
        ModelList

      • getAnchorYOffsetMetadata

        public PropertyMetadata getAnchorYOffsetMetadata()
        Get anchorYOffsetMetadata.
        Returns:
        anchorYOffsetMetadata

      • setAnchorYOffsetMetadata

        public void setAnchorYOffsetMetadata​(PropertyMetadata anchorYOffsetMetadata)
        setAnchorYOffsetMetadata.

      • getBold

        public String getBold()
        When set to **true**, the information in the tab is bold..
        Returns:
        bold

      • setBold

        public void setBold​(String bold)
        setBold.

      • getBoldMetadata

        public PropertyMetadata getBoldMetadata()
        Get boldMetadata.
        Returns:
        boldMetadata

      • setBoldMetadata

        public void setBoldMetadata​(PropertyMetadata boldMetadata)
        setBoldMetadata.

      • caption

        public ModelList caption​(String caption)
        caption.
        Returns:
        ModelList

      • getCaption

        public String getCaption()
        .
        Returns:
        caption

      • setCaption

        public void setCaption​(String caption)
        setCaption.

      • captionMetadata

        public ModelList captionMetadata​(PropertyMetadata captionMetadata)
        captionMetadata.
        Returns:
        ModelList

      • getCaptionMetadata

        public PropertyMetadata getCaptionMetadata()
        Get captionMetadata.
        Returns:
        captionMetadata

      • setCaptionMetadata

        public void setCaptionMetadata​(PropertyMetadata captionMetadata)
        setCaptionMetadata.

      • conditionalParentLabel

        public ModelList conditionalParentLabel​(String conditionalParentLabel)
        conditionalParentLabel.
        Returns:
        ModelList

      • getConditionalParentLabel

        public String getConditionalParentLabel()
        For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility..
        Returns:
        conditionalParentLabel

      • setConditionalParentLabel

        public void setConditionalParentLabel​(String conditionalParentLabel)
        setConditionalParentLabel.

      • conditionalParentLabelMetadata

        public ModelList conditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)
        conditionalParentLabelMetadata.
        Returns:
        ModelList

      • getConditionalParentLabelMetadata

        public PropertyMetadata getConditionalParentLabelMetadata()
        Get conditionalParentLabelMetadata.
        Returns:
        conditionalParentLabelMetadata

      • setConditionalParentLabelMetadata

        public void setConditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)
        setConditionalParentLabelMetadata.

      • conditionalParentValue

        public ModelList conditionalParentValue​(String conditionalParentValue)
        conditionalParentValue.
        Returns:
        ModelList

      • getConditionalParentValue

        public String getConditionalParentValue()
        For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. .
        Returns:
        conditionalParentValue

      • setConditionalParentValue

        public void setConditionalParentValue​(String conditionalParentValue)
        setConditionalParentValue.

      • conditionalParentValueMetadata

        public ModelList conditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)
        conditionalParentValueMetadata.
        Returns:
        ModelList

      • getConditionalParentValueMetadata

        public PropertyMetadata getConditionalParentValueMetadata()
        Get conditionalParentValueMetadata.
        Returns:
        conditionalParentValueMetadata

      • setConditionalParentValueMetadata

        public void setConditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)
        setConditionalParentValueMetadata.

      • customTabId

        public ModelList customTabId​(String customTabId)
        customTabId.
        Returns:
        ModelList

      • getCustomTabId

        public String getCustomTabId()
        The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties..
        Returns:
        customTabId

      • setCustomTabId

        public void setCustomTabId​(String customTabId)
        setCustomTabId.

      • customTabIdMetadata

        public ModelList customTabIdMetadata​(PropertyMetadata customTabIdMetadata)
        customTabIdMetadata.
        Returns:
        ModelList

      • getCustomTabIdMetadata

        public PropertyMetadata getCustomTabIdMetadata()
        Get customTabIdMetadata.
        Returns:
        customTabIdMetadata

      • setCustomTabIdMetadata

        public void setCustomTabIdMetadata​(PropertyMetadata customTabIdMetadata)
        setCustomTabIdMetadata.

      • documentId

        public ModelList documentId​(String documentId)
        documentId.
        Returns:
        ModelList

      • getDocumentId

        public String getDocumentId()
        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute..
        Returns:
        documentId

      • setDocumentId

        public void setDocumentId​(String documentId)
        setDocumentId.

      • documentIdMetadata

        public ModelList documentIdMetadata​(PropertyMetadata documentIdMetadata)
        documentIdMetadata.
        Returns:
        ModelList

      • getDocumentIdMetadata

        public PropertyMetadata getDocumentIdMetadata()
        Get documentIdMetadata.
        Returns:
        documentIdMetadata

      • setDocumentIdMetadata

        public void setDocumentIdMetadata​(PropertyMetadata documentIdMetadata)
        setDocumentIdMetadata.

      • errorDetails

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

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Get errorDetails.
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • getFont

        public String getFont()
        The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default..
        Returns:
        font

      • setFont

        public void setFont​(String font)
        setFont.

      • fontColor

        public ModelList fontColor​(String fontColor)
        fontColor.
        Returns:
        ModelList

      • getFontColor

        public String getFontColor()
        The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White..
        Returns:
        fontColor

      • setFontColor

        public void setFontColor​(String fontColor)
        setFontColor.

      • fontColorMetadata

        public ModelList fontColorMetadata​(PropertyMetadata fontColorMetadata)
        fontColorMetadata.
        Returns:
        ModelList

      • getFontColorMetadata

        public PropertyMetadata getFontColorMetadata()
        Get fontColorMetadata.
        Returns:
        fontColorMetadata

      • setFontColorMetadata

        public void setFontColorMetadata​(PropertyMetadata fontColorMetadata)
        setFontColorMetadata.

      • getFontMetadata

        public PropertyMetadata getFontMetadata()
        Get fontMetadata.
        Returns:
        fontMetadata

      • setFontMetadata

        public void setFontMetadata​(PropertyMetadata fontMetadata)
        setFontMetadata.

      • fontSize

        public ModelList fontSize​(String fontSize)
        fontSize.
        Returns:
        ModelList

      • getFontSize

        public String getFontSize()
        The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72..
        Returns:
        fontSize

      • setFontSize

        public void setFontSize​(String fontSize)
        setFontSize.

      • fontSizeMetadata

        public ModelList fontSizeMetadata​(PropertyMetadata fontSizeMetadata)
        fontSizeMetadata.
        Returns:
        ModelList

      • getFontSizeMetadata

        public PropertyMetadata getFontSizeMetadata()
        Get fontSizeMetadata.
        Returns:
        fontSizeMetadata

      • setFontSizeMetadata

        public void setFontSizeMetadata​(PropertyMetadata fontSizeMetadata)
        setFontSizeMetadata.

      • formOrder

        public ModelList formOrder​(String formOrder)
        formOrder.
        Returns:
        ModelList

      • getFormOrder

        public String getFormOrder()
        .
        Returns:
        formOrder

      • setFormOrder

        public void setFormOrder​(String formOrder)
        setFormOrder.

      • formOrderMetadata

        public ModelList formOrderMetadata​(PropertyMetadata formOrderMetadata)
        formOrderMetadata.
        Returns:
        ModelList

      • getFormOrderMetadata

        public PropertyMetadata getFormOrderMetadata()
        Get formOrderMetadata.
        Returns:
        formOrderMetadata

      • setFormOrderMetadata

        public void setFormOrderMetadata​(PropertyMetadata formOrderMetadata)
        setFormOrderMetadata.

      • formPageLabel

        public ModelList formPageLabel​(String formPageLabel)
        formPageLabel.
        Returns:
        ModelList

      • getFormPageLabel

        public String getFormPageLabel()
        .
        Returns:
        formPageLabel

      • setFormPageLabel

        public void setFormPageLabel​(String formPageLabel)
        setFormPageLabel.

      • formPageLabelMetadata

        public ModelList formPageLabelMetadata​(PropertyMetadata formPageLabelMetadata)
        formPageLabelMetadata.
        Returns:
        ModelList

      • getFormPageLabelMetadata

        public PropertyMetadata getFormPageLabelMetadata()
        Get formPageLabelMetadata.
        Returns:
        formPageLabelMetadata

      • setFormPageLabelMetadata

        public void setFormPageLabelMetadata​(PropertyMetadata formPageLabelMetadata)
        setFormPageLabelMetadata.

      • formPageNumber

        public ModelList formPageNumber​(String formPageNumber)
        formPageNumber.
        Returns:
        ModelList

      • getFormPageNumber

        public String getFormPageNumber()
        .
        Returns:
        formPageNumber

      • setFormPageNumber

        public void setFormPageNumber​(String formPageNumber)
        setFormPageNumber.

      • formPageNumberMetadata

        public ModelList formPageNumberMetadata​(PropertyMetadata formPageNumberMetadata)
        formPageNumberMetadata.
        Returns:
        ModelList

      • getFormPageNumberMetadata

        public PropertyMetadata getFormPageNumberMetadata()
        Get formPageNumberMetadata.
        Returns:
        formPageNumberMetadata

      • setFormPageNumberMetadata

        public void setFormPageNumberMetadata​(PropertyMetadata formPageNumberMetadata)
        setFormPageNumberMetadata.

      • height

        public ModelList height​(String height)
        height.
        Returns:
        ModelList

      • getHeight

        public String getHeight()
        Height of the tab in pixels..
        Returns:
        height

      • setHeight

        public void setHeight​(String height)
        setHeight.

      • getHeightMetadata

        public PropertyMetadata getHeightMetadata()
        Get heightMetadata.
        Returns:
        heightMetadata

      • setHeightMetadata

        public void setHeightMetadata​(PropertyMetadata heightMetadata)
        setHeightMetadata.

      • italic

        public ModelList italic​(String italic)
        italic.
        Returns:
        ModelList

      • getItalic

        public String getItalic()
        When set to **true**, the information in the tab is italic..
        Returns:
        italic

      • setItalic

        public void setItalic​(String italic)
        setItalic.

      • getItalicMetadata

        public PropertyMetadata getItalicMetadata()
        Get italicMetadata.
        Returns:
        italicMetadata

      • setItalicMetadata

        public void setItalicMetadata​(PropertyMetadata italicMetadata)
        setItalicMetadata.

      • addListItemsItem

        public ModelList addListItemsItem​(ListItem listItemsItem)
        addListItemsItem.
        Returns:
        ModelList

      • getListItems

        public List<ListItem> getListItems()
        The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four] Maximum Length of listItems: 2048 characters. Maximum Length of items in the list: 100 characters. .
        Returns:
        listItems

      • setListItems

        public void setListItems​(List<ListItem> listItems)
        setListItems.

      • listSelectedValue

        public ModelList listSelectedValue​(String listSelectedValue)
        listSelectedValue.
        Returns:
        ModelList

      • getListSelectedValue

        public String getListSelectedValue()
        .
        Returns:
        listSelectedValue

      • setListSelectedValue

        public void setListSelectedValue​(String listSelectedValue)
        setListSelectedValue.

      • listSelectedValueMetadata

        public ModelList listSelectedValueMetadata​(PropertyMetadata listSelectedValueMetadata)
        listSelectedValueMetadata.
        Returns:
        ModelList

      • getListSelectedValueMetadata

        public PropertyMetadata getListSelectedValueMetadata()
        Get listSelectedValueMetadata.
        Returns:
        listSelectedValueMetadata

      • setListSelectedValueMetadata

        public void setListSelectedValueMetadata​(PropertyMetadata listSelectedValueMetadata)
        setListSelectedValueMetadata.

      • getLocalePolicy

        public LocalePolicyTab getLocalePolicy()
        Get localePolicy.
        Returns:
        localePolicy

      • setLocalePolicy

        public void setLocalePolicy​(LocalePolicyTab localePolicy)
        setLocalePolicy.

      • locked

        public ModelList locked​(String locked)
        locked.
        Returns:
        ModelList

      • getLocked

        public String getLocked()
        When set to **true**, the signer cannot change the data of the custom tab..
        Returns:
        locked

      • setLocked

        public void setLocked​(String locked)
        setLocked.

      • getLockedMetadata

        public PropertyMetadata getLockedMetadata()
        Get lockedMetadata.
        Returns:
        lockedMetadata

      • setLockedMetadata

        public void setLockedMetadata​(PropertyMetadata lockedMetadata)
        setLockedMetadata.

      • mergeField

        public ModelList mergeField​(MergeField mergeField)
        mergeField.
        Returns:
        ModelList

      • getMergeField

        public MergeField getMergeField()
        Get mergeField.
        Returns:
        mergeField

      • setMergeField

        public void setMergeField​(MergeField mergeField)
        setMergeField.

      • mergeFieldXml

        public ModelList mergeFieldXml​(String mergeFieldXml)
        mergeFieldXml.
        Returns:
        ModelList

      • getMergeFieldXml

        public String getMergeFieldXml()
        .
        Returns:
        mergeFieldXml

      • setMergeFieldXml

        public void setMergeFieldXml​(String mergeFieldXml)
        setMergeFieldXml.

      • originalValue

        public ModelList originalValue​(String originalValue)
        originalValue.
        Returns:
        ModelList

      • getOriginalValue

        public String getOriginalValue()
        The initial value of the tab when it was sent to the recipient. .
        Returns:
        originalValue

      • setOriginalValue

        public void setOriginalValue​(String originalValue)
        setOriginalValue.

      • originalValueMetadata

        public ModelList originalValueMetadata​(PropertyMetadata originalValueMetadata)
        originalValueMetadata.
        Returns:
        ModelList

      • getOriginalValueMetadata

        public PropertyMetadata getOriginalValueMetadata()
        Get originalValueMetadata.
        Returns:
        originalValueMetadata

      • setOriginalValueMetadata

        public void setOriginalValueMetadata​(PropertyMetadata originalValueMetadata)
        setOriginalValueMetadata.

      • pageNumber

        public ModelList pageNumber​(String pageNumber)
        pageNumber.
        Returns:
        ModelList

      • getPageNumber

        public String getPageNumber()
        Specifies the page number on which the tab is located..
        Returns:
        pageNumber

      • setPageNumber

        public void setPageNumber​(String pageNumber)
        setPageNumber.

      • pageNumberMetadata

        public ModelList pageNumberMetadata​(PropertyMetadata pageNumberMetadata)
        pageNumberMetadata.
        Returns:
        ModelList

      • getPageNumberMetadata

        public PropertyMetadata getPageNumberMetadata()
        Get pageNumberMetadata.
        Returns:
        pageNumberMetadata

      • setPageNumberMetadata

        public void setPageNumberMetadata​(PropertyMetadata pageNumberMetadata)
        setPageNumberMetadata.

      • recipientId

        public ModelList recipientId​(String recipientId)
        recipientId.
        Returns:
        ModelList

      • getRecipientId

        public String getRecipientId()
        Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..
        Returns:
        recipientId

      • setRecipientId

        public void setRecipientId​(String recipientId)
        setRecipientId.

      • recipientIdGuid

        public ModelList recipientIdGuid​(String recipientIdGuid)
        recipientIdGuid.
        Returns:
        ModelList

      • getRecipientIdGuid

        public String getRecipientIdGuid()
        .
        Returns:
        recipientIdGuid

      • setRecipientIdGuid

        public void setRecipientIdGuid​(String recipientIdGuid)
        setRecipientIdGuid.

      • recipientIdGuidMetadata

        public ModelList recipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)
        recipientIdGuidMetadata.
        Returns:
        ModelList

      • getRecipientIdGuidMetadata

        public PropertyMetadata getRecipientIdGuidMetadata()
        Get recipientIdGuidMetadata.
        Returns:
        recipientIdGuidMetadata

      • setRecipientIdGuidMetadata

        public void setRecipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)
        setRecipientIdGuidMetadata.

      • recipientIdMetadata

        public ModelList recipientIdMetadata​(PropertyMetadata recipientIdMetadata)
        recipientIdMetadata.
        Returns:
        ModelList

      • getRecipientIdMetadata

        public PropertyMetadata getRecipientIdMetadata()
        Get recipientIdMetadata.
        Returns:
        recipientIdMetadata

      • setRecipientIdMetadata

        public void setRecipientIdMetadata​(PropertyMetadata recipientIdMetadata)
        setRecipientIdMetadata.

      • requireAll

        public ModelList requireAll​(String requireAll)
        requireAll.
        Returns:
        ModelList

      • getRequireAll

        public String getRequireAll()
        When set to **true** and shared is true, information must be entered in this field to complete the envelope. .
        Returns:
        requireAll

      • setRequireAll

        public void setRequireAll​(String requireAll)
        setRequireAll.

      • requireAllMetadata

        public ModelList requireAllMetadata​(PropertyMetadata requireAllMetadata)
        requireAllMetadata.
        Returns:
        ModelList

      • getRequireAllMetadata

        public PropertyMetadata getRequireAllMetadata()
        Get requireAllMetadata.
        Returns:
        requireAllMetadata

      • setRequireAllMetadata

        public void setRequireAllMetadata​(PropertyMetadata requireAllMetadata)
        setRequireAllMetadata.

      • required

        public ModelList required​(String required)
        required.
        Returns:
        ModelList

      • getRequired

        public String getRequired()
        When set to **true**, the signer is required to fill out this tab.
        Returns:
        required

      • setRequired

        public void setRequired​(String required)
        setRequired.

      • requiredMetadata

        public ModelList requiredMetadata​(PropertyMetadata requiredMetadata)
        requiredMetadata.
        Returns:
        ModelList

      • getRequiredMetadata

        public PropertyMetadata getRequiredMetadata()
        Get requiredMetadata.
        Returns:
        requiredMetadata

      • setRequiredMetadata

        public void setRequiredMetadata​(PropertyMetadata requiredMetadata)
        setRequiredMetadata.

      • requireInitialOnSharedChange

        public ModelList requireInitialOnSharedChange​(String requireInitialOnSharedChange)
        requireInitialOnSharedChange.
        Returns:
        ModelList

      • getRequireInitialOnSharedChange

        public String getRequireInitialOnSharedChange()
        Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field..
        Returns:
        requireInitialOnSharedChange

      • setRequireInitialOnSharedChange

        public void setRequireInitialOnSharedChange​(String requireInitialOnSharedChange)
        setRequireInitialOnSharedChange.

      • requireInitialOnSharedChangeMetadata

        public ModelList requireInitialOnSharedChangeMetadata​(PropertyMetadata requireInitialOnSharedChangeMetadata)
        requireInitialOnSharedChangeMetadata.
        Returns:
        ModelList

      • getRequireInitialOnSharedChangeMetadata

        public PropertyMetadata getRequireInitialOnSharedChangeMetadata()
        Get requireInitialOnSharedChangeMetadata.
        Returns:
        requireInitialOnSharedChangeMetadata

      • setRequireInitialOnSharedChangeMetadata

        public void setRequireInitialOnSharedChangeMetadata​(PropertyMetadata requireInitialOnSharedChangeMetadata)
        setRequireInitialOnSharedChangeMetadata.

      • senderRequired

        public ModelList senderRequired​(String senderRequired)
        senderRequired.
        Returns:
        ModelList

      • getSenderRequired

        public String getSenderRequired()
        When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope..
        Returns:
        senderRequired

      • setSenderRequired

        public void setSenderRequired​(String senderRequired)
        setSenderRequired.

      • senderRequiredMetadata

        public ModelList senderRequiredMetadata​(PropertyMetadata senderRequiredMetadata)
        senderRequiredMetadata.
        Returns:
        ModelList

      • getSenderRequiredMetadata

        public PropertyMetadata getSenderRequiredMetadata()
        Get senderRequiredMetadata.
        Returns:
        senderRequiredMetadata

      • setSenderRequiredMetadata

        public void setSenderRequiredMetadata​(PropertyMetadata senderRequiredMetadata)
        setSenderRequiredMetadata.

      • shared

        public ModelList shared​(String shared)
        shared.
        Returns:
        ModelList

      • getShared

        public String getShared()
        When set to **true**, this custom tab is shared..
        Returns:
        shared

      • setShared

        public void setShared​(String shared)
        setShared.

      • getSharedMetadata

        public PropertyMetadata getSharedMetadata()
        Get sharedMetadata.
        Returns:
        sharedMetadata

      • setSharedMetadata

        public void setSharedMetadata​(PropertyMetadata sharedMetadata)
        setSharedMetadata.

      • shareToRecipients

        public ModelList shareToRecipients​(String shareToRecipients)
        shareToRecipients.
        Returns:
        ModelList

      • getShareToRecipients

        public String getShareToRecipients()
        .
        Returns:
        shareToRecipients

      • setShareToRecipients

        public void setShareToRecipients​(String shareToRecipients)
        setShareToRecipients.

      • shareToRecipientsMetadata

        public ModelList shareToRecipientsMetadata​(PropertyMetadata shareToRecipientsMetadata)
        shareToRecipientsMetadata.
        Returns:
        ModelList

      • getShareToRecipientsMetadata

        public PropertyMetadata getShareToRecipientsMetadata()
        Get shareToRecipientsMetadata.
        Returns:
        shareToRecipientsMetadata

      • setShareToRecipientsMetadata

        public void setShareToRecipientsMetadata​(PropertyMetadata shareToRecipientsMetadata)
        setShareToRecipientsMetadata.

      • smartContractInformation

        public ModelList smartContractInformation​(SmartContractInformation smartContractInformation)
        smartContractInformation.
        Returns:
        ModelList

      • getSmartContractInformation

        public SmartContractInformation getSmartContractInformation()
        Get smartContractInformation.
        Returns:
        smartContractInformation

      • setSmartContractInformation

        public void setSmartContractInformation​(SmartContractInformation smartContractInformation)
        setSmartContractInformation.

      • source

        public ModelList source​(String source)
        source.
        Returns:
        ModelList

      • getSource

        public String getSource()
        .
        Returns:
        source

      • setSource

        public void setSource​(String source)
        setSource.

      • status

        public ModelList status​(String status)
        status.
        Returns:
        ModelList

      • getStatus

        public String getStatus()
        Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..
        Returns:
        status

      • setStatus

        public void setStatus​(String status)
        setStatus.

      • getStatusMetadata

        public PropertyMetadata getStatusMetadata()
        Get statusMetadata.
        Returns:
        statusMetadata

      • setStatusMetadata

        public void setStatusMetadata​(PropertyMetadata statusMetadata)
        setStatusMetadata.

      • tabGroupLabels

        public ModelList tabGroupLabels​(List<String> tabGroupLabels)
        tabGroupLabels.
        Returns:
        ModelList

      • addTabGroupLabelsItem

        public ModelList addTabGroupLabelsItem​(String tabGroupLabelsItem)
        addTabGroupLabelsItem.
        Returns:
        ModelList

      • getTabGroupLabels

        public List<String> getTabGroupLabels()
        .
        Returns:
        tabGroupLabels

      • setTabGroupLabels

        public void setTabGroupLabels​(List<String> tabGroupLabels)
        setTabGroupLabels.

      • tabGroupLabelsMetadata

        public ModelList tabGroupLabelsMetadata​(PropertyMetadata tabGroupLabelsMetadata)
        tabGroupLabelsMetadata.
        Returns:
        ModelList

      • getTabGroupLabelsMetadata

        public PropertyMetadata getTabGroupLabelsMetadata()
        Get tabGroupLabelsMetadata.
        Returns:
        tabGroupLabelsMetadata

      • setTabGroupLabelsMetadata

        public void setTabGroupLabelsMetadata​(PropertyMetadata tabGroupLabelsMetadata)
        setTabGroupLabelsMetadata.

      • tabId

        public ModelList tabId​(String tabId)
        tabId.
        Returns:
        ModelList

      • getTabId

        public String getTabId()
        The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. .
        Returns:
        tabId

      • setTabId

        public void setTabId​(String tabId)
        setTabId.

      • getTabIdMetadata

        public PropertyMetadata getTabIdMetadata()
        Get tabIdMetadata.
        Returns:
        tabIdMetadata

      • setTabIdMetadata

        public void setTabIdMetadata​(PropertyMetadata tabIdMetadata)
        setTabIdMetadata.

      • tabLabel

        public ModelList tabLabel​(String tabLabel)
        tabLabel.
        Returns:
        ModelList

      • getTabLabel

        public String getTabLabel()
        The label string associated with the tab..
        Returns:
        tabLabel

      • setTabLabel

        public void setTabLabel​(String tabLabel)
        setTabLabel.

      • tabLabelMetadata

        public ModelList tabLabelMetadata​(PropertyMetadata tabLabelMetadata)
        tabLabelMetadata.
        Returns:
        ModelList

      • getTabLabelMetadata

        public PropertyMetadata getTabLabelMetadata()
        Get tabLabelMetadata.
        Returns:
        tabLabelMetadata

      • setTabLabelMetadata

        public void setTabLabelMetadata​(PropertyMetadata tabLabelMetadata)
        setTabLabelMetadata.

      • tabOrder

        public ModelList tabOrder​(String tabOrder)
        tabOrder.
        Returns:
        ModelList

      • getTabOrder

        public String getTabOrder()
        .
        Returns:
        tabOrder

      • setTabOrder

        public void setTabOrder​(String tabOrder)
        setTabOrder.

      • tabOrderMetadata

        public ModelList tabOrderMetadata​(PropertyMetadata tabOrderMetadata)
        tabOrderMetadata.
        Returns:
        ModelList

      • getTabOrderMetadata

        public PropertyMetadata getTabOrderMetadata()
        Get tabOrderMetadata.
        Returns:
        tabOrderMetadata

      • setTabOrderMetadata

        public void setTabOrderMetadata​(PropertyMetadata tabOrderMetadata)
        setTabOrderMetadata.

      • tabType

        public ModelList tabType​(String tabType)
        tabType.
        Returns:
        ModelList

      • getTabType

        public String getTabType()
        .
        Returns:
        tabType

      • setTabType

        public void setTabType​(String tabType)
        setTabType.

      • tabTypeMetadata

        public ModelList tabTypeMetadata​(PropertyMetadata tabTypeMetadata)
        tabTypeMetadata.
        Returns:
        ModelList

      • getTabTypeMetadata

        public PropertyMetadata getTabTypeMetadata()
        Get tabTypeMetadata.
        Returns:
        tabTypeMetadata

      • setTabTypeMetadata

        public void setTabTypeMetadata​(PropertyMetadata tabTypeMetadata)
        setTabTypeMetadata.

      • templateLocked

        public ModelList templateLocked​(String templateLocked)
        templateLocked.
        Returns:
        ModelList

      • getTemplateLocked

        public String getTemplateLocked()
        When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. .
        Returns:
        templateLocked

      • setTemplateLocked

        public void setTemplateLocked​(String templateLocked)
        setTemplateLocked.

      • templateLockedMetadata

        public ModelList templateLockedMetadata​(PropertyMetadata templateLockedMetadata)
        templateLockedMetadata.
        Returns:
        ModelList

      • getTemplateLockedMetadata

        public PropertyMetadata getTemplateLockedMetadata()
        Get templateLockedMetadata.
        Returns:
        templateLockedMetadata

      • setTemplateLockedMetadata

        public void setTemplateLockedMetadata​(PropertyMetadata templateLockedMetadata)
        setTemplateLockedMetadata.

      • templateRequired

        public ModelList templateRequired​(String templateRequired)
        templateRequired.
        Returns:
        ModelList

      • getTemplateRequired

        public String getTemplateRequired()
        When set to **true**, the sender may not remove the recipient. Used only when working with template recipients..
        Returns:
        templateRequired

      • setTemplateRequired

        public void setTemplateRequired​(String templateRequired)
        setTemplateRequired.

      • templateRequiredMetadata

        public ModelList templateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)
        templateRequiredMetadata.
        Returns:
        ModelList

      • getTemplateRequiredMetadata

        public PropertyMetadata getTemplateRequiredMetadata()
        Get templateRequiredMetadata.
        Returns:
        templateRequiredMetadata

      • setTemplateRequiredMetadata

        public void setTemplateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)
        setTemplateRequiredMetadata.

      • tooltip

        public ModelList tooltip​(String tooltip)
        tooltip.
        Returns:
        ModelList

      • getTooltip

        public String getTooltip()
        .
        Returns:
        tooltip

      • setTooltip

        public void setTooltip​(String tooltip)
        setTooltip.

      • toolTipMetadata

        public ModelList toolTipMetadata​(PropertyMetadata toolTipMetadata)
        toolTipMetadata.
        Returns:
        ModelList

      • getToolTipMetadata

        public PropertyMetadata getToolTipMetadata()
        Get toolTipMetadata.
        Returns:
        toolTipMetadata

      • setToolTipMetadata

        public void setToolTipMetadata​(PropertyMetadata toolTipMetadata)
        setToolTipMetadata.

      • underline

        public ModelList underline​(String underline)
        underline.
        Returns:
        ModelList

      • getUnderline

        public String getUnderline()
        When set to **true**, the information in the tab is underlined..
        Returns:
        underline

      • setUnderline

        public void setUnderline​(String underline)
        setUnderline.

      • underlineMetadata

        public ModelList underlineMetadata​(PropertyMetadata underlineMetadata)
        underlineMetadata.
        Returns:
        ModelList

      • getUnderlineMetadata

        public PropertyMetadata getUnderlineMetadata()
        Get underlineMetadata.
        Returns:
        underlineMetadata

      • setUnderlineMetadata

        public void setUnderlineMetadata​(PropertyMetadata underlineMetadata)
        setUnderlineMetadata.

      • value

        public ModelList value​(String value)
        value.
        Returns:
        ModelList

      • getValue

        public String getValue()
        The value to use when the item is selected..
        Returns:
        value

      • setValue

        public void setValue​(String value)
        setValue.

      • getValueMetadata

        public PropertyMetadata getValueMetadata()
        Get valueMetadata.
        Returns:
        valueMetadata

      • setValueMetadata

        public void setValueMetadata​(PropertyMetadata valueMetadata)
        setValueMetadata.

      • width

        public ModelList width​(String width)
        width.
        Returns:
        ModelList

      • getWidth

        public String getWidth()
        Width of the tab in pixels..
        Returns:
        width

      • setWidth

        public void setWidth​(String width)
        setWidth.

      • getWidthMetadata

        public PropertyMetadata getWidthMetadata()
        Get widthMetadata.
        Returns:
        widthMetadata

      • setWidthMetadata

        public void setWidthMetadata​(PropertyMetadata widthMetadata)
        setWidthMetadata.

      • xPosition

        public ModelList xPosition​(String xPosition)
        xPosition.
        Returns:
        ModelList

      • getXPosition

        public String getXPosition()
        This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position..
        Returns:
        xPosition

      • setXPosition

        public void setXPosition​(String xPosition)
        setXPosition.

      • xPositionMetadata

        public ModelList xPositionMetadata​(PropertyMetadata xPositionMetadata)
        xPositionMetadata.
        Returns:
        ModelList

      • getXPositionMetadata

        public PropertyMetadata getXPositionMetadata()
        Get xPositionMetadata.
        Returns:
        xPositionMetadata

      • setXPositionMetadata

        public void setXPositionMetadata​(PropertyMetadata xPositionMetadata)
        setXPositionMetadata.

      • yPosition

        public ModelList yPosition​(String yPosition)
        yPosition.
        Returns:
        ModelList

      • getYPosition

        public String getYPosition()
        This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position..
        Returns:
        yPosition

      • setYPosition

        public void setYPosition​(String yPosition)
        setYPosition.

      • yPositionMetadata

        public ModelList yPositionMetadata​(PropertyMetadata yPositionMetadata)
        yPositionMetadata.
        Returns:
        ModelList

      • getYPositionMetadata

        public PropertyMetadata getYPositionMetadata()
        Get yPositionMetadata.
        Returns:
        yPositionMetadata

      • setYPositionMetadata

        public void setYPositionMetadata​(PropertyMetadata yPositionMetadata)
        setYPositionMetadata.

      • 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