Package com.docusign.esign.model

Class List

  • public class List
extends java.lang.Object
    List

    • Constructor Detail

      • List

        public List()

    • Method Detail

      • anchorAllowWhiteSpaceInCharacters

        public List anchorAllowWhiteSpaceInCharacters​(java.lang.String anchorAllowWhiteSpaceInCharacters)

      • getAnchorAllowWhiteSpaceInCharacters

        public java.lang.String getAnchorAllowWhiteSpaceInCharacters()
        Returns:
        anchorAllowWhiteSpaceInCharacters

      • setAnchorAllowWhiteSpaceInCharacters

        public void setAnchorAllowWhiteSpaceInCharacters​(java.lang.String anchorAllowWhiteSpaceInCharacters)

      • anchorAllowWhiteSpaceInCharactersMetadata

        public List anchorAllowWhiteSpaceInCharactersMetadata​(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)

      • getAnchorAllowWhiteSpaceInCharactersMetadata

        public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
        Get anchorAllowWhiteSpaceInCharactersMetadata
        Returns:
        anchorAllowWhiteSpaceInCharactersMetadata

      • setAnchorAllowWhiteSpaceInCharactersMetadata

        public void setAnchorAllowWhiteSpaceInCharactersMetadata​(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)

      • anchorCaseSensitive

        public List anchorCaseSensitive​(java.lang.String anchorCaseSensitive)

      • getAnchorCaseSensitive

        public java.lang.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​(java.lang.String anchorCaseSensitive)

      • anchorCaseSensitiveMetadata

        public List anchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)

      • getAnchorCaseSensitiveMetadata

        public PropertyMetadata getAnchorCaseSensitiveMetadata()
        Get anchorCaseSensitiveMetadata
        Returns:
        anchorCaseSensitiveMetadata

      • setAnchorCaseSensitiveMetadata

        public void setAnchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)

      • anchorHorizontalAlignment

        public List anchorHorizontalAlignment​(java.lang.String anchorHorizontalAlignment)

      • getAnchorHorizontalAlignment

        public java.lang.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​(java.lang.String anchorHorizontalAlignment)

      • anchorHorizontalAlignmentMetadata

        public List anchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)

      • getAnchorHorizontalAlignmentMetadata

        public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
        Get anchorHorizontalAlignmentMetadata
        Returns:
        anchorHorizontalAlignmentMetadata

      • setAnchorHorizontalAlignmentMetadata

        public void setAnchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)

      • anchorIgnoreIfNotPresent

        public List anchorIgnoreIfNotPresent​(java.lang.String anchorIgnoreIfNotPresent)

      • getAnchorIgnoreIfNotPresent

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

      • setAnchorIgnoreIfNotPresent

        public void setAnchorIgnoreIfNotPresent​(java.lang.String anchorIgnoreIfNotPresent)

      • anchorIgnoreIfNotPresentMetadata

        public List anchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)

      • getAnchorIgnoreIfNotPresentMetadata

        public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
        Get anchorIgnoreIfNotPresentMetadata
        Returns:
        anchorIgnoreIfNotPresentMetadata

      • setAnchorIgnoreIfNotPresentMetadata

        public void setAnchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)

      • anchorMatchWholeWord

        public List anchorMatchWholeWord​(java.lang.String anchorMatchWholeWord)

      • getAnchorMatchWholeWord

        public java.lang.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​(java.lang.String anchorMatchWholeWord)

      • anchorMatchWholeWordMetadata

        public List anchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)

      • getAnchorMatchWholeWordMetadata

        public PropertyMetadata getAnchorMatchWholeWordMetadata()
        Get anchorMatchWholeWordMetadata
        Returns:
        anchorMatchWholeWordMetadata

      • setAnchorMatchWholeWordMetadata

        public void setAnchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)

      • anchorString

        public List anchorString​(java.lang.String anchorString)

      • getAnchorString

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

      • setAnchorString

        public void setAnchorString​(java.lang.String anchorString)

      • anchorStringMetadata

        public List anchorStringMetadata​(PropertyMetadata anchorStringMetadata)

      • getAnchorStringMetadata

        public PropertyMetadata getAnchorStringMetadata()
        Get anchorStringMetadata
        Returns:
        anchorStringMetadata

      • setAnchorStringMetadata

        public void setAnchorStringMetadata​(PropertyMetadata anchorStringMetadata)

      • anchorTabProcessorVersion

        public List anchorTabProcessorVersion​(java.lang.String anchorTabProcessorVersion)

      • getAnchorTabProcessorVersion

        public java.lang.String getAnchorTabProcessorVersion()
        Returns:
        anchorTabProcessorVersion

      • setAnchorTabProcessorVersion

        public void setAnchorTabProcessorVersion​(java.lang.String anchorTabProcessorVersion)

      • anchorTabProcessorVersionMetadata

        public List anchorTabProcessorVersionMetadata​(PropertyMetadata anchorTabProcessorVersionMetadata)

      • getAnchorTabProcessorVersionMetadata

        public PropertyMetadata getAnchorTabProcessorVersionMetadata()
        Get anchorTabProcessorVersionMetadata
        Returns:
        anchorTabProcessorVersionMetadata

      • setAnchorTabProcessorVersionMetadata

        public void setAnchorTabProcessorVersionMetadata​(PropertyMetadata anchorTabProcessorVersionMetadata)

      • anchorUnits

        public List anchorUnits​(java.lang.String anchorUnits)

      • getAnchorUnits

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

      • setAnchorUnits

        public void setAnchorUnits​(java.lang.String anchorUnits)

      • getAnchorUnitsMetadata

        public PropertyMetadata getAnchorUnitsMetadata()
        Get anchorUnitsMetadata
        Returns:
        anchorUnitsMetadata

      • setAnchorUnitsMetadata

        public void setAnchorUnitsMetadata​(PropertyMetadata anchorUnitsMetadata)

      • anchorXOffset

        public List anchorXOffset​(java.lang.String anchorXOffset)

      • getAnchorXOffset

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

      • setAnchorXOffset

        public void setAnchorXOffset​(java.lang.String anchorXOffset)

      • anchorXOffsetMetadata

        public List anchorXOffsetMetadata​(PropertyMetadata anchorXOffsetMetadata)

      • getAnchorXOffsetMetadata

        public PropertyMetadata getAnchorXOffsetMetadata()
        Get anchorXOffsetMetadata
        Returns:
        anchorXOffsetMetadata

      • setAnchorXOffsetMetadata

        public void setAnchorXOffsetMetadata​(PropertyMetadata anchorXOffsetMetadata)

      • anchorYOffset

        public List anchorYOffset​(java.lang.String anchorYOffset)

      • getAnchorYOffset

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

      • setAnchorYOffset

        public void setAnchorYOffset​(java.lang.String anchorYOffset)

      • anchorYOffsetMetadata

        public List anchorYOffsetMetadata​(PropertyMetadata anchorYOffsetMetadata)

      • getAnchorYOffsetMetadata

        public PropertyMetadata getAnchorYOffsetMetadata()
        Get anchorYOffsetMetadata
        Returns:
        anchorYOffsetMetadata

      • setAnchorYOffsetMetadata

        public void setAnchorYOffsetMetadata​(PropertyMetadata anchorYOffsetMetadata)

      • bold

        public List bold​(java.lang.String bold)

      • getBold

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

      • setBold

        public void setBold​(java.lang.String bold)

      • getBoldMetadata

        public PropertyMetadata getBoldMetadata()
        Get boldMetadata
        Returns:
        boldMetadata

      • setBoldMetadata

        public void setBoldMetadata​(PropertyMetadata boldMetadata)

      • conditionalParentLabel

        public List conditionalParentLabel​(java.lang.String conditionalParentLabel)

      • getConditionalParentLabel

        public java.lang.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​(java.lang.String conditionalParentLabel)

      • conditionalParentLabelMetadata

        public List conditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)

      • getConditionalParentLabelMetadata

        public PropertyMetadata getConditionalParentLabelMetadata()
        Get conditionalParentLabelMetadata
        Returns:
        conditionalParentLabelMetadata

      • setConditionalParentLabelMetadata

        public void setConditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)

      • conditionalParentValue

        public List conditionalParentValue​(java.lang.String conditionalParentValue)

      • getConditionalParentValue

        public java.lang.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​(java.lang.String conditionalParentValue)

      • conditionalParentValueMetadata

        public List conditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)

      • getConditionalParentValueMetadata

        public PropertyMetadata getConditionalParentValueMetadata()
        Get conditionalParentValueMetadata
        Returns:
        conditionalParentValueMetadata

      • setConditionalParentValueMetadata

        public void setConditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)

      • customTabId

        public List customTabId​(java.lang.String customTabId)

      • getCustomTabId

        public java.lang.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​(java.lang.String customTabId)

      • getCustomTabIdMetadata

        public PropertyMetadata getCustomTabIdMetadata()
        Get customTabIdMetadata
        Returns:
        customTabIdMetadata

      • setCustomTabIdMetadata

        public void setCustomTabIdMetadata​(PropertyMetadata customTabIdMetadata)

      • documentId

        public List documentId​(java.lang.String documentId)

      • getDocumentId

        public java.lang.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​(java.lang.String documentId)

      • getDocumentIdMetadata

        public PropertyMetadata getDocumentIdMetadata()
        Get documentIdMetadata
        Returns:
        documentIdMetadata

      • setDocumentIdMetadata

        public void setDocumentIdMetadata​(PropertyMetadata documentIdMetadata)

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Get errorDetails
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)

      • font

        public List font​(java.lang.String font)

      • getFont

        public java.lang.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​(java.lang.String font)

      • fontColor

        public List fontColor​(java.lang.String fontColor)

      • getFontColor

        public java.lang.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​(java.lang.String fontColor)

      • getFontColorMetadata

        public PropertyMetadata getFontColorMetadata()
        Get fontColorMetadata
        Returns:
        fontColorMetadata

      • setFontColorMetadata

        public void setFontColorMetadata​(PropertyMetadata fontColorMetadata)

      • getFontMetadata

        public PropertyMetadata getFontMetadata()
        Get fontMetadata
        Returns:
        fontMetadata

      • setFontMetadata

        public void setFontMetadata​(PropertyMetadata fontMetadata)

      • fontSize

        public List fontSize​(java.lang.String fontSize)

      • getFontSize

        public java.lang.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​(java.lang.String fontSize)

      • getFontSizeMetadata

        public PropertyMetadata getFontSizeMetadata()
        Get fontSizeMetadata
        Returns:
        fontSizeMetadata

      • setFontSizeMetadata

        public void setFontSizeMetadata​(PropertyMetadata fontSizeMetadata)

      • formOrder

        public List formOrder​(java.lang.String formOrder)

      • getFormOrder

        public java.lang.String getFormOrder()
        Returns:
        formOrder

      • setFormOrder

        public void setFormOrder​(java.lang.String formOrder)

      • getFormOrderMetadata

        public PropertyMetadata getFormOrderMetadata()
        Get formOrderMetadata
        Returns:
        formOrderMetadata

      • setFormOrderMetadata

        public void setFormOrderMetadata​(PropertyMetadata formOrderMetadata)

      • formPageLabel

        public List formPageLabel​(java.lang.String formPageLabel)

      • getFormPageLabel

        public java.lang.String getFormPageLabel()
        Returns:
        formPageLabel

      • setFormPageLabel

        public void setFormPageLabel​(java.lang.String formPageLabel)

      • formPageLabelMetadata

        public List formPageLabelMetadata​(PropertyMetadata formPageLabelMetadata)

      • getFormPageLabelMetadata

        public PropertyMetadata getFormPageLabelMetadata()
        Get formPageLabelMetadata
        Returns:
        formPageLabelMetadata

      • setFormPageLabelMetadata

        public void setFormPageLabelMetadata​(PropertyMetadata formPageLabelMetadata)

      • formPageNumber

        public List formPageNumber​(java.lang.String formPageNumber)

      • getFormPageNumber

        public java.lang.String getFormPageNumber()
        Returns:
        formPageNumber

      • setFormPageNumber

        public void setFormPageNumber​(java.lang.String formPageNumber)

      • formPageNumberMetadata

        public List formPageNumberMetadata​(PropertyMetadata formPageNumberMetadata)

      • getFormPageNumberMetadata

        public PropertyMetadata getFormPageNumberMetadata()
        Get formPageNumberMetadata
        Returns:
        formPageNumberMetadata

      • setFormPageNumberMetadata

        public void setFormPageNumberMetadata​(PropertyMetadata formPageNumberMetadata)

      • height

        public List height​(java.lang.String height)

      • getHeight

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

      • setHeight

        public void setHeight​(java.lang.String height)

      • getHeightMetadata

        public PropertyMetadata getHeightMetadata()
        Get heightMetadata
        Returns:
        heightMetadata

      • setHeightMetadata

        public void setHeightMetadata​(PropertyMetadata heightMetadata)

      • italic

        public List italic​(java.lang.String italic)

      • getItalic

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

      • setItalic

        public void setItalic​(java.lang.String italic)

      • getItalicMetadata

        public PropertyMetadata getItalicMetadata()
        Get italicMetadata
        Returns:
        italicMetadata

      • setItalicMetadata

        public void setItalicMetadata​(PropertyMetadata italicMetadata)

      • listItems

        public List listItems​(java.util.List<ListItem> listItems)

      • addListItemsItem

        public List addListItemsItem​(ListItem listItemsItem)

      • getListItems

        public java.util.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​(java.util.List<ListItem> listItems)

      • listSelectedValue

        public List listSelectedValue​(java.lang.String listSelectedValue)

      • getListSelectedValue

        public java.lang.String getListSelectedValue()
        Returns:
        listSelectedValue

      • setListSelectedValue

        public void setListSelectedValue​(java.lang.String listSelectedValue)

      • listSelectedValueMetadata

        public List listSelectedValueMetadata​(PropertyMetadata listSelectedValueMetadata)

      • getListSelectedValueMetadata

        public PropertyMetadata getListSelectedValueMetadata()
        Get listSelectedValueMetadata
        Returns:
        listSelectedValueMetadata

      • setListSelectedValueMetadata

        public void setListSelectedValueMetadata​(PropertyMetadata listSelectedValueMetadata)

      • getLocalePolicy

        public LocalePolicyTab getLocalePolicy()
        Get localePolicy
        Returns:
        localePolicy

      • setLocalePolicy

        public void setLocalePolicy​(LocalePolicyTab localePolicy)

      • locked

        public List locked​(java.lang.String locked)

      • getLocked

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

      • setLocked

        public void setLocked​(java.lang.String locked)

      • getLockedMetadata

        public PropertyMetadata getLockedMetadata()
        Get lockedMetadata
        Returns:
        lockedMetadata

      • setLockedMetadata

        public void setLockedMetadata​(PropertyMetadata lockedMetadata)

      • getMergeField

        public MergeField getMergeField()
        Get mergeField
        Returns:
        mergeField

      • setMergeField

        public void setMergeField​(MergeField mergeField)

      • mergeFieldXml

        public List mergeFieldXml​(java.lang.String mergeFieldXml)

      • getMergeFieldXml

        public java.lang.String getMergeFieldXml()
        Returns:
        mergeFieldXml

      • setMergeFieldXml

        public void setMergeFieldXml​(java.lang.String mergeFieldXml)

      • pageNumber

        public List pageNumber​(java.lang.String pageNumber)

      • getPageNumber

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

      • setPageNumber

        public void setPageNumber​(java.lang.String pageNumber)

      • getPageNumberMetadata

        public PropertyMetadata getPageNumberMetadata()
        Get pageNumberMetadata
        Returns:
        pageNumberMetadata

      • setPageNumberMetadata

        public void setPageNumberMetadata​(PropertyMetadata pageNumberMetadata)

      • recipientId

        public List recipientId​(java.lang.String recipientId)

      • getRecipientId

        public java.lang.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​(java.lang.String recipientId)

      • recipientIdGuid

        public List recipientIdGuid​(java.lang.String recipientIdGuid)

      • getRecipientIdGuid

        public java.lang.String getRecipientIdGuid()
        Returns:
        recipientIdGuid

      • setRecipientIdGuid

        public void setRecipientIdGuid​(java.lang.String recipientIdGuid)

      • recipientIdGuidMetadata

        public List recipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)

      • getRecipientIdGuidMetadata

        public PropertyMetadata getRecipientIdGuidMetadata()
        Get recipientIdGuidMetadata
        Returns:
        recipientIdGuidMetadata

      • setRecipientIdGuidMetadata

        public void setRecipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)

      • getRecipientIdMetadata

        public PropertyMetadata getRecipientIdMetadata()
        Get recipientIdMetadata
        Returns:
        recipientIdMetadata

      • setRecipientIdMetadata

        public void setRecipientIdMetadata​(PropertyMetadata recipientIdMetadata)

      • requireAll

        public List requireAll​(java.lang.String requireAll)

      • getRequireAll

        public java.lang.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​(java.lang.String requireAll)

      • getRequireAllMetadata

        public PropertyMetadata getRequireAllMetadata()
        Get requireAllMetadata
        Returns:
        requireAllMetadata

      • setRequireAllMetadata

        public void setRequireAllMetadata​(PropertyMetadata requireAllMetadata)

      • required

        public List required​(java.lang.String required)

      • getRequired

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

      • setRequired

        public void setRequired​(java.lang.String required)

      • getRequiredMetadata

        public PropertyMetadata getRequiredMetadata()
        Get requiredMetadata
        Returns:
        requiredMetadata

      • setRequiredMetadata

        public void setRequiredMetadata​(PropertyMetadata requiredMetadata)

      • requireInitialOnSharedChange

        public List requireInitialOnSharedChange​(java.lang.String requireInitialOnSharedChange)

      • getRequireInitialOnSharedChange

        public java.lang.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​(java.lang.String requireInitialOnSharedChange)

      • requireInitialOnSharedChangeMetadata

        public List requireInitialOnSharedChangeMetadata​(PropertyMetadata requireInitialOnSharedChangeMetadata)

      • getRequireInitialOnSharedChangeMetadata

        public PropertyMetadata getRequireInitialOnSharedChangeMetadata()
        Get requireInitialOnSharedChangeMetadata
        Returns:
        requireInitialOnSharedChangeMetadata

      • setRequireInitialOnSharedChangeMetadata

        public void setRequireInitialOnSharedChangeMetadata​(PropertyMetadata requireInitialOnSharedChangeMetadata)

      • senderRequired

        public List senderRequired​(java.lang.String senderRequired)

      • getSenderRequired

        public java.lang.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​(java.lang.String senderRequired)

      • senderRequiredMetadata

        public List senderRequiredMetadata​(PropertyMetadata senderRequiredMetadata)

      • getSenderRequiredMetadata

        public PropertyMetadata getSenderRequiredMetadata()
        Get senderRequiredMetadata
        Returns:
        senderRequiredMetadata

      • setSenderRequiredMetadata

        public void setSenderRequiredMetadata​(PropertyMetadata senderRequiredMetadata)

      • shared

        public List shared​(java.lang.String shared)

      • getShared

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

      • setShared

        public void setShared​(java.lang.String shared)

      • getSharedMetadata

        public PropertyMetadata getSharedMetadata()
        Get sharedMetadata
        Returns:
        sharedMetadata

      • setSharedMetadata

        public void setSharedMetadata​(PropertyMetadata sharedMetadata)

      • getSmartContractInformation

        public SmartContractInformation getSmartContractInformation()
        Get smartContractInformation
        Returns:
        smartContractInformation

      • setSmartContractInformation

        public void setSmartContractInformation​(SmartContractInformation smartContractInformation)

      • source

        public List source​(java.lang.String source)

      • getSource

        public java.lang.String getSource()
        Returns:
        source

      • setSource

        public void setSource​(java.lang.String source)

      • status

        public List status​(java.lang.String status)

      • getStatus

        public java.lang.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​(java.lang.String status)

      • getStatusMetadata

        public PropertyMetadata getStatusMetadata()
        Get statusMetadata
        Returns:
        statusMetadata

      • setStatusMetadata

        public void setStatusMetadata​(PropertyMetadata statusMetadata)

      • tabGroupLabels

        public List tabGroupLabels​(java.util.List<java.lang.String> tabGroupLabels)

      • addTabGroupLabelsItem

        public List addTabGroupLabelsItem​(java.lang.String tabGroupLabelsItem)

      • getTabGroupLabels

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

      • setTabGroupLabels

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

      • tabGroupLabelsMetadata

        public List tabGroupLabelsMetadata​(PropertyMetadata tabGroupLabelsMetadata)

      • getTabGroupLabelsMetadata

        public PropertyMetadata getTabGroupLabelsMetadata()
        Get tabGroupLabelsMetadata
        Returns:
        tabGroupLabelsMetadata

      • setTabGroupLabelsMetadata

        public void setTabGroupLabelsMetadata​(PropertyMetadata tabGroupLabelsMetadata)

      • tabId

        public List tabId​(java.lang.String tabId)

      • getTabId

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

      • setTabId

        public void setTabId​(java.lang.String tabId)

      • getTabIdMetadata

        public PropertyMetadata getTabIdMetadata()
        Get tabIdMetadata
        Returns:
        tabIdMetadata

      • setTabIdMetadata

        public void setTabIdMetadata​(PropertyMetadata tabIdMetadata)

      • tabLabel

        public List tabLabel​(java.lang.String tabLabel)

      • getTabLabel

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

      • setTabLabel

        public void setTabLabel​(java.lang.String tabLabel)

      • getTabLabelMetadata

        public PropertyMetadata getTabLabelMetadata()
        Get tabLabelMetadata
        Returns:
        tabLabelMetadata

      • setTabLabelMetadata

        public void setTabLabelMetadata​(PropertyMetadata tabLabelMetadata)

      • tabOrder

        public List tabOrder​(java.lang.String tabOrder)

      • getTabOrder

        public java.lang.String getTabOrder()
        Returns:
        tabOrder

      • setTabOrder

        public void setTabOrder​(java.lang.String tabOrder)

      • getTabOrderMetadata

        public PropertyMetadata getTabOrderMetadata()
        Get tabOrderMetadata
        Returns:
        tabOrderMetadata

      • setTabOrderMetadata

        public void setTabOrderMetadata​(PropertyMetadata tabOrderMetadata)

      • tabType

        public List tabType​(java.lang.String tabType)

      • getTabType

        public java.lang.String getTabType()
        Returns:
        tabType

      • setTabType

        public void setTabType​(java.lang.String tabType)

      • getTabTypeMetadata

        public PropertyMetadata getTabTypeMetadata()
        Get tabTypeMetadata
        Returns:
        tabTypeMetadata

      • setTabTypeMetadata

        public void setTabTypeMetadata​(PropertyMetadata tabTypeMetadata)

      • templateLocked

        public List templateLocked​(java.lang.String templateLocked)

      • getTemplateLocked

        public java.lang.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​(java.lang.String templateLocked)

      • templateLockedMetadata

        public List templateLockedMetadata​(PropertyMetadata templateLockedMetadata)

      • getTemplateLockedMetadata

        public PropertyMetadata getTemplateLockedMetadata()
        Get templateLockedMetadata
        Returns:
        templateLockedMetadata

      • setTemplateLockedMetadata

        public void setTemplateLockedMetadata​(PropertyMetadata templateLockedMetadata)

      • templateRequired

        public List templateRequired​(java.lang.String templateRequired)

      • getTemplateRequired

        public java.lang.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​(java.lang.String templateRequired)

      • templateRequiredMetadata

        public List templateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)

      • getTemplateRequiredMetadata

        public PropertyMetadata getTemplateRequiredMetadata()
        Get templateRequiredMetadata
        Returns:
        templateRequiredMetadata

      • setTemplateRequiredMetadata

        public void setTemplateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)

      • tooltip

        public List tooltip​(java.lang.String tooltip)

      • getTooltip

        public java.lang.String getTooltip()
        Returns:
        tooltip

      • setTooltip

        public void setTooltip​(java.lang.String tooltip)

      • getToolTipMetadata

        public PropertyMetadata getToolTipMetadata()
        Get toolTipMetadata
        Returns:
        toolTipMetadata

      • setToolTipMetadata

        public void setToolTipMetadata​(PropertyMetadata toolTipMetadata)

      • underline

        public List underline​(java.lang.String underline)

      • getUnderline

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

      • setUnderline

        public void setUnderline​(java.lang.String underline)

      • getUnderlineMetadata

        public PropertyMetadata getUnderlineMetadata()
        Get underlineMetadata
        Returns:
        underlineMetadata

      • setUnderlineMetadata

        public void setUnderlineMetadata​(PropertyMetadata underlineMetadata)

      • value

        public List value​(java.lang.String value)

      • getValue

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

      • setValue

        public void setValue​(java.lang.String value)

      • getValueMetadata

        public PropertyMetadata getValueMetadata()
        Get valueMetadata
        Returns:
        valueMetadata

      • setValueMetadata

        public void setValueMetadata​(PropertyMetadata valueMetadata)

      • width

        public List width​(java.lang.String width)

      • getWidth

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

      • setWidth

        public void setWidth​(java.lang.String width)

      • getWidthMetadata

        public PropertyMetadata getWidthMetadata()
        Get widthMetadata
        Returns:
        widthMetadata

      • setWidthMetadata

        public void setWidthMetadata​(PropertyMetadata widthMetadata)

      • xPosition

        public List xPosition​(java.lang.String xPosition)

      • getXPosition

        public java.lang.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​(java.lang.String xPosition)

      • getXPositionMetadata

        public PropertyMetadata getXPositionMetadata()
        Get xPositionMetadata
        Returns:
        xPositionMetadata

      • setXPositionMetadata

        public void setXPositionMetadata​(PropertyMetadata xPositionMetadata)

      • yPosition

        public List yPosition​(java.lang.String yPosition)

      • getYPosition

        public java.lang.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​(java.lang.String yPosition)

      • getYPositionMetadata

        public PropertyMetadata getYPositionMetadata()
        Get yPositionMetadata
        Returns:
        yPositionMetadata

      • setYPositionMetadata

        public void setYPositionMetadata​(PropertyMetadata yPositionMetadata)

      • equals

        public boolean equals​(java.lang.Object o)
        Overrides:
        equals in class java.lang.Object

      • hashCode

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

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object