Package com.docusign.esign.model

Class Ssn

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

    • Constructor Detail

      • Ssn

        public Ssn()

    • Method Detail

      • anchorAllowWhiteSpaceInCharacters

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

      • getAnchorAllowWhiteSpaceInCharacters

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

      • setAnchorAllowWhiteSpaceInCharacters

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

      • anchorAllowWhiteSpaceInCharactersMetadata

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

      • getAnchorAllowWhiteSpaceInCharactersMetadata

        public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
        Get anchorAllowWhiteSpaceInCharactersMetadata.
        Returns:
        anchorAllowWhiteSpaceInCharactersMetadata

      • setAnchorAllowWhiteSpaceInCharactersMetadata

        public void setAnchorAllowWhiteSpaceInCharactersMetadata​(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
        setAnchorAllowWhiteSpaceInCharactersMetadata.

      • anchorCaseSensitive

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

      • 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 Ssn anchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)
        anchorCaseSensitiveMetadata.
        Returns:
        Ssn

      • getAnchorCaseSensitiveMetadata

        public PropertyMetadata getAnchorCaseSensitiveMetadata()
        Get anchorCaseSensitiveMetadata.
        Returns:
        anchorCaseSensitiveMetadata

      • setAnchorCaseSensitiveMetadata

        public void setAnchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)
        setAnchorCaseSensitiveMetadata.

      • anchorHorizontalAlignment

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

      • 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 Ssn anchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)
        anchorHorizontalAlignmentMetadata.
        Returns:
        Ssn

      • getAnchorHorizontalAlignmentMetadata

        public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
        Get anchorHorizontalAlignmentMetadata.
        Returns:
        anchorHorizontalAlignmentMetadata

      • setAnchorHorizontalAlignmentMetadata

        public void setAnchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)
        setAnchorHorizontalAlignmentMetadata.

      • anchorIgnoreIfNotPresent

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

      • 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 Ssn anchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
        anchorIgnoreIfNotPresentMetadata.
        Returns:
        Ssn

      • getAnchorIgnoreIfNotPresentMetadata

        public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
        Get anchorIgnoreIfNotPresentMetadata.
        Returns:
        anchorIgnoreIfNotPresentMetadata

      • setAnchorIgnoreIfNotPresentMetadata

        public void setAnchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
        setAnchorIgnoreIfNotPresentMetadata.

      • anchorMatchWholeWord

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

      • 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 Ssn anchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)
        anchorMatchWholeWordMetadata.
        Returns:
        Ssn

      • getAnchorMatchWholeWordMetadata

        public PropertyMetadata getAnchorMatchWholeWordMetadata()
        Get anchorMatchWholeWordMetadata.
        Returns:
        anchorMatchWholeWordMetadata

      • setAnchorMatchWholeWordMetadata

        public void setAnchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)
        setAnchorMatchWholeWordMetadata.

      • anchorString

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

      • 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 Ssn anchorStringMetadata​(PropertyMetadata anchorStringMetadata)
        anchorStringMetadata.
        Returns:
        Ssn

      • getAnchorStringMetadata

        public PropertyMetadata getAnchorStringMetadata()
        Get anchorStringMetadata.
        Returns:
        anchorStringMetadata

      • setAnchorStringMetadata

        public void setAnchorStringMetadata​(PropertyMetadata anchorStringMetadata)
        setAnchorStringMetadata.

      • anchorTabProcessorVersion

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

      • getAnchorTabProcessorVersion

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

      • setAnchorTabProcessorVersion

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

      • anchorTabProcessorVersionMetadata

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

      • getAnchorTabProcessorVersionMetadata

        public PropertyMetadata getAnchorTabProcessorVersionMetadata()
        Get anchorTabProcessorVersionMetadata.
        Returns:
        anchorTabProcessorVersionMetadata

      • setAnchorTabProcessorVersionMetadata

        public void setAnchorTabProcessorVersionMetadata​(PropertyMetadata anchorTabProcessorVersionMetadata)
        setAnchorTabProcessorVersionMetadata.

      • anchorUnits

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

      • 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 Ssn anchorUnitsMetadata​(PropertyMetadata anchorUnitsMetadata)
        anchorUnitsMetadata.
        Returns:
        Ssn

      • getAnchorUnitsMetadata

        public PropertyMetadata getAnchorUnitsMetadata()
        Get anchorUnitsMetadata.
        Returns:
        anchorUnitsMetadata

      • setAnchorUnitsMetadata

        public void setAnchorUnitsMetadata​(PropertyMetadata anchorUnitsMetadata)
        setAnchorUnitsMetadata.

      • anchorXOffset

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

      • 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 Ssn anchorXOffsetMetadata​(PropertyMetadata anchorXOffsetMetadata)
        anchorXOffsetMetadata.
        Returns:
        Ssn

      • getAnchorXOffsetMetadata

        public PropertyMetadata getAnchorXOffsetMetadata()
        Get anchorXOffsetMetadata.
        Returns:
        anchorXOffsetMetadata

      • setAnchorXOffsetMetadata

        public void setAnchorXOffsetMetadata​(PropertyMetadata anchorXOffsetMetadata)
        setAnchorXOffsetMetadata.

      • anchorYOffset

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

      • 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 Ssn anchorYOffsetMetadata​(PropertyMetadata anchorYOffsetMetadata)
        anchorYOffsetMetadata.
        Returns:
        Ssn

      • getAnchorYOffsetMetadata

        public PropertyMetadata getAnchorYOffsetMetadata()
        Get anchorYOffsetMetadata.
        Returns:
        anchorYOffsetMetadata

      • setAnchorYOffsetMetadata

        public void setAnchorYOffsetMetadata​(PropertyMetadata anchorYOffsetMetadata)
        setAnchorYOffsetMetadata.

      • bold

        public Ssn bold​(java.lang.String bold)
        bold.
        Returns:
        Ssn

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

      • boldMetadata

        public Ssn boldMetadata​(PropertyMetadata boldMetadata)
        boldMetadata.
        Returns:
        Ssn

      • getBoldMetadata

        public PropertyMetadata getBoldMetadata()
        Get boldMetadata.
        Returns:
        boldMetadata

      • setBoldMetadata

        public void setBoldMetadata​(PropertyMetadata boldMetadata)
        setBoldMetadata.

      • concealValueOnDocument

        public Ssn concealValueOnDocument​(java.lang.String concealValueOnDocument)
        concealValueOnDocument.
        Returns:
        Ssn

      • getConcealValueOnDocument

        public java.lang.String getConcealValueOnDocument()
        When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes..
        Returns:
        concealValueOnDocument

      • setConcealValueOnDocument

        public void setConcealValueOnDocument​(java.lang.String concealValueOnDocument)
        setConcealValueOnDocument.

      • concealValueOnDocumentMetadata

        public Ssn concealValueOnDocumentMetadata​(PropertyMetadata concealValueOnDocumentMetadata)
        concealValueOnDocumentMetadata.
        Returns:
        Ssn

      • getConcealValueOnDocumentMetadata

        public PropertyMetadata getConcealValueOnDocumentMetadata()
        Get concealValueOnDocumentMetadata.
        Returns:
        concealValueOnDocumentMetadata

      • setConcealValueOnDocumentMetadata

        public void setConcealValueOnDocumentMetadata​(PropertyMetadata concealValueOnDocumentMetadata)
        setConcealValueOnDocumentMetadata.

      • conditionalParentLabel

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

      • 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 Ssn conditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)
        conditionalParentLabelMetadata.
        Returns:
        Ssn

      • getConditionalParentLabelMetadata

        public PropertyMetadata getConditionalParentLabelMetadata()
        Get conditionalParentLabelMetadata.
        Returns:
        conditionalParentLabelMetadata

      • setConditionalParentLabelMetadata

        public void setConditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)
        setConditionalParentLabelMetadata.

      • conditionalParentValue

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

      • 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 Ssn conditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)
        conditionalParentValueMetadata.
        Returns:
        Ssn

      • getConditionalParentValueMetadata

        public PropertyMetadata getConditionalParentValueMetadata()
        Get conditionalParentValueMetadata.
        Returns:
        conditionalParentValueMetadata

      • setConditionalParentValueMetadata

        public void setConditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)
        setConditionalParentValueMetadata.

      • customTabId

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

      • 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 Ssn customTabIdMetadata​(PropertyMetadata customTabIdMetadata)
        customTabIdMetadata.
        Returns:
        Ssn

      • getCustomTabIdMetadata

        public PropertyMetadata getCustomTabIdMetadata()
        Get customTabIdMetadata.
        Returns:
        customTabIdMetadata

      • setCustomTabIdMetadata

        public void setCustomTabIdMetadata​(PropertyMetadata customTabIdMetadata)
        setCustomTabIdMetadata.

      • disableAutoSize

        public Ssn disableAutoSize​(java.lang.String disableAutoSize)
        disableAutoSize.
        Returns:
        Ssn

      • getDisableAutoSize

        public java.lang.String getDisableAutoSize()
        When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes..
        Returns:
        disableAutoSize

      • setDisableAutoSize

        public void setDisableAutoSize​(java.lang.String disableAutoSize)
        setDisableAutoSize.

      • disableAutoSizeMetadata

        public Ssn disableAutoSizeMetadata​(PropertyMetadata disableAutoSizeMetadata)
        disableAutoSizeMetadata.
        Returns:
        Ssn

      • getDisableAutoSizeMetadata

        public PropertyMetadata getDisableAutoSizeMetadata()
        Get disableAutoSizeMetadata.
        Returns:
        disableAutoSizeMetadata

      • setDisableAutoSizeMetadata

        public void setDisableAutoSizeMetadata​(PropertyMetadata disableAutoSizeMetadata)
        setDisableAutoSizeMetadata.

      • documentId

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

      • 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 Ssn documentIdMetadata​(PropertyMetadata documentIdMetadata)
        documentIdMetadata.
        Returns:
        Ssn

      • getDocumentIdMetadata

        public PropertyMetadata getDocumentIdMetadata()
        Get documentIdMetadata.
        Returns:
        documentIdMetadata

      • setDocumentIdMetadata

        public void setDocumentIdMetadata​(PropertyMetadata documentIdMetadata)
        setDocumentIdMetadata.

      • errorDetails

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

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Get errorDetails.
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • font

        public Ssn font​(java.lang.String font)
        font.
        Returns:
        Ssn

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

      • fontColor

        public Ssn fontColor​(java.lang.String fontColor)
        fontColor.
        Returns:
        Ssn

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

      • fontColorMetadata

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

      • getFontColorMetadata

        public PropertyMetadata getFontColorMetadata()
        Get fontColorMetadata.
        Returns:
        fontColorMetadata

      • setFontColorMetadata

        public void setFontColorMetadata​(PropertyMetadata fontColorMetadata)
        setFontColorMetadata.

      • fontMetadata

        public Ssn fontMetadata​(PropertyMetadata fontMetadata)
        fontMetadata.
        Returns:
        Ssn

      • getFontMetadata

        public PropertyMetadata getFontMetadata()
        Get fontMetadata.
        Returns:
        fontMetadata

      • setFontMetadata

        public void setFontMetadata​(PropertyMetadata fontMetadata)
        setFontMetadata.

      • fontSize

        public Ssn fontSize​(java.lang.String fontSize)
        fontSize.
        Returns:
        Ssn

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

      • fontSizeMetadata

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

      • getFontSizeMetadata

        public PropertyMetadata getFontSizeMetadata()
        Get fontSizeMetadata.
        Returns:
        fontSizeMetadata

      • setFontSizeMetadata

        public void setFontSizeMetadata​(PropertyMetadata fontSizeMetadata)
        setFontSizeMetadata.

      • formOrder

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

      • getFormOrder

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

      • setFormOrder

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

      • formOrderMetadata

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

      • getFormOrderMetadata

        public PropertyMetadata getFormOrderMetadata()
        Get formOrderMetadata.
        Returns:
        formOrderMetadata

      • setFormOrderMetadata

        public void setFormOrderMetadata​(PropertyMetadata formOrderMetadata)
        setFormOrderMetadata.

      • formPageLabel

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

      • getFormPageLabel

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

      • setFormPageLabel

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

      • formPageLabelMetadata

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

      • getFormPageLabelMetadata

        public PropertyMetadata getFormPageLabelMetadata()
        Get formPageLabelMetadata.
        Returns:
        formPageLabelMetadata

      • setFormPageLabelMetadata

        public void setFormPageLabelMetadata​(PropertyMetadata formPageLabelMetadata)
        setFormPageLabelMetadata.

      • formPageNumber

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

      • getFormPageNumber

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

      • setFormPageNumber

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

      • formPageNumberMetadata

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

      • getFormPageNumberMetadata

        public PropertyMetadata getFormPageNumberMetadata()
        Get formPageNumberMetadata.
        Returns:
        formPageNumberMetadata

      • setFormPageNumberMetadata

        public void setFormPageNumberMetadata​(PropertyMetadata formPageNumberMetadata)
        setFormPageNumberMetadata.

      • height

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

      • 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 Ssn heightMetadata​(PropertyMetadata heightMetadata)
        heightMetadata.
        Returns:
        Ssn

      • getHeightMetadata

        public PropertyMetadata getHeightMetadata()
        Get heightMetadata.
        Returns:
        heightMetadata

      • setHeightMetadata

        public void setHeightMetadata​(PropertyMetadata heightMetadata)
        setHeightMetadata.

      • italic

        public Ssn italic​(java.lang.String italic)
        italic.
        Returns:
        Ssn

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

      • italicMetadata

        public Ssn italicMetadata​(PropertyMetadata italicMetadata)
        italicMetadata.
        Returns:
        Ssn

      • getItalicMetadata

        public PropertyMetadata getItalicMetadata()
        Get italicMetadata.
        Returns:
        italicMetadata

      • setItalicMetadata

        public void setItalicMetadata​(PropertyMetadata italicMetadata)
        setItalicMetadata.

      • localePolicy

        public Ssn localePolicy​(LocalePolicyTab localePolicy)
        localePolicy.
        Returns:
        Ssn

      • getLocalePolicy

        public LocalePolicyTab getLocalePolicy()
        Get localePolicy.
        Returns:
        localePolicy

      • setLocalePolicy

        public void setLocalePolicy​(LocalePolicyTab localePolicy)
        setLocalePolicy.

      • locked

        public Ssn locked​(java.lang.String locked)
        locked.
        Returns:
        Ssn

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

      • lockedMetadata

        public Ssn lockedMetadata​(PropertyMetadata lockedMetadata)
        lockedMetadata.
        Returns:
        Ssn

      • getLockedMetadata

        public PropertyMetadata getLockedMetadata()
        Get lockedMetadata.
        Returns:
        lockedMetadata

      • setLockedMetadata

        public void setLockedMetadata​(PropertyMetadata lockedMetadata)
        setLockedMetadata.

      • maxLength

        public Ssn maxLength​(java.lang.String maxLength)
        maxLength.
        Returns:
        Ssn

      • getMaxLength

        public java.lang.String getMaxLength()
        An optional value that describes the maximum length of the property when the property is a string..
        Returns:
        maxLength

      • setMaxLength

        public void setMaxLength​(java.lang.String maxLength)
        setMaxLength.

      • maxLengthMetadata

        public Ssn maxLengthMetadata​(PropertyMetadata maxLengthMetadata)
        maxLengthMetadata.
        Returns:
        Ssn

      • getMaxLengthMetadata

        public PropertyMetadata getMaxLengthMetadata()
        Get maxLengthMetadata.
        Returns:
        maxLengthMetadata

      • setMaxLengthMetadata

        public void setMaxLengthMetadata​(PropertyMetadata maxLengthMetadata)
        setMaxLengthMetadata.

      • mergeField

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

      • getMergeField

        public MergeField getMergeField()
        Get mergeField.
        Returns:
        mergeField

      • setMergeField

        public void setMergeField​(MergeField mergeField)
        setMergeField.

      • mergeFieldXml

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

      • getMergeFieldXml

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

      • setMergeFieldXml

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

      • name

        public Ssn name​(java.lang.String name)
        name.
        Returns:
        Ssn

      • getName

        public java.lang.String getName()
        Specifies the tool tip text for the tab..
        Returns:
        name

      • setName

        public void setName​(java.lang.String name)
        setName.

      • nameMetadata

        public Ssn nameMetadata​(PropertyMetadata nameMetadata)
        nameMetadata.
        Returns:
        Ssn

      • getNameMetadata

        public PropertyMetadata getNameMetadata()
        Get nameMetadata.
        Returns:
        nameMetadata

      • setNameMetadata

        public void setNameMetadata​(PropertyMetadata nameMetadata)
        setNameMetadata.

      • originalValue

        public Ssn originalValue​(java.lang.String originalValue)
        originalValue.
        Returns:
        Ssn

      • getOriginalValue

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

      • setOriginalValue

        public void setOriginalValue​(java.lang.String originalValue)
        setOriginalValue.

      • originalValueMetadata

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

      • getOriginalValueMetadata

        public PropertyMetadata getOriginalValueMetadata()
        Get originalValueMetadata.
        Returns:
        originalValueMetadata

      • setOriginalValueMetadata

        public void setOriginalValueMetadata​(PropertyMetadata originalValueMetadata)
        setOriginalValueMetadata.

      • pageNumber

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

      • 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 Ssn pageNumberMetadata​(PropertyMetadata pageNumberMetadata)
        pageNumberMetadata.
        Returns:
        Ssn

      • getPageNumberMetadata

        public PropertyMetadata getPageNumberMetadata()
        Get pageNumberMetadata.
        Returns:
        pageNumberMetadata

      • setPageNumberMetadata

        public void setPageNumberMetadata​(PropertyMetadata pageNumberMetadata)
        setPageNumberMetadata.

      • recipientId

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

      • 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 Ssn recipientIdGuid​(java.lang.String recipientIdGuid)
        recipientIdGuid.
        Returns:
        Ssn

      • getRecipientIdGuid

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

      • setRecipientIdGuid

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

      • recipientIdGuidMetadata

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

      • getRecipientIdGuidMetadata

        public PropertyMetadata getRecipientIdGuidMetadata()
        Get recipientIdGuidMetadata.
        Returns:
        recipientIdGuidMetadata

      • setRecipientIdGuidMetadata

        public void setRecipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)
        setRecipientIdGuidMetadata.

      • recipientIdMetadata

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

      • getRecipientIdMetadata

        public PropertyMetadata getRecipientIdMetadata()
        Get recipientIdMetadata.
        Returns:
        recipientIdMetadata

      • setRecipientIdMetadata

        public void setRecipientIdMetadata​(PropertyMetadata recipientIdMetadata)
        setRecipientIdMetadata.

      • requireAll

        public Ssn requireAll​(java.lang.String requireAll)
        requireAll.
        Returns:
        Ssn

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

      • requireAllMetadata

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

      • getRequireAllMetadata

        public PropertyMetadata getRequireAllMetadata()
        Get requireAllMetadata.
        Returns:
        requireAllMetadata

      • setRequireAllMetadata

        public void setRequireAllMetadata​(PropertyMetadata requireAllMetadata)
        setRequireAllMetadata.

      • required

        public Ssn required​(java.lang.String required)
        required.
        Returns:
        Ssn

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

      • requiredMetadata

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

      • getRequiredMetadata

        public PropertyMetadata getRequiredMetadata()
        Get requiredMetadata.
        Returns:
        requiredMetadata

      • setRequiredMetadata

        public void setRequiredMetadata​(PropertyMetadata requiredMetadata)
        setRequiredMetadata.

      • requireInitialOnSharedChange

        public Ssn requireInitialOnSharedChange​(java.lang.String requireInitialOnSharedChange)
        requireInitialOnSharedChange.
        Returns:
        Ssn

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

      • requireInitialOnSharedChangeMetadata

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

      • getRequireInitialOnSharedChangeMetadata

        public PropertyMetadata getRequireInitialOnSharedChangeMetadata()
        Get requireInitialOnSharedChangeMetadata.
        Returns:
        requireInitialOnSharedChangeMetadata

      • setRequireInitialOnSharedChangeMetadata

        public void setRequireInitialOnSharedChangeMetadata​(PropertyMetadata requireInitialOnSharedChangeMetadata)
        setRequireInitialOnSharedChangeMetadata.

      • senderRequired

        public Ssn senderRequired​(java.lang.String senderRequired)
        senderRequired.
        Returns:
        Ssn

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

      • senderRequiredMetadata

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

      • getSenderRequiredMetadata

        public PropertyMetadata getSenderRequiredMetadata()
        Get senderRequiredMetadata.
        Returns:
        senderRequiredMetadata

      • setSenderRequiredMetadata

        public void setSenderRequiredMetadata​(PropertyMetadata senderRequiredMetadata)
        setSenderRequiredMetadata.

      • shared

        public Ssn shared​(java.lang.String shared)
        shared.
        Returns:
        Ssn

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

      • sharedMetadata

        public Ssn sharedMetadata​(PropertyMetadata sharedMetadata)
        sharedMetadata.
        Returns:
        Ssn

      • getSharedMetadata

        public PropertyMetadata getSharedMetadata()
        Get sharedMetadata.
        Returns:
        sharedMetadata

      • setSharedMetadata

        public void setSharedMetadata​(PropertyMetadata sharedMetadata)
        setSharedMetadata.

      • shareToRecipients

        public Ssn shareToRecipients​(java.lang.String shareToRecipients)
        shareToRecipients.
        Returns:
        Ssn

      • getShareToRecipients

        public java.lang.String getShareToRecipients()
        .
        Returns:
        shareToRecipients

      • setShareToRecipients

        public void setShareToRecipients​(java.lang.String shareToRecipients)
        setShareToRecipients.

      • shareToRecipientsMetadata

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

      • getShareToRecipientsMetadata

        public PropertyMetadata getShareToRecipientsMetadata()
        Get shareToRecipientsMetadata.
        Returns:
        shareToRecipientsMetadata

      • setShareToRecipientsMetadata

        public void setShareToRecipientsMetadata​(PropertyMetadata shareToRecipientsMetadata)
        setShareToRecipientsMetadata.

      • smartContractInformation

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

      • getSmartContractInformation

        public SmartContractInformation getSmartContractInformation()
        Get smartContractInformation.
        Returns:
        smartContractInformation

      • setSmartContractInformation

        public void setSmartContractInformation​(SmartContractInformation smartContractInformation)
        setSmartContractInformation.

      • source

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

      • getSource

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

      • setSource

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

      • status

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

      • 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 Ssn statusMetadata​(PropertyMetadata statusMetadata)
        statusMetadata.
        Returns:
        Ssn

      • getStatusMetadata

        public PropertyMetadata getStatusMetadata()
        Get statusMetadata.
        Returns:
        statusMetadata

      • setStatusMetadata

        public void setStatusMetadata​(PropertyMetadata statusMetadata)
        setStatusMetadata.

      • tabGroupLabels

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

      • addTabGroupLabelsItem

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

      • 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 Ssn tabGroupLabelsMetadata​(PropertyMetadata tabGroupLabelsMetadata)
        tabGroupLabelsMetadata.
        Returns:
        Ssn

      • getTabGroupLabelsMetadata

        public PropertyMetadata getTabGroupLabelsMetadata()
        Get tabGroupLabelsMetadata.
        Returns:
        tabGroupLabelsMetadata

      • setTabGroupLabelsMetadata

        public void setTabGroupLabelsMetadata​(PropertyMetadata tabGroupLabelsMetadata)
        setTabGroupLabelsMetadata.

      • tabId

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

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

      • tabIdMetadata

        public Ssn tabIdMetadata​(PropertyMetadata tabIdMetadata)
        tabIdMetadata.
        Returns:
        Ssn

      • getTabIdMetadata

        public PropertyMetadata getTabIdMetadata()
        Get tabIdMetadata.
        Returns:
        tabIdMetadata

      • setTabIdMetadata

        public void setTabIdMetadata​(PropertyMetadata tabIdMetadata)
        setTabIdMetadata.

      • tabLabel

        public Ssn tabLabel​(java.lang.String tabLabel)
        tabLabel.
        Returns:
        Ssn

      • getTabLabel

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

      • setTabLabel

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

      • tabLabelMetadata

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

      • getTabLabelMetadata

        public PropertyMetadata getTabLabelMetadata()
        Get tabLabelMetadata.
        Returns:
        tabLabelMetadata

      • setTabLabelMetadata

        public void setTabLabelMetadata​(PropertyMetadata tabLabelMetadata)
        setTabLabelMetadata.

      • tabOrder

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

      • getTabOrder

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

      • setTabOrder

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

      • tabOrderMetadata

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

      • getTabOrderMetadata

        public PropertyMetadata getTabOrderMetadata()
        Get tabOrderMetadata.
        Returns:
        tabOrderMetadata

      • setTabOrderMetadata

        public void setTabOrderMetadata​(PropertyMetadata tabOrderMetadata)
        setTabOrderMetadata.

      • tabType

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

      • getTabType

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

      • setTabType

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

      • tabTypeMetadata

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

      • getTabTypeMetadata

        public PropertyMetadata getTabTypeMetadata()
        Get tabTypeMetadata.
        Returns:
        tabTypeMetadata

      • setTabTypeMetadata

        public void setTabTypeMetadata​(PropertyMetadata tabTypeMetadata)
        setTabTypeMetadata.

      • templateLocked

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

      • 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 Ssn templateLockedMetadata​(PropertyMetadata templateLockedMetadata)
        templateLockedMetadata.
        Returns:
        Ssn

      • getTemplateLockedMetadata

        public PropertyMetadata getTemplateLockedMetadata()
        Get templateLockedMetadata.
        Returns:
        templateLockedMetadata

      • setTemplateLockedMetadata

        public void setTemplateLockedMetadata​(PropertyMetadata templateLockedMetadata)
        setTemplateLockedMetadata.

      • templateRequired

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

      • 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 Ssn templateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)
        templateRequiredMetadata.
        Returns:
        Ssn

      • getTemplateRequiredMetadata

        public PropertyMetadata getTemplateRequiredMetadata()
        Get templateRequiredMetadata.
        Returns:
        templateRequiredMetadata

      • setTemplateRequiredMetadata

        public void setTemplateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)
        setTemplateRequiredMetadata.

      • tooltip

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

      • getTooltip

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

      • setTooltip

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

      • toolTipMetadata

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

      • getToolTipMetadata

        public PropertyMetadata getToolTipMetadata()
        Get toolTipMetadata.
        Returns:
        toolTipMetadata

      • setToolTipMetadata

        public void setToolTipMetadata​(PropertyMetadata toolTipMetadata)
        setToolTipMetadata.

      • underline

        public Ssn underline​(java.lang.String underline)
        underline.
        Returns:
        Ssn

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

      • underlineMetadata

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

      • getUnderlineMetadata

        public PropertyMetadata getUnderlineMetadata()
        Get underlineMetadata.
        Returns:
        underlineMetadata

      • setUnderlineMetadata

        public void setUnderlineMetadata​(PropertyMetadata underlineMetadata)
        setUnderlineMetadata.

      • validationMessage

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

      • 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 Ssn validationMessageMetadata​(PropertyMetadata validationMessageMetadata)
        validationMessageMetadata.
        Returns:
        Ssn

      • getValidationMessageMetadata

        public PropertyMetadata getValidationMessageMetadata()
        Get validationMessageMetadata.
        Returns:
        validationMessageMetadata

      • setValidationMessageMetadata

        public void setValidationMessageMetadata​(PropertyMetadata validationMessageMetadata)
        setValidationMessageMetadata.

      • validationPattern

        public Ssn validationPattern​(java.lang.String validationPattern)
        validationPattern.
        Returns:
        Ssn

      • getValidationPattern

        public java.lang.String getValidationPattern()
        A regular expression used to validate input for the tab..
        Returns:
        validationPattern

      • setValidationPattern

        public void setValidationPattern​(java.lang.String validationPattern)
        setValidationPattern.

      • validationPatternMetadata

        public Ssn validationPatternMetadata​(PropertyMetadata validationPatternMetadata)
        validationPatternMetadata.
        Returns:
        Ssn

      • getValidationPatternMetadata

        public PropertyMetadata getValidationPatternMetadata()
        Get validationPatternMetadata.
        Returns:
        validationPatternMetadata

      • setValidationPatternMetadata

        public void setValidationPatternMetadata​(PropertyMetadata validationPatternMetadata)
        setValidationPatternMetadata.

      • value

        public Ssn value​(java.lang.String value)
        value.
        Returns:
        Ssn

      • getValue

        public java.lang.String getValue()
        Specifies the value of the tab. .
        Returns:
        value

      • setValue

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

      • valueMetadata

        public Ssn valueMetadata​(PropertyMetadata valueMetadata)
        valueMetadata.
        Returns:
        Ssn

      • getValueMetadata

        public PropertyMetadata getValueMetadata()
        Get valueMetadata.
        Returns:
        valueMetadata

      • setValueMetadata

        public void setValueMetadata​(PropertyMetadata valueMetadata)
        setValueMetadata.

      • width

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

      • getWidth

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

      • setWidth

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

      • widthMetadata

        public Ssn widthMetadata​(PropertyMetadata widthMetadata)
        widthMetadata.
        Returns:
        Ssn

      • getWidthMetadata

        public PropertyMetadata getWidthMetadata()
        Get widthMetadata.
        Returns:
        widthMetadata

      • setWidthMetadata

        public void setWidthMetadata​(PropertyMetadata widthMetadata)
        setWidthMetadata.

      • xPosition

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

      • 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 Ssn xPositionMetadata​(PropertyMetadata xPositionMetadata)
        xPositionMetadata.
        Returns:
        Ssn

      • getXPositionMetadata

        public PropertyMetadata getXPositionMetadata()
        Get xPositionMetadata.
        Returns:
        xPositionMetadata

      • setXPositionMetadata

        public void setXPositionMetadata​(PropertyMetadata xPositionMetadata)
        setXPositionMetadata.

      • yPosition

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

      • 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 Ssn yPositionMetadata​(PropertyMetadata yPositionMetadata)
        yPositionMetadata.
        Returns:
        Ssn

      • 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