Package com.docusign.esign.model

Class TabGroup

  • public class TabGroup
extends java.lang.Object
    TabGroup.

    • Constructor Detail

      • TabGroup

        public TabGroup()

    • Method Detail

      • anchorAllowWhiteSpaceInCharacters

        public TabGroup anchorAllowWhiteSpaceInCharacters​(java.lang.String anchorAllowWhiteSpaceInCharacters)
        anchorAllowWhiteSpaceInCharacters.
        Returns:
        TabGroup

      • getAnchorAllowWhiteSpaceInCharacters

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

      • setAnchorAllowWhiteSpaceInCharacters

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

      • anchorAllowWhiteSpaceInCharactersMetadata

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

      • getAnchorAllowWhiteSpaceInCharactersMetadata

        public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
        Get anchorAllowWhiteSpaceInCharactersMetadata.
        Returns:
        anchorAllowWhiteSpaceInCharactersMetadata

      • setAnchorAllowWhiteSpaceInCharactersMetadata

        public void setAnchorAllowWhiteSpaceInCharactersMetadata​(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
        setAnchorAllowWhiteSpaceInCharactersMetadata.

      • anchorCaseSensitive

        public TabGroup anchorCaseSensitive​(java.lang.String anchorCaseSensitive)
        anchorCaseSensitive.
        Returns:
        TabGroup

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

      • anchorCaseSensitiveMetadata

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

      • getAnchorCaseSensitiveMetadata

        public PropertyMetadata getAnchorCaseSensitiveMetadata()
        Get anchorCaseSensitiveMetadata.
        Returns:
        anchorCaseSensitiveMetadata

      • setAnchorCaseSensitiveMetadata

        public void setAnchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)
        setAnchorCaseSensitiveMetadata.

      • anchorHorizontalAlignment

        public TabGroup anchorHorizontalAlignment​(java.lang.String anchorHorizontalAlignment)
        anchorHorizontalAlignment.
        Returns:
        TabGroup

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

      • anchorHorizontalAlignmentMetadata

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

      • getAnchorHorizontalAlignmentMetadata

        public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
        Get anchorHorizontalAlignmentMetadata.
        Returns:
        anchorHorizontalAlignmentMetadata

      • setAnchorHorizontalAlignmentMetadata

        public void setAnchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)
        setAnchorHorizontalAlignmentMetadata.

      • anchorIgnoreIfNotPresent

        public TabGroup anchorIgnoreIfNotPresent​(java.lang.String anchorIgnoreIfNotPresent)
        anchorIgnoreIfNotPresent.
        Returns:
        TabGroup

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

      • anchorIgnoreIfNotPresentMetadata

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

      • getAnchorIgnoreIfNotPresentMetadata

        public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
        Get anchorIgnoreIfNotPresentMetadata.
        Returns:
        anchorIgnoreIfNotPresentMetadata

      • setAnchorIgnoreIfNotPresentMetadata

        public void setAnchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
        setAnchorIgnoreIfNotPresentMetadata.

      • anchorMatchWholeWord

        public TabGroup anchorMatchWholeWord​(java.lang.String anchorMatchWholeWord)
        anchorMatchWholeWord.
        Returns:
        TabGroup

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

      • anchorMatchWholeWordMetadata

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

      • getAnchorMatchWholeWordMetadata

        public PropertyMetadata getAnchorMatchWholeWordMetadata()
        Get anchorMatchWholeWordMetadata.
        Returns:
        anchorMatchWholeWordMetadata

      • setAnchorMatchWholeWordMetadata

        public void setAnchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)
        setAnchorMatchWholeWordMetadata.

      • anchorString

        public TabGroup anchorString​(java.lang.String anchorString)
        anchorString.
        Returns:
        TabGroup

      • getAnchorString

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

      • setAnchorString

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

      • anchorStringMetadata

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

      • getAnchorStringMetadata

        public PropertyMetadata getAnchorStringMetadata()
        Get anchorStringMetadata.
        Returns:
        anchorStringMetadata

      • setAnchorStringMetadata

        public void setAnchorStringMetadata​(PropertyMetadata anchorStringMetadata)
        setAnchorStringMetadata.

      • anchorTabProcessorVersion

        public TabGroup anchorTabProcessorVersion​(java.lang.String anchorTabProcessorVersion)
        anchorTabProcessorVersion.
        Returns:
        TabGroup

      • getAnchorTabProcessorVersion

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

      • setAnchorTabProcessorVersion

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

      • anchorTabProcessorVersionMetadata

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

      • getAnchorTabProcessorVersionMetadata

        public PropertyMetadata getAnchorTabProcessorVersionMetadata()
        Get anchorTabProcessorVersionMetadata.
        Returns:
        anchorTabProcessorVersionMetadata

      • setAnchorTabProcessorVersionMetadata

        public void setAnchorTabProcessorVersionMetadata​(PropertyMetadata anchorTabProcessorVersionMetadata)
        setAnchorTabProcessorVersionMetadata.

      • anchorUnits

        public TabGroup anchorUnits​(java.lang.String anchorUnits)
        anchorUnits.
        Returns:
        TabGroup

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

      • anchorUnitsMetadata

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

      • getAnchorUnitsMetadata

        public PropertyMetadata getAnchorUnitsMetadata()
        Get anchorUnitsMetadata.
        Returns:
        anchorUnitsMetadata

      • setAnchorUnitsMetadata

        public void setAnchorUnitsMetadata​(PropertyMetadata anchorUnitsMetadata)
        setAnchorUnitsMetadata.

      • anchorXOffset

        public TabGroup anchorXOffset​(java.lang.String anchorXOffset)
        anchorXOffset.
        Returns:
        TabGroup

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

      • anchorXOffsetMetadata

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

      • getAnchorXOffsetMetadata

        public PropertyMetadata getAnchorXOffsetMetadata()
        Get anchorXOffsetMetadata.
        Returns:
        anchorXOffsetMetadata

      • setAnchorXOffsetMetadata

        public void setAnchorXOffsetMetadata​(PropertyMetadata anchorXOffsetMetadata)
        setAnchorXOffsetMetadata.

      • anchorYOffset

        public TabGroup anchorYOffset​(java.lang.String anchorYOffset)
        anchorYOffset.
        Returns:
        TabGroup

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

      • anchorYOffsetMetadata

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

      • getAnchorYOffsetMetadata

        public PropertyMetadata getAnchorYOffsetMetadata()
        Get anchorYOffsetMetadata.
        Returns:
        anchorYOffsetMetadata

      • setAnchorYOffsetMetadata

        public void setAnchorYOffsetMetadata​(PropertyMetadata anchorYOffsetMetadata)
        setAnchorYOffsetMetadata.

      • conditionalParentLabel

        public TabGroup conditionalParentLabel​(java.lang.String conditionalParentLabel)
        conditionalParentLabel.
        Returns:
        TabGroup

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

      • conditionalParentLabelMetadata

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

      • getConditionalParentLabelMetadata

        public PropertyMetadata getConditionalParentLabelMetadata()
        Get conditionalParentLabelMetadata.
        Returns:
        conditionalParentLabelMetadata

      • setConditionalParentLabelMetadata

        public void setConditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)
        setConditionalParentLabelMetadata.

      • conditionalParentValue

        public TabGroup conditionalParentValue​(java.lang.String conditionalParentValue)
        conditionalParentValue.
        Returns:
        TabGroup

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

      • conditionalParentValueMetadata

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

      • getConditionalParentValueMetadata

        public PropertyMetadata getConditionalParentValueMetadata()
        Get conditionalParentValueMetadata.
        Returns:
        conditionalParentValueMetadata

      • setConditionalParentValueMetadata

        public void setConditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)
        setConditionalParentValueMetadata.

      • customTabId

        public TabGroup customTabId​(java.lang.String customTabId)
        customTabId.
        Returns:
        TabGroup

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

      • customTabIdMetadata

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

      • getCustomTabIdMetadata

        public PropertyMetadata getCustomTabIdMetadata()
        Get customTabIdMetadata.
        Returns:
        customTabIdMetadata

      • setCustomTabIdMetadata

        public void setCustomTabIdMetadata​(PropertyMetadata customTabIdMetadata)
        setCustomTabIdMetadata.

      • documentId

        public TabGroup documentId​(java.lang.String documentId)
        documentId.
        Returns:
        TabGroup

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

      • documentIdMetadata

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

      • getDocumentIdMetadata

        public PropertyMetadata getDocumentIdMetadata()
        Get documentIdMetadata.
        Returns:
        documentIdMetadata

      • setDocumentIdMetadata

        public void setDocumentIdMetadata​(PropertyMetadata documentIdMetadata)
        setDocumentIdMetadata.

      • errorDetails

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

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Get errorDetails.
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • formOrder

        public TabGroup formOrder​(java.lang.String formOrder)
        formOrder.
        Returns:
        TabGroup

      • getFormOrder

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

      • setFormOrder

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

      • formOrderMetadata

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

      • getFormOrderMetadata

        public PropertyMetadata getFormOrderMetadata()
        Get formOrderMetadata.
        Returns:
        formOrderMetadata

      • setFormOrderMetadata

        public void setFormOrderMetadata​(PropertyMetadata formOrderMetadata)
        setFormOrderMetadata.

      • formPageLabel

        public TabGroup formPageLabel​(java.lang.String formPageLabel)
        formPageLabel.
        Returns:
        TabGroup

      • getFormPageLabel

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

      • setFormPageLabel

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

      • formPageLabelMetadata

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

      • getFormPageLabelMetadata

        public PropertyMetadata getFormPageLabelMetadata()
        Get formPageLabelMetadata.
        Returns:
        formPageLabelMetadata

      • setFormPageLabelMetadata

        public void setFormPageLabelMetadata​(PropertyMetadata formPageLabelMetadata)
        setFormPageLabelMetadata.

      • formPageNumber

        public TabGroup formPageNumber​(java.lang.String formPageNumber)
        formPageNumber.
        Returns:
        TabGroup

      • getFormPageNumber

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

      • setFormPageNumber

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

      • formPageNumberMetadata

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

      • getFormPageNumberMetadata

        public PropertyMetadata getFormPageNumberMetadata()
        Get formPageNumberMetadata.
        Returns:
        formPageNumberMetadata

      • setFormPageNumberMetadata

        public void setFormPageNumberMetadata​(PropertyMetadata formPageNumberMetadata)
        setFormPageNumberMetadata.

      • groupLabel

        public TabGroup groupLabel​(java.lang.String groupLabel)
        groupLabel.
        Returns:
        TabGroup

      • getGroupLabel

        public java.lang.String getGroupLabel()
        .
        Returns:
        groupLabel

      • setGroupLabel

        public void setGroupLabel​(java.lang.String groupLabel)
        setGroupLabel.

      • groupLabelMetadata

        public TabGroup groupLabelMetadata​(PropertyMetadata groupLabelMetadata)
        groupLabelMetadata.
        Returns:
        TabGroup

      • getGroupLabelMetadata

        public PropertyMetadata getGroupLabelMetadata()
        Get groupLabelMetadata.
        Returns:
        groupLabelMetadata

      • setGroupLabelMetadata

        public void setGroupLabelMetadata​(PropertyMetadata groupLabelMetadata)
        setGroupLabelMetadata.

      • groupRule

        public TabGroup groupRule​(java.lang.String groupRule)
        groupRule.
        Returns:
        TabGroup

      • getGroupRule

        public java.lang.String getGroupRule()
        .
        Returns:
        groupRule

      • setGroupRule

        public void setGroupRule​(java.lang.String groupRule)
        setGroupRule.

      • groupRuleMetadata

        public TabGroup groupRuleMetadata​(PropertyMetadata groupRuleMetadata)
        groupRuleMetadata.
        Returns:
        TabGroup

      • getGroupRuleMetadata

        public PropertyMetadata getGroupRuleMetadata()
        Get groupRuleMetadata.
        Returns:
        groupRuleMetadata

      • setGroupRuleMetadata

        public void setGroupRuleMetadata​(PropertyMetadata groupRuleMetadata)
        setGroupRuleMetadata.

      • height

        public TabGroup height​(java.lang.String height)
        height.
        Returns:
        TabGroup

      • getHeight

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

      • setHeight

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

      • heightMetadata

        public TabGroup heightMetadata​(PropertyMetadata heightMetadata)
        heightMetadata.
        Returns:
        TabGroup

      • getHeightMetadata

        public PropertyMetadata getHeightMetadata()
        Get heightMetadata.
        Returns:
        heightMetadata

      • setHeightMetadata

        public void setHeightMetadata​(PropertyMetadata heightMetadata)
        setHeightMetadata.

      • maximumAllowed

        public TabGroup maximumAllowed​(java.lang.String maximumAllowed)
        maximumAllowed.
        Returns:
        TabGroup

      • getMaximumAllowed

        public java.lang.String getMaximumAllowed()
        .
        Returns:
        maximumAllowed

      • setMaximumAllowed

        public void setMaximumAllowed​(java.lang.String maximumAllowed)
        setMaximumAllowed.

      • maximumAllowedMetadata

        public TabGroup maximumAllowedMetadata​(PropertyMetadata maximumAllowedMetadata)
        maximumAllowedMetadata.
        Returns:
        TabGroup

      • getMaximumAllowedMetadata

        public PropertyMetadata getMaximumAllowedMetadata()
        Get maximumAllowedMetadata.
        Returns:
        maximumAllowedMetadata

      • setMaximumAllowedMetadata

        public void setMaximumAllowedMetadata​(PropertyMetadata maximumAllowedMetadata)
        setMaximumAllowedMetadata.

      • mergeField

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

      • getMergeField

        public MergeField getMergeField()
        Get mergeField.
        Returns:
        mergeField

      • setMergeField

        public void setMergeField​(MergeField mergeField)
        setMergeField.

      • mergeFieldXml

        public TabGroup mergeFieldXml​(java.lang.String mergeFieldXml)
        mergeFieldXml.
        Returns:
        TabGroup

      • getMergeFieldXml

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

      • setMergeFieldXml

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

      • minimumRequired

        public TabGroup minimumRequired​(java.lang.String minimumRequired)
        minimumRequired.
        Returns:
        TabGroup

      • getMinimumRequired

        public java.lang.String getMinimumRequired()
        .
        Returns:
        minimumRequired

      • setMinimumRequired

        public void setMinimumRequired​(java.lang.String minimumRequired)
        setMinimumRequired.

      • minimumRequiredMetadata

        public TabGroup minimumRequiredMetadata​(PropertyMetadata minimumRequiredMetadata)
        minimumRequiredMetadata.
        Returns:
        TabGroup

      • getMinimumRequiredMetadata

        public PropertyMetadata getMinimumRequiredMetadata()
        Get minimumRequiredMetadata.
        Returns:
        minimumRequiredMetadata

      • setMinimumRequiredMetadata

        public void setMinimumRequiredMetadata​(PropertyMetadata minimumRequiredMetadata)
        setMinimumRequiredMetadata.

      • pageNumber

        public TabGroup pageNumber​(java.lang.String pageNumber)
        pageNumber.
        Returns:
        TabGroup

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

      • pageNumberMetadata

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

      • getPageNumberMetadata

        public PropertyMetadata getPageNumberMetadata()
        Get pageNumberMetadata.
        Returns:
        pageNumberMetadata

      • setPageNumberMetadata

        public void setPageNumberMetadata​(PropertyMetadata pageNumberMetadata)
        setPageNumberMetadata.

      • recipientId

        public TabGroup recipientId​(java.lang.String recipientId)
        recipientId.
        Returns:
        TabGroup

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

      • recipientIdGuid

        public TabGroup recipientIdGuid​(java.lang.String recipientIdGuid)
        recipientIdGuid.
        Returns:
        TabGroup

      • getRecipientIdGuid

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

      • setRecipientIdGuid

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

      • recipientIdGuidMetadata

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

      • getRecipientIdGuidMetadata

        public PropertyMetadata getRecipientIdGuidMetadata()
        Get recipientIdGuidMetadata.
        Returns:
        recipientIdGuidMetadata

      • setRecipientIdGuidMetadata

        public void setRecipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)
        setRecipientIdGuidMetadata.

      • recipientIdMetadata

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

      • getRecipientIdMetadata

        public PropertyMetadata getRecipientIdMetadata()
        Get recipientIdMetadata.
        Returns:
        recipientIdMetadata

      • setRecipientIdMetadata

        public void setRecipientIdMetadata​(PropertyMetadata recipientIdMetadata)
        setRecipientIdMetadata.

      • smartContractInformation

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

      • getSmartContractInformation

        public SmartContractInformation getSmartContractInformation()
        Get smartContractInformation.
        Returns:
        smartContractInformation

      • setSmartContractInformation

        public void setSmartContractInformation​(SmartContractInformation smartContractInformation)
        setSmartContractInformation.

      • source

        public TabGroup source​(java.lang.String source)
        source.
        Returns:
        TabGroup

      • getSource

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

      • setSource

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

      • status

        public TabGroup status​(java.lang.String status)
        status.
        Returns:
        TabGroup

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

      • statusMetadata

        public TabGroup statusMetadata​(PropertyMetadata statusMetadata)
        statusMetadata.
        Returns:
        TabGroup

      • getStatusMetadata

        public PropertyMetadata getStatusMetadata()
        Get statusMetadata.
        Returns:
        statusMetadata

      • setStatusMetadata

        public void setStatusMetadata​(PropertyMetadata statusMetadata)
        setStatusMetadata.

      • tabGroupLabels

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

      • addTabGroupLabelsItem

        public TabGroup addTabGroupLabelsItem​(java.lang.String tabGroupLabelsItem)
        addTabGroupLabelsItem.
        Returns:
        TabGroup

      • getTabGroupLabels

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

      • setTabGroupLabels

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

      • tabGroupLabelsMetadata

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

      • getTabGroupLabelsMetadata

        public PropertyMetadata getTabGroupLabelsMetadata()
        Get tabGroupLabelsMetadata.
        Returns:
        tabGroupLabelsMetadata

      • setTabGroupLabelsMetadata

        public void setTabGroupLabelsMetadata​(PropertyMetadata tabGroupLabelsMetadata)
        setTabGroupLabelsMetadata.

      • tabId

        public TabGroup tabId​(java.lang.String tabId)
        tabId.
        Returns:
        TabGroup

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

      • getTabIdMetadata

        public PropertyMetadata getTabIdMetadata()
        Get tabIdMetadata.
        Returns:
        tabIdMetadata

      • setTabIdMetadata

        public void setTabIdMetadata​(PropertyMetadata tabIdMetadata)
        setTabIdMetadata.

      • tabOrder

        public TabGroup tabOrder​(java.lang.String tabOrder)
        tabOrder.
        Returns:
        TabGroup

      • getTabOrder

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

      • setTabOrder

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

      • tabOrderMetadata

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

      • getTabOrderMetadata

        public PropertyMetadata getTabOrderMetadata()
        Get tabOrderMetadata.
        Returns:
        tabOrderMetadata

      • setTabOrderMetadata

        public void setTabOrderMetadata​(PropertyMetadata tabOrderMetadata)
        setTabOrderMetadata.

      • tabScope

        public TabGroup tabScope​(java.lang.String tabScope)
        tabScope.
        Returns:
        TabGroup

      • getTabScope

        public java.lang.String getTabScope()
        .
        Returns:
        tabScope

      • setTabScope

        public void setTabScope​(java.lang.String tabScope)
        setTabScope.

      • tabScopeMetadata

        public TabGroup tabScopeMetadata​(PropertyMetadata tabScopeMetadata)
        tabScopeMetadata.
        Returns:
        TabGroup

      • getTabScopeMetadata

        public PropertyMetadata getTabScopeMetadata()
        Get tabScopeMetadata.
        Returns:
        tabScopeMetadata

      • setTabScopeMetadata

        public void setTabScopeMetadata​(PropertyMetadata tabScopeMetadata)
        setTabScopeMetadata.

      • tabType

        public TabGroup tabType​(java.lang.String tabType)
        tabType.
        Returns:
        TabGroup

      • getTabType

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

      • setTabType

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

      • tabTypeMetadata

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

      • getTabTypeMetadata

        public PropertyMetadata getTabTypeMetadata()
        Get tabTypeMetadata.
        Returns:
        tabTypeMetadata

      • setTabTypeMetadata

        public void setTabTypeMetadata​(PropertyMetadata tabTypeMetadata)
        setTabTypeMetadata.

      • templateLocked

        public TabGroup templateLocked​(java.lang.String templateLocked)
        templateLocked.
        Returns:
        TabGroup

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

      • templateLockedMetadata

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

      • getTemplateLockedMetadata

        public PropertyMetadata getTemplateLockedMetadata()
        Get templateLockedMetadata.
        Returns:
        templateLockedMetadata

      • setTemplateLockedMetadata

        public void setTemplateLockedMetadata​(PropertyMetadata templateLockedMetadata)
        setTemplateLockedMetadata.

      • templateRequired

        public TabGroup templateRequired​(java.lang.String templateRequired)
        templateRequired.
        Returns:
        TabGroup

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

      • templateRequiredMetadata

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

      • getTemplateRequiredMetadata

        public PropertyMetadata getTemplateRequiredMetadata()
        Get templateRequiredMetadata.
        Returns:
        templateRequiredMetadata

      • setTemplateRequiredMetadata

        public void setTemplateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)
        setTemplateRequiredMetadata.

      • tooltip

        public TabGroup tooltip​(java.lang.String tooltip)
        tooltip.
        Returns:
        TabGroup

      • getTooltip

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

      • setTooltip

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

      • toolTipMetadata

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

      • getToolTipMetadata

        public PropertyMetadata getToolTipMetadata()
        Get toolTipMetadata.
        Returns:
        toolTipMetadata

      • setToolTipMetadata

        public void setToolTipMetadata​(PropertyMetadata toolTipMetadata)
        setToolTipMetadata.

      • validationMessage

        public TabGroup validationMessage​(java.lang.String validationMessage)
        validationMessage.
        Returns:
        TabGroup

      • getValidationMessage

        public java.lang.String getValidationMessage()
        The message displayed if the custom tab fails input validation (either custom of embedded)..
        Returns:
        validationMessage

      • setValidationMessage

        public void setValidationMessage​(java.lang.String validationMessage)
        setValidationMessage.

      • validationMessageMetadata

        public TabGroup validationMessageMetadata​(PropertyMetadata validationMessageMetadata)
        validationMessageMetadata.
        Returns:
        TabGroup

      • getValidationMessageMetadata

        public PropertyMetadata getValidationMessageMetadata()
        Get validationMessageMetadata.
        Returns:
        validationMessageMetadata

      • setValidationMessageMetadata

        public void setValidationMessageMetadata​(PropertyMetadata validationMessageMetadata)
        setValidationMessageMetadata.

      • width

        public TabGroup width​(java.lang.String width)
        width.
        Returns:
        TabGroup

      • getWidth

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

      • setWidth

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

      • getWidthMetadata

        public PropertyMetadata getWidthMetadata()
        Get widthMetadata.
        Returns:
        widthMetadata

      • setWidthMetadata

        public void setWidthMetadata​(PropertyMetadata widthMetadata)
        setWidthMetadata.

      • xPosition

        public TabGroup xPosition​(java.lang.String xPosition)
        xPosition.
        Returns:
        TabGroup

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

      • xPositionMetadata

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

      • getXPositionMetadata

        public PropertyMetadata getXPositionMetadata()
        Get xPositionMetadata.
        Returns:
        xPositionMetadata

      • setXPositionMetadata

        public void setXPositionMetadata​(PropertyMetadata xPositionMetadata)
        setXPositionMetadata.

      • yPosition

        public TabGroup yPosition​(java.lang.String yPosition)
        yPosition.
        Returns:
        TabGroup

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

      • yPositionMetadata

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

      • getYPositionMetadata

        public PropertyMetadata getYPositionMetadata()
        Get yPositionMetadata.
        Returns:
        yPositionMetadata

      • setYPositionMetadata

        public void setYPositionMetadata​(PropertyMetadata yPositionMetadata)
        setYPositionMetadata.

      • equals

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

      • hashCode

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

      • toString

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