Ssn (docusign-esign-java 3.2.0 API)

java.lang.Object
- com.docusign.esign.model.Ssn

```
public class Ssn
extends Object
```
Ssn

Constructor Summary

Constructors
Constructor and Description

Ssn()

Constructors
Constructor and Description
`Ssn()`

Method Summary

Methods
Modifier and Type	Method and Description
`Ssn`	`addTabGroupLabelsItem(String tabGroupLabelsItem)`
`Ssn`	`anchorCaseSensitive(String anchorCaseSensitive)`
`Ssn`	`anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)`
`Ssn`	`anchorHorizontalAlignment(String anchorHorizontalAlignment)`
`Ssn`	`anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)`
`Ssn`	`anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`
`Ssn`	`anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)`
`Ssn`	`anchorMatchWholeWord(String anchorMatchWholeWord)`
`Ssn`	`anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)`
`Ssn`	`anchorString(String anchorString)`
`Ssn`	`anchorStringMetadata(PropertyMetadata anchorStringMetadata)`
`Ssn`	`anchorTabProcessorVersion(String anchorTabProcessorVersion)`
`Ssn`	`anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)`
`Ssn`	`anchorUnits(String anchorUnits)`
`Ssn`	`anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)`
`Ssn`	`anchorXOffset(String anchorXOffset)`
`Ssn`	`anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)`
`Ssn`	`anchorYOffset(String anchorYOffset)`
`Ssn`	`anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)`
`Ssn`	`bold(String bold)`
`Ssn`	`boldMetadata(PropertyMetadata boldMetadata)`
`Ssn`	`concealValueOnDocument(String concealValueOnDocument)`
`Ssn`	`concealValueOnDocumentMetadata(PropertyMetadata concealValueOnDocumentMetadata)`
`Ssn`	`conditionalParentLabel(String conditionalParentLabel)`
`Ssn`	`conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)`
`Ssn`	`conditionalParentValue(String conditionalParentValue)`
`Ssn`	`conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)`
`Ssn`	`customTabId(String customTabId)`
`Ssn`	`customTabIdMetadata(PropertyMetadata customTabIdMetadata)`
`Ssn`	`disableAutoSize(String disableAutoSize)`
`Ssn`	`disableAutoSizeMetadata(PropertyMetadata disableAutoSizeMetadata)`
`Ssn`	`documentId(String documentId)`
`Ssn`	`documentIdMetadata(PropertyMetadata documentIdMetadata)`
`boolean`	`equals(Object o)`
`Ssn`	`errorDetails(ErrorDetails errorDetails)`
`Ssn`	`font(String font)`
`Ssn`	`fontColor(String fontColor)`
`Ssn`	`fontColorMetadata(PropertyMetadata fontColorMetadata)`
`Ssn`	`fontMetadata(PropertyMetadata fontMetadata)`
`Ssn`	`fontSize(String fontSize)`
`Ssn`	`fontSizeMetadata(PropertyMetadata fontSizeMetadata)`
`Ssn`	`formOrder(String formOrder)`
`Ssn`	`formOrderMetadata(PropertyMetadata formOrderMetadata)`
`Ssn`	`formPageLabel(String formPageLabel)`
`Ssn`	`formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)`
`Ssn`	`formPageNumber(String formPageNumber)`
`Ssn`	`formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)`
`String`	`getAnchorCaseSensitive()` When set to true, the anchor string does not consider case when matching strings in the document.
`PropertyMetadata`	`getAnchorCaseSensitiveMetadata()` Get anchorCaseSensitiveMetadata
`String`	`getAnchorHorizontalAlignment()` Specifies the alignment of anchor tabs with anchor strings.
`PropertyMetadata`	`getAnchorHorizontalAlignmentMetadata()` Get anchorHorizontalAlignmentMetadata
`String`	`getAnchorIgnoreIfNotPresent()` When set to true, this tab is ignored if anchorString is not found in the document.
`PropertyMetadata`	`getAnchorIgnoreIfNotPresentMetadata()` Get anchorIgnoreIfNotPresentMetadata
`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.
`PropertyMetadata`	`getAnchorMatchWholeWordMetadata()` Get anchorMatchWholeWordMetadata
`String`	`getAnchorString()` Anchor text information for a radio button.
`PropertyMetadata`	`getAnchorStringMetadata()` Get anchorStringMetadata
`String`	`getAnchorTabProcessorVersion()`
`PropertyMetadata`	`getAnchorTabProcessorVersionMetadata()` Get anchorTabProcessorVersionMetadata
`String`	`getAnchorUnits()` Specifies units of the X and Y offset.
`PropertyMetadata`	`getAnchorUnitsMetadata()` Get anchorUnitsMetadata
`String`	`getAnchorXOffset()` Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
`PropertyMetadata`	`getAnchorXOffsetMetadata()` Get anchorXOffsetMetadata
`String`	`getAnchorYOffset()` Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
`PropertyMetadata`	`getAnchorYOffsetMetadata()` Get anchorYOffsetMetadata
`String`	`getBold()` When set to true, the information in the tab is bold.
`PropertyMetadata`	`getBoldMetadata()` Get boldMetadata
`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.
`PropertyMetadata`	`getConcealValueOnDocumentMetadata()` Get concealValueOnDocumentMetadata
`String`	`getConditionalParentLabel()` For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`PropertyMetadata`	`getConditionalParentLabelMetadata()` Get conditionalParentLabelMetadata
`String`	`getConditionalParentValue()` For conditional fields, this is the value of the parent tab that controls the tab's visibility.
`PropertyMetadata`	`getConditionalParentValueMetadata()` Get conditionalParentValueMetadata
`String`	`getCustomTabId()` The DocuSign generated custom tab ID for the custom tab to be applied.
`PropertyMetadata`	`getCustomTabIdMetadata()` Get customTabIdMetadata
`String`	`getDisableAutoSize()` When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data.
`PropertyMetadata`	`getDisableAutoSizeMetadata()` Get disableAutoSizeMetadata
`String`	`getDocumentId()` Specifies the document ID number that the tab is placed on.
`PropertyMetadata`	`getDocumentIdMetadata()` Get documentIdMetadata
`ErrorDetails`	`getErrorDetails()` Get errorDetails
`String`	`getFont()` The font to be used for the tab value.
`String`	`getFontColor()` The font color used for the information in the tab.
`PropertyMetadata`	`getFontColorMetadata()` Get fontColorMetadata
`PropertyMetadata`	`getFontMetadata()` Get fontMetadata
`String`	`getFontSize()` The font size used for the information in the tab.
`PropertyMetadata`	`getFontSizeMetadata()` Get fontSizeMetadata
`String`	`getFormOrder()`
`PropertyMetadata`	`getFormOrderMetadata()` Get formOrderMetadata
`String`	`getFormPageLabel()`
`PropertyMetadata`	`getFormPageLabelMetadata()` Get formPageLabelMetadata
`String`	`getFormPageNumber()`
`PropertyMetadata`	`getFormPageNumberMetadata()` Get formPageNumberMetadata
`String`	`getHeight()` Height of the tab in pixels.
`PropertyMetadata`	`getHeightMetadata()` Get heightMetadata
`String`	`getItalic()` When set to true, the information in the tab is italic.
`PropertyMetadata`	`getItalicMetadata()` Get italicMetadata
`LocalePolicyTab`	`getLocalePolicy()` Get localePolicy
`String`	`getLocked()` When set to true, the signer cannot change the data of the custom tab.
`PropertyMetadata`	`getLockedMetadata()` Get lockedMetadata
`String`	`getMaxLength()` An optional value that describes the maximum length of the property when the property is a string.
`PropertyMetadata`	`getMaxLengthMetadata()` Get maxLengthMetadata
`MergeField`	`getMergeField()` Get mergeField
`String`	`getMergeFieldXml()`
`String`	`getName()` Specifies the tool tip text for the tab.
`PropertyMetadata`	`getNameMetadata()` Get nameMetadata
`String`	`getOriginalValue()` The initial value of the tab when it was sent to the recipient.
`PropertyMetadata`	`getOriginalValueMetadata()` Get originalValueMetadata
`String`	`getPageNumber()` Specifies the page number on which the tab is located.
`PropertyMetadata`	`getPageNumberMetadata()` Get pageNumberMetadata
`String`	`getRecipientId()` Unique for the recipient.
`String`	`getRecipientIdGuid()`
`PropertyMetadata`	`getRecipientIdGuidMetadata()` Get recipientIdGuidMetadata
`PropertyMetadata`	`getRecipientIdMetadata()` Get recipientIdMetadata
`String`	`getRequireAll()` When set to true and shared is true, information must be entered in this field to complete the envelope.
`PropertyMetadata`	`getRequireAllMetadata()` Get requireAllMetadata
`String`	`getRequired()` When set to true, the signer is required to fill out this tab
`PropertyMetadata`	`getRequiredMetadata()` Get requiredMetadata
`String`	`getRequireInitialOnSharedChange()` Optional element for field markup.
`PropertyMetadata`	`getRequireInitialOnSharedChangeMetadata()` Get requireInitialOnSharedChangeMetadata
`String`	`getSenderRequired()` When set to true, the sender must populate the tab before an envelope can be sent using the template.
`PropertyMetadata`	`getSenderRequiredMetadata()` Get senderRequiredMetadata
`String`	`getShared()` When set to true, this custom tab is shared.
`PropertyMetadata`	`getSharedMetadata()` Get sharedMetadata
`String`	`getStatus()` Indicates the envelope status.
`PropertyMetadata`	`getStatusMetadata()` Get statusMetadata
`List<String>`	`getTabGroupLabels()`
`PropertyMetadata`	`getTabGroupLabelsMetadata()` Get tabGroupLabelsMetadata
`String`	`getTabId()` The unique identifier for the tab.
`PropertyMetadata`	`getTabIdMetadata()` Get tabIdMetadata
`String`	`getTabLabel()` The label string associated with the tab.
`PropertyMetadata`	`getTabLabelMetadata()` Get tabLabelMetadata
`String`	`getTabOrder()`
`PropertyMetadata`	`getTabOrderMetadata()` Get tabOrderMetadata
`String`	`getTabType()`
`PropertyMetadata`	`getTabTypeMetadata()` Get tabTypeMetadata
`String`	`getTemplateLocked()` When set to true, the sender cannot change any attributes of the recipient.
`PropertyMetadata`	`getTemplateLockedMetadata()` Get templateLockedMetadata
`String`	`getTemplateRequired()` When set to true, the sender may not remove the recipient.
`PropertyMetadata`	`getTemplateRequiredMetadata()` Get templateRequiredMetadata
`String`	`getTooltip()`
`PropertyMetadata`	`getToolTipMetadata()` Get toolTipMetadata
`String`	`getUnderline()` When set to true, the information in the tab is underlined.
`PropertyMetadata`	`getUnderlineMetadata()` Get underlineMetadata
`String`	`getValidationMessage()` The message displayed if the custom tab fails input validation (either custom of embedded).
`PropertyMetadata`	`getValidationMessageMetadata()` Get validationMessageMetadata
`String`	`getValidationPattern()` A regular expression used to validate input for the tab.
`PropertyMetadata`	`getValidationPatternMetadata()` Get validationPatternMetadata
`String`	`getValue()` Specifies the value of the tab.
`PropertyMetadata`	`getValueMetadata()` Get valueMetadata
`String`	`getWidth()` Width of the tab in pixels.
`PropertyMetadata`	`getWidthMetadata()` Get widthMetadata
`String`	`getXPosition()` This indicates the horizontal offset of the object on the page.
`PropertyMetadata`	`getXPositionMetadata()` Get xPositionMetadata
`String`	`getYPosition()` This indicates the vertical offset of the object on the page.
`PropertyMetadata`	`getYPositionMetadata()` Get yPositionMetadata
`int`	`hashCode()`
`Ssn`	`height(String height)`
`Ssn`	`heightMetadata(PropertyMetadata heightMetadata)`
`Ssn`	`italic(String italic)`
`Ssn`	`italicMetadata(PropertyMetadata italicMetadata)`
`Ssn`	`localePolicy(LocalePolicyTab localePolicy)`
`Ssn`	`locked(String locked)`
`Ssn`	`lockedMetadata(PropertyMetadata lockedMetadata)`
`Ssn`	`maxLength(String maxLength)`
`Ssn`	`maxLengthMetadata(PropertyMetadata maxLengthMetadata)`
`Ssn`	`mergeField(MergeField mergeField)`
`Ssn`	`mergeFieldXml(String mergeFieldXml)`
`Ssn`	`name(String name)`
`Ssn`	`nameMetadata(PropertyMetadata nameMetadata)`
`Ssn`	`originalValue(String originalValue)`
`Ssn`	`originalValueMetadata(PropertyMetadata originalValueMetadata)`
`Ssn`	`pageNumber(String pageNumber)`
`Ssn`	`pageNumberMetadata(PropertyMetadata pageNumberMetadata)`
`Ssn`	`recipientId(String recipientId)`
`Ssn`	`recipientIdGuid(String recipientIdGuid)`
`Ssn`	`recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)`
`Ssn`	`recipientIdMetadata(PropertyMetadata recipientIdMetadata)`
`Ssn`	`requireAll(String requireAll)`
`Ssn`	`requireAllMetadata(PropertyMetadata requireAllMetadata)`
`Ssn`	`required(String required)`
`Ssn`	`requiredMetadata(PropertyMetadata requiredMetadata)`
`Ssn`	`requireInitialOnSharedChange(String requireInitialOnSharedChange)`
`Ssn`	`requireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)`
`Ssn`	`senderRequired(String senderRequired)`
`Ssn`	`senderRequiredMetadata(PropertyMetadata senderRequiredMetadata)`
`void`	`setAnchorCaseSensitive(String anchorCaseSensitive)`
`void`	`setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)`
`void`	`setAnchorHorizontalAlignment(String anchorHorizontalAlignment)`
`void`	`setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)`
`void`	`setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`
`void`	`setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)`
`void`	`setAnchorMatchWholeWord(String anchorMatchWholeWord)`
`void`	`setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)`
`void`	`setAnchorString(String anchorString)`
`void`	`setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)`
`void`	`setAnchorTabProcessorVersion(String anchorTabProcessorVersion)`
`void`	`setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)`
`void`	`setAnchorUnits(String anchorUnits)`
`void`	`setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)`
`void`	`setAnchorXOffset(String anchorXOffset)`
`void`	`setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)`
`void`	`setAnchorYOffset(String anchorYOffset)`
`void`	`setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)`
`void`	`setBold(String bold)`
`void`	`setBoldMetadata(PropertyMetadata boldMetadata)`
`void`	`setConcealValueOnDocument(String concealValueOnDocument)`
`void`	`setConcealValueOnDocumentMetadata(PropertyMetadata concealValueOnDocumentMetadata)`
`void`	`setConditionalParentLabel(String conditionalParentLabel)`
`void`	`setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)`
`void`	`setConditionalParentValue(String conditionalParentValue)`
`void`	`setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)`
`void`	`setCustomTabId(String customTabId)`
`void`	`setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)`
`void`	`setDisableAutoSize(String disableAutoSize)`
`void`	`setDisableAutoSizeMetadata(PropertyMetadata disableAutoSizeMetadata)`
`void`	`setDocumentId(String documentId)`
`void`	`setDocumentIdMetadata(PropertyMetadata documentIdMetadata)`
`void`	`setErrorDetails(ErrorDetails errorDetails)`
`void`	`setFont(String font)`
`void`	`setFontColor(String fontColor)`
`void`	`setFontColorMetadata(PropertyMetadata fontColorMetadata)`
`void`	`setFontMetadata(PropertyMetadata fontMetadata)`
`void`	`setFontSize(String fontSize)`
`void`	`setFontSizeMetadata(PropertyMetadata fontSizeMetadata)`
`void`	`setFormOrder(String formOrder)`
`void`	`setFormOrderMetadata(PropertyMetadata formOrderMetadata)`
`void`	`setFormPageLabel(String formPageLabel)`
`void`	`setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)`
`void`	`setFormPageNumber(String formPageNumber)`
`void`	`setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)`
`void`	`setHeight(String height)`
`void`	`setHeightMetadata(PropertyMetadata heightMetadata)`
`void`	`setItalic(String italic)`
`void`	`setItalicMetadata(PropertyMetadata italicMetadata)`
`void`	`setLocalePolicy(LocalePolicyTab localePolicy)`
`void`	`setLocked(String locked)`
`void`	`setLockedMetadata(PropertyMetadata lockedMetadata)`
`void`	`setMaxLength(String maxLength)`
`void`	`setMaxLengthMetadata(PropertyMetadata maxLengthMetadata)`
`void`	`setMergeField(MergeField mergeField)`
`void`	`setMergeFieldXml(String mergeFieldXml)`
`void`	`setName(String name)`
`void`	`setNameMetadata(PropertyMetadata nameMetadata)`
`void`	`setOriginalValue(String originalValue)`
`void`	`setOriginalValueMetadata(PropertyMetadata originalValueMetadata)`
`void`	`setPageNumber(String pageNumber)`
`void`	`setPageNumberMetadata(PropertyMetadata pageNumberMetadata)`
`void`	`setRecipientId(String recipientId)`
`void`	`setRecipientIdGuid(String recipientIdGuid)`
`void`	`setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)`
`void`	`setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)`
`void`	`setRequireAll(String requireAll)`
`void`	`setRequireAllMetadata(PropertyMetadata requireAllMetadata)`
`void`	`setRequired(String required)`
`void`	`setRequiredMetadata(PropertyMetadata requiredMetadata)`
`void`	`setRequireInitialOnSharedChange(String requireInitialOnSharedChange)`
`void`	`setRequireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)`
`void`	`setSenderRequired(String senderRequired)`
`void`	`setSenderRequiredMetadata(PropertyMetadata senderRequiredMetadata)`
`void`	`setShared(String shared)`
`void`	`setSharedMetadata(PropertyMetadata sharedMetadata)`
`void`	`setStatus(String status)`
`void`	`setStatusMetadata(PropertyMetadata statusMetadata)`
`void`	`setTabGroupLabels(List<String> tabGroupLabels)`
`void`	`setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)`
`void`	`setTabId(String tabId)`
`void`	`setTabIdMetadata(PropertyMetadata tabIdMetadata)`
`void`	`setTabLabel(String tabLabel)`
`void`	`setTabLabelMetadata(PropertyMetadata tabLabelMetadata)`
`void`	`setTabOrder(String tabOrder)`
`void`	`setTabOrderMetadata(PropertyMetadata tabOrderMetadata)`
`void`	`setTabType(String tabType)`
`void`	`setTabTypeMetadata(PropertyMetadata tabTypeMetadata)`
`void`	`setTemplateLocked(String templateLocked)`
`void`	`setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)`
`void`	`setTemplateRequired(String templateRequired)`
`void`	`setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)`
`void`	`setTooltip(String tooltip)`
`void`	`setToolTipMetadata(PropertyMetadata toolTipMetadata)`
`void`	`setUnderline(String underline)`
`void`	`setUnderlineMetadata(PropertyMetadata underlineMetadata)`
`void`	`setValidationMessage(String validationMessage)`
`void`	`setValidationMessageMetadata(PropertyMetadata validationMessageMetadata)`
`void`	`setValidationPattern(String validationPattern)`
`void`	`setValidationPatternMetadata(PropertyMetadata validationPatternMetadata)`
`void`	`setValue(String value)`
`void`	`setValueMetadata(PropertyMetadata valueMetadata)`
`void`	`setWidth(String width)`
`void`	`setWidthMetadata(PropertyMetadata widthMetadata)`
`void`	`setXPosition(String xPosition)`
`void`	`setXPositionMetadata(PropertyMetadata xPositionMetadata)`
`void`	`setYPosition(String yPosition)`
`void`	`setYPositionMetadata(PropertyMetadata yPositionMetadata)`
`Ssn`	`shared(String shared)`
`Ssn`	`sharedMetadata(PropertyMetadata sharedMetadata)`
`Ssn`	`status(String status)`
`Ssn`	`statusMetadata(PropertyMetadata statusMetadata)`
`Ssn`	`tabGroupLabels(List<String> tabGroupLabels)`
`Ssn`	`tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)`
`Ssn`	`tabId(String tabId)`
`Ssn`	`tabIdMetadata(PropertyMetadata tabIdMetadata)`
`Ssn`	`tabLabel(String tabLabel)`
`Ssn`	`tabLabelMetadata(PropertyMetadata tabLabelMetadata)`
`Ssn`	`tabOrder(String tabOrder)`
`Ssn`	`tabOrderMetadata(PropertyMetadata tabOrderMetadata)`
`Ssn`	`tabType(String tabType)`
`Ssn`	`tabTypeMetadata(PropertyMetadata tabTypeMetadata)`
`Ssn`	`templateLocked(String templateLocked)`
`Ssn`	`templateLockedMetadata(PropertyMetadata templateLockedMetadata)`
`Ssn`	`templateRequired(String templateRequired)`
`Ssn`	`templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)`
`Ssn`	`tooltip(String tooltip)`
`Ssn`	`toolTipMetadata(PropertyMetadata toolTipMetadata)`
`String`	`toString()`
`Ssn`	`underline(String underline)`
`Ssn`	`underlineMetadata(PropertyMetadata underlineMetadata)`
`Ssn`	`validationMessage(String validationMessage)`
`Ssn`	`validationMessageMetadata(PropertyMetadata validationMessageMetadata)`
`Ssn`	`validationPattern(String validationPattern)`
`Ssn`	`validationPatternMetadata(PropertyMetadata validationPatternMetadata)`
`Ssn`	`value(String value)`
`Ssn`	`valueMetadata(PropertyMetadata valueMetadata)`
`Ssn`	`width(String width)`
`Ssn`	`widthMetadata(PropertyMetadata widthMetadata)`
`Ssn`	`xPosition(String xPosition)`
`Ssn`	`xPositionMetadata(PropertyMetadata xPositionMetadata)`
`Ssn`	`yPosition(String yPosition)`
`Ssn`	`yPositionMetadata(PropertyMetadata yPositionMetadata)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- Ssn
```
public Ssn()
```

Method Detail

anchorCaseSensitive

public Ssn anchorCaseSensitive(String anchorCaseSensitive)

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

Returns:
anchorCaseSensitive

setAnchorCaseSensitive

public void setAnchorCaseSensitive(String anchorCaseSensitive)

anchorCaseSensitiveMetadata

public Ssn anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)

getAnchorCaseSensitiveMetadata
```
public PropertyMetadata getAnchorCaseSensitiveMetadata()
```
Get anchorCaseSensitiveMetadata

Returns:
anchorCaseSensitiveMetadata

setAnchorCaseSensitiveMetadata

public void setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)

anchorHorizontalAlignment

public Ssn anchorHorizontalAlignment(String anchorHorizontalAlignment)

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

Returns:
anchorHorizontalAlignment

setAnchorHorizontalAlignment

public void setAnchorHorizontalAlignment(String anchorHorizontalAlignment)

anchorHorizontalAlignmentMetadata

public Ssn anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)

getAnchorHorizontalAlignmentMetadata
```
public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
```
Get anchorHorizontalAlignmentMetadata

Returns:
anchorHorizontalAlignmentMetadata

setAnchorHorizontalAlignmentMetadata

public void setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)

anchorIgnoreIfNotPresent

public Ssn anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)

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

Returns:
anchorIgnoreIfNotPresent

setAnchorIgnoreIfNotPresent

public void setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)

anchorIgnoreIfNotPresentMetadata

public Ssn anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)

getAnchorIgnoreIfNotPresentMetadata
```
public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
```
Get anchorIgnoreIfNotPresentMetadata

Returns:
anchorIgnoreIfNotPresentMetadata

setAnchorIgnoreIfNotPresentMetadata

public void setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)

anchorMatchWholeWord

public Ssn anchorMatchWholeWord(String anchorMatchWholeWord)

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

Returns:
anchorMatchWholeWord

setAnchorMatchWholeWord

public void setAnchorMatchWholeWord(String anchorMatchWholeWord)

anchorMatchWholeWordMetadata

public Ssn anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)

getAnchorMatchWholeWordMetadata
```
public PropertyMetadata getAnchorMatchWholeWordMetadata()
```
Get anchorMatchWholeWordMetadata

Returns:
anchorMatchWholeWordMetadata

setAnchorMatchWholeWordMetadata

public void setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)

anchorString

public Ssn anchorString(String anchorString)

getAnchorString
```
public String getAnchorString()
```
Anchor text information for a radio button.

Returns:
anchorString

setAnchorString

public void setAnchorString(String anchorString)

anchorStringMetadata

public Ssn anchorStringMetadata(PropertyMetadata anchorStringMetadata)

getAnchorStringMetadata
```
public PropertyMetadata getAnchorStringMetadata()
```
Get anchorStringMetadata

Returns:
anchorStringMetadata

setAnchorStringMetadata

public void setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)

anchorTabProcessorVersion

public Ssn anchorTabProcessorVersion(String anchorTabProcessorVersion)

getAnchorTabProcessorVersion
```
public String getAnchorTabProcessorVersion()
```
Returns:
anchorTabProcessorVersion

setAnchorTabProcessorVersion

public void setAnchorTabProcessorVersion(String anchorTabProcessorVersion)

anchorTabProcessorVersionMetadata

public Ssn anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)

getAnchorTabProcessorVersionMetadata
```
public PropertyMetadata getAnchorTabProcessorVersionMetadata()
```
Get anchorTabProcessorVersionMetadata

Returns:
anchorTabProcessorVersionMetadata

setAnchorTabProcessorVersionMetadata

public void setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)

anchorUnits

public Ssn anchorUnits(String anchorUnits)

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

Returns:
anchorUnits

setAnchorUnits

public void setAnchorUnits(String anchorUnits)

anchorUnitsMetadata

public Ssn anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)

getAnchorUnitsMetadata
```
public PropertyMetadata getAnchorUnitsMetadata()
```
Get anchorUnitsMetadata

Returns:
anchorUnitsMetadata

setAnchorUnitsMetadata

public void setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)

anchorXOffset

public Ssn anchorXOffset(String anchorXOffset)

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

Returns:
anchorXOffset

setAnchorXOffset

public void setAnchorXOffset(String anchorXOffset)

anchorXOffsetMetadata

public Ssn anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)

getAnchorXOffsetMetadata
```
public PropertyMetadata getAnchorXOffsetMetadata()
```
Get anchorXOffsetMetadata

Returns:
anchorXOffsetMetadata

setAnchorXOffsetMetadata

public void setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)

anchorYOffset

public Ssn anchorYOffset(String anchorYOffset)

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

Returns:
anchorYOffset

setAnchorYOffset

public void setAnchorYOffset(String anchorYOffset)

anchorYOffsetMetadata

public Ssn anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)

getAnchorYOffsetMetadata
```
public PropertyMetadata getAnchorYOffsetMetadata()
```
Get anchorYOffsetMetadata

Returns:
anchorYOffsetMetadata

setAnchorYOffsetMetadata

public void setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)

bold
```
public Ssn bold(String bold)
```

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

Returns:
bold

setBold
```
public void setBold(String bold)
```

boldMetadata

public Ssn boldMetadata(PropertyMetadata boldMetadata)

getBoldMetadata
```
public PropertyMetadata getBoldMetadata()
```
Get boldMetadata

Returns:
boldMetadata

setBoldMetadata

public void setBoldMetadata(PropertyMetadata boldMetadata)

concealValueOnDocument

public Ssn concealValueOnDocument(String concealValueOnDocument)

getConcealValueOnDocument
```
public 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(String concealValueOnDocument)

concealValueOnDocumentMetadata

public Ssn concealValueOnDocumentMetadata(PropertyMetadata concealValueOnDocumentMetadata)

getConcealValueOnDocumentMetadata
```
public PropertyMetadata getConcealValueOnDocumentMetadata()
```
Get concealValueOnDocumentMetadata

Returns:
concealValueOnDocumentMetadata

setConcealValueOnDocumentMetadata

public void setConcealValueOnDocumentMetadata(PropertyMetadata concealValueOnDocumentMetadata)

conditionalParentLabel

public Ssn conditionalParentLabel(String conditionalParentLabel)

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

Returns:
conditionalParentLabel

setConditionalParentLabel

public void setConditionalParentLabel(String conditionalParentLabel)

conditionalParentLabelMetadata

public Ssn conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)

getConditionalParentLabelMetadata
```
public PropertyMetadata getConditionalParentLabelMetadata()
```
Get conditionalParentLabelMetadata

Returns:
conditionalParentLabelMetadata

setConditionalParentLabelMetadata

public void setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)

conditionalParentValue

public Ssn conditionalParentValue(String conditionalParentValue)

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

Returns:
conditionalParentValue

setConditionalParentValue

public void setConditionalParentValue(String conditionalParentValue)

conditionalParentValueMetadata

public Ssn conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)

getConditionalParentValueMetadata
```
public PropertyMetadata getConditionalParentValueMetadata()
```
Get conditionalParentValueMetadata

Returns:
conditionalParentValueMetadata

setConditionalParentValueMetadata

public void setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)

customTabId

public Ssn customTabId(String customTabId)

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

Returns:
customTabId

setCustomTabId

public void setCustomTabId(String customTabId)

customTabIdMetadata

public Ssn customTabIdMetadata(PropertyMetadata customTabIdMetadata)

getCustomTabIdMetadata
```
public PropertyMetadata getCustomTabIdMetadata()
```
Get customTabIdMetadata

Returns:
customTabIdMetadata

setCustomTabIdMetadata

public void setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)

disableAutoSize

public Ssn disableAutoSize(String disableAutoSize)

getDisableAutoSize
```
public 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(String disableAutoSize)

disableAutoSizeMetadata

public Ssn disableAutoSizeMetadata(PropertyMetadata disableAutoSizeMetadata)

getDisableAutoSizeMetadata
```
public PropertyMetadata getDisableAutoSizeMetadata()
```
Get disableAutoSizeMetadata

Returns:
disableAutoSizeMetadata

setDisableAutoSizeMetadata

public void setDisableAutoSizeMetadata(PropertyMetadata disableAutoSizeMetadata)

documentId

public Ssn documentId(String documentId)

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

Returns:
documentId

setDocumentId

public void setDocumentId(String documentId)

documentIdMetadata

public Ssn documentIdMetadata(PropertyMetadata documentIdMetadata)

getDocumentIdMetadata
```
public PropertyMetadata getDocumentIdMetadata()
```
Get documentIdMetadata

Returns:
documentIdMetadata

setDocumentIdMetadata

public void setDocumentIdMetadata(PropertyMetadata documentIdMetadata)

errorDetails

public Ssn errorDetails(ErrorDetails errorDetails)

getErrorDetails
```
public ErrorDetails getErrorDetails()
```
Get errorDetails

Returns:
errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

font
```
public Ssn font(String font)
```

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

Returns:
font

setFont
```
public void setFont(String font)
```

fontColor

public Ssn fontColor(String fontColor)

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

Returns:
fontColor

setFontColor

public void setFontColor(String fontColor)

fontColorMetadata

public Ssn fontColorMetadata(PropertyMetadata fontColorMetadata)

getFontColorMetadata
```
public PropertyMetadata getFontColorMetadata()
```
Get fontColorMetadata

Returns:
fontColorMetadata

setFontColorMetadata

public void setFontColorMetadata(PropertyMetadata fontColorMetadata)

fontMetadata

public Ssn fontMetadata(PropertyMetadata fontMetadata)

getFontMetadata
```
public PropertyMetadata getFontMetadata()
```
Get fontMetadata

Returns:
fontMetadata

setFontMetadata

public void setFontMetadata(PropertyMetadata fontMetadata)

fontSize
```
public Ssn fontSize(String fontSize)
```

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

Returns:
fontSize

setFontSize

public void setFontSize(String fontSize)

fontSizeMetadata

public Ssn fontSizeMetadata(PropertyMetadata fontSizeMetadata)

getFontSizeMetadata
```
public PropertyMetadata getFontSizeMetadata()
```
Get fontSizeMetadata

Returns:
fontSizeMetadata

setFontSizeMetadata

public void setFontSizeMetadata(PropertyMetadata fontSizeMetadata)

formOrder

public Ssn formOrder(String formOrder)

getFormOrder
```
public String getFormOrder()
```
Returns:
formOrder

setFormOrder

public void setFormOrder(String formOrder)

formOrderMetadata

public Ssn formOrderMetadata(PropertyMetadata formOrderMetadata)

getFormOrderMetadata
```
public PropertyMetadata getFormOrderMetadata()
```
Get formOrderMetadata

Returns:
formOrderMetadata

setFormOrderMetadata

public void setFormOrderMetadata(PropertyMetadata formOrderMetadata)

formPageLabel

public Ssn formPageLabel(String formPageLabel)

getFormPageLabel
```
public String getFormPageLabel()
```
Returns:
formPageLabel

setFormPageLabel

public void setFormPageLabel(String formPageLabel)

formPageLabelMetadata

public Ssn formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)

getFormPageLabelMetadata
```
public PropertyMetadata getFormPageLabelMetadata()
```
Get formPageLabelMetadata

Returns:
formPageLabelMetadata

setFormPageLabelMetadata

public void setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)

formPageNumber

public Ssn formPageNumber(String formPageNumber)

getFormPageNumber
```
public String getFormPageNumber()
```
Returns:
formPageNumber

setFormPageNumber

public void setFormPageNumber(String formPageNumber)

formPageNumberMetadata

public Ssn formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)

getFormPageNumberMetadata
```
public PropertyMetadata getFormPageNumberMetadata()
```
Get formPageNumberMetadata

Returns:
formPageNumberMetadata

setFormPageNumberMetadata

public void setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)

height
```
public Ssn height(String height)
```

getHeight
```
public String getHeight()
```
Height of the tab in pixels.

Returns:
height

setHeight
```
public void setHeight(String height)
```

heightMetadata

public Ssn heightMetadata(PropertyMetadata heightMetadata)

getHeightMetadata
```
public PropertyMetadata getHeightMetadata()
```
Get heightMetadata

Returns:
heightMetadata

setHeightMetadata

public void setHeightMetadata(PropertyMetadata heightMetadata)

italic
```
public Ssn italic(String italic)
```

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

Returns:
italic

setItalic
```
public void setItalic(String italic)
```

italicMetadata

public Ssn italicMetadata(PropertyMetadata italicMetadata)

getItalicMetadata
```
public PropertyMetadata getItalicMetadata()
```
Get italicMetadata

Returns:
italicMetadata

setItalicMetadata

public void setItalicMetadata(PropertyMetadata italicMetadata)

localePolicy

public Ssn localePolicy(LocalePolicyTab localePolicy)

getLocalePolicy
```
public LocalePolicyTab getLocalePolicy()
```
Get localePolicy

Returns:
localePolicy

setLocalePolicy

public void setLocalePolicy(LocalePolicyTab localePolicy)

locked
```
public Ssn locked(String locked)
```

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

Returns:
locked

setLocked
```
public void setLocked(String locked)
```

lockedMetadata

public Ssn lockedMetadata(PropertyMetadata lockedMetadata)

getLockedMetadata
```
public PropertyMetadata getLockedMetadata()
```
Get lockedMetadata

Returns:
lockedMetadata

setLockedMetadata

public void setLockedMetadata(PropertyMetadata lockedMetadata)

maxLength

public Ssn maxLength(String maxLength)

getMaxLength
```
public 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(String maxLength)

maxLengthMetadata

public Ssn maxLengthMetadata(PropertyMetadata maxLengthMetadata)

getMaxLengthMetadata
```
public PropertyMetadata getMaxLengthMetadata()
```
Get maxLengthMetadata

Returns:
maxLengthMetadata

setMaxLengthMetadata

public void setMaxLengthMetadata(PropertyMetadata maxLengthMetadata)

mergeField

public Ssn mergeField(MergeField mergeField)

getMergeField
```
public MergeField getMergeField()
```
Get mergeField

Returns:
mergeField

setMergeField

public void setMergeField(MergeField mergeField)

mergeFieldXml

public Ssn mergeFieldXml(String mergeFieldXml)

getMergeFieldXml
```
public String getMergeFieldXml()
```
Returns:
mergeFieldXml

setMergeFieldXml

public void setMergeFieldXml(String mergeFieldXml)

name
```
public Ssn name(String name)
```

getName
```
public String getName()
```
Specifies the tool tip text for the tab.

Returns:
name

setName
```
public void setName(String name)
```

nameMetadata

public Ssn nameMetadata(PropertyMetadata nameMetadata)

getNameMetadata
```
public PropertyMetadata getNameMetadata()
```
Get nameMetadata

Returns:
nameMetadata

setNameMetadata

public void setNameMetadata(PropertyMetadata nameMetadata)

originalValue

public Ssn originalValue(String originalValue)

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

Returns:
originalValue

setOriginalValue

public void setOriginalValue(String originalValue)

originalValueMetadata

public Ssn originalValueMetadata(PropertyMetadata originalValueMetadata)

getOriginalValueMetadata
```
public PropertyMetadata getOriginalValueMetadata()
```
Get originalValueMetadata

Returns:
originalValueMetadata

setOriginalValueMetadata

public void setOriginalValueMetadata(PropertyMetadata originalValueMetadata)

pageNumber

public Ssn pageNumber(String pageNumber)

getPageNumber
```
public String getPageNumber()
```
Specifies the page number on which the tab is located.

Returns:
pageNumber

setPageNumber

public void setPageNumber(String pageNumber)

pageNumberMetadata

public Ssn pageNumberMetadata(PropertyMetadata pageNumberMetadata)

getPageNumberMetadata
```
public PropertyMetadata getPageNumberMetadata()
```
Get pageNumberMetadata

Returns:
pageNumberMetadata

setPageNumberMetadata

public void setPageNumberMetadata(PropertyMetadata pageNumberMetadata)

recipientId

public Ssn recipientId(String recipientId)

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

Returns:
recipientId

setRecipientId

public void setRecipientId(String recipientId)

recipientIdGuid

public Ssn recipientIdGuid(String recipientIdGuid)

getRecipientIdGuid
```
public String getRecipientIdGuid()
```
Returns:
recipientIdGuid

setRecipientIdGuid

public void setRecipientIdGuid(String recipientIdGuid)

recipientIdGuidMetadata

public Ssn recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)

getRecipientIdGuidMetadata
```
public PropertyMetadata getRecipientIdGuidMetadata()
```
Get recipientIdGuidMetadata

Returns:
recipientIdGuidMetadata

setRecipientIdGuidMetadata

public void setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)

recipientIdMetadata

public Ssn recipientIdMetadata(PropertyMetadata recipientIdMetadata)

getRecipientIdMetadata
```
public PropertyMetadata getRecipientIdMetadata()
```
Get recipientIdMetadata

Returns:
recipientIdMetadata

setRecipientIdMetadata

public void setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)

requireAll

public Ssn requireAll(String requireAll)

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

Returns:
requireAll

setRequireAll

public void setRequireAll(String requireAll)

requireAllMetadata

public Ssn requireAllMetadata(PropertyMetadata requireAllMetadata)

getRequireAllMetadata
```
public PropertyMetadata getRequireAllMetadata()
```
Get requireAllMetadata

Returns:
requireAllMetadata

setRequireAllMetadata

public void setRequireAllMetadata(PropertyMetadata requireAllMetadata)

required
```
public Ssn required(String required)
```

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

Returns:
required

setRequired

public void setRequired(String required)

requiredMetadata

public Ssn requiredMetadata(PropertyMetadata requiredMetadata)

getRequiredMetadata
```
public PropertyMetadata getRequiredMetadata()
```
Get requiredMetadata

Returns:
requiredMetadata

setRequiredMetadata

public void setRequiredMetadata(PropertyMetadata requiredMetadata)

requireInitialOnSharedChange

public Ssn requireInitialOnSharedChange(String requireInitialOnSharedChange)

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

Returns:
requireInitialOnSharedChange

setRequireInitialOnSharedChange

public void setRequireInitialOnSharedChange(String requireInitialOnSharedChange)

requireInitialOnSharedChangeMetadata

public Ssn requireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)

getRequireInitialOnSharedChangeMetadata
```
public PropertyMetadata getRequireInitialOnSharedChangeMetadata()
```
Get requireInitialOnSharedChangeMetadata

Returns:
requireInitialOnSharedChangeMetadata

setRequireInitialOnSharedChangeMetadata

public void setRequireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)

senderRequired

public Ssn senderRequired(String senderRequired)

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

Returns:
senderRequired

setSenderRequired

public void setSenderRequired(String senderRequired)

senderRequiredMetadata

public Ssn senderRequiredMetadata(PropertyMetadata senderRequiredMetadata)

getSenderRequiredMetadata
```
public PropertyMetadata getSenderRequiredMetadata()
```
Get senderRequiredMetadata

Returns:
senderRequiredMetadata

setSenderRequiredMetadata

public void setSenderRequiredMetadata(PropertyMetadata senderRequiredMetadata)

shared
```
public Ssn shared(String shared)
```

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

Returns:
shared

setShared
```
public void setShared(String shared)
```

sharedMetadata

public Ssn sharedMetadata(PropertyMetadata sharedMetadata)

getSharedMetadata
```
public PropertyMetadata getSharedMetadata()
```
Get sharedMetadata

Returns:
sharedMetadata

setSharedMetadata

public void setSharedMetadata(PropertyMetadata sharedMetadata)

status
```
public Ssn status(String status)
```

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

Returns:
status

setStatus
```
public void setStatus(String status)
```

statusMetadata

public Ssn statusMetadata(PropertyMetadata statusMetadata)

getStatusMetadata
```
public PropertyMetadata getStatusMetadata()
```
Get statusMetadata

Returns:
statusMetadata

setStatusMetadata

public void setStatusMetadata(PropertyMetadata statusMetadata)

tabGroupLabels

public Ssn tabGroupLabels(List<String> tabGroupLabels)

addTabGroupLabelsItem

public Ssn addTabGroupLabelsItem(String tabGroupLabelsItem)

getTabGroupLabels

public List<String> getTabGroupLabels()

Returns:: tabGroupLabels

setTabGroupLabels

public void setTabGroupLabels(List<String> tabGroupLabels)

tabGroupLabelsMetadata

public Ssn tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)

getTabGroupLabelsMetadata
```
public PropertyMetadata getTabGroupLabelsMetadata()
```
Get tabGroupLabelsMetadata

Returns:
tabGroupLabelsMetadata

setTabGroupLabelsMetadata

public void setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)

tabId
```
public Ssn tabId(String tabId)
```

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

Returns:
tabId

setTabId
```
public void setTabId(String tabId)
```

tabIdMetadata

public Ssn tabIdMetadata(PropertyMetadata tabIdMetadata)

getTabIdMetadata
```
public PropertyMetadata getTabIdMetadata()
```
Get tabIdMetadata

Returns:
tabIdMetadata

setTabIdMetadata

public void setTabIdMetadata(PropertyMetadata tabIdMetadata)

tabLabel
```
public Ssn tabLabel(String tabLabel)
```

getTabLabel
```
public String getTabLabel()
```
The label string associated with the tab.

Returns:
tabLabel

setTabLabel

public void setTabLabel(String tabLabel)

tabLabelMetadata

public Ssn tabLabelMetadata(PropertyMetadata tabLabelMetadata)

getTabLabelMetadata
```
public PropertyMetadata getTabLabelMetadata()
```
Get tabLabelMetadata

Returns:
tabLabelMetadata

setTabLabelMetadata

public void setTabLabelMetadata(PropertyMetadata tabLabelMetadata)

tabOrder
```
public Ssn tabOrder(String tabOrder)
```

getTabOrder
```
public String getTabOrder()
```
Returns:
tabOrder

setTabOrder

public void setTabOrder(String tabOrder)

tabOrderMetadata

public Ssn tabOrderMetadata(PropertyMetadata tabOrderMetadata)

getTabOrderMetadata
```
public PropertyMetadata getTabOrderMetadata()
```
Get tabOrderMetadata

Returns:
tabOrderMetadata

setTabOrderMetadata

public void setTabOrderMetadata(PropertyMetadata tabOrderMetadata)

tabType
```
public Ssn tabType(String tabType)
```

getTabType
```
public String getTabType()
```
Returns:
tabType

setTabType

public void setTabType(String tabType)

tabTypeMetadata

public Ssn tabTypeMetadata(PropertyMetadata tabTypeMetadata)

getTabTypeMetadata
```
public PropertyMetadata getTabTypeMetadata()
```
Get tabTypeMetadata

Returns:
tabTypeMetadata

setTabTypeMetadata

public void setTabTypeMetadata(PropertyMetadata tabTypeMetadata)

templateLocked

public Ssn templateLocked(String templateLocked)

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

Returns:
templateLocked

setTemplateLocked

public void setTemplateLocked(String templateLocked)

templateLockedMetadata

public Ssn templateLockedMetadata(PropertyMetadata templateLockedMetadata)

getTemplateLockedMetadata
```
public PropertyMetadata getTemplateLockedMetadata()
```
Get templateLockedMetadata

Returns:
templateLockedMetadata

setTemplateLockedMetadata

public void setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)

templateRequired

public Ssn templateRequired(String templateRequired)

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

Returns:
templateRequired

setTemplateRequired

public void setTemplateRequired(String templateRequired)

templateRequiredMetadata

public Ssn templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)

getTemplateRequiredMetadata
```
public PropertyMetadata getTemplateRequiredMetadata()
```
Get templateRequiredMetadata

Returns:
templateRequiredMetadata

setTemplateRequiredMetadata

public void setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)

tooltip
```
public Ssn tooltip(String tooltip)
```

getTooltip
```
public String getTooltip()
```
Returns:
tooltip

setTooltip

public void setTooltip(String tooltip)

toolTipMetadata

public Ssn toolTipMetadata(PropertyMetadata toolTipMetadata)

getToolTipMetadata
```
public PropertyMetadata getToolTipMetadata()
```
Get toolTipMetadata

Returns:
toolTipMetadata

setToolTipMetadata

public void setToolTipMetadata(PropertyMetadata toolTipMetadata)

underline

public Ssn underline(String underline)

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

Returns:
underline

setUnderline

public void setUnderline(String underline)

underlineMetadata

public Ssn underlineMetadata(PropertyMetadata underlineMetadata)

getUnderlineMetadata
```
public PropertyMetadata getUnderlineMetadata()
```
Get underlineMetadata

Returns:
underlineMetadata

setUnderlineMetadata

public void setUnderlineMetadata(PropertyMetadata underlineMetadata)

validationMessage

public Ssn validationMessage(String validationMessage)

getValidationMessage
```
public String getValidationMessage()
```
The message displayed if the custom tab fails input validation (either custom of embedded).

Returns:
validationMessage

setValidationMessage

public void setValidationMessage(String validationMessage)

validationMessageMetadata

public Ssn validationMessageMetadata(PropertyMetadata validationMessageMetadata)

getValidationMessageMetadata
```
public PropertyMetadata getValidationMessageMetadata()
```
Get validationMessageMetadata

Returns:
validationMessageMetadata

setValidationMessageMetadata

public void setValidationMessageMetadata(PropertyMetadata validationMessageMetadata)

validationPattern

public Ssn validationPattern(String validationPattern)

getValidationPattern
```
public String getValidationPattern()
```
A regular expression used to validate input for the tab.

Returns:
validationPattern

setValidationPattern

public void setValidationPattern(String validationPattern)

validationPatternMetadata

public Ssn validationPatternMetadata(PropertyMetadata validationPatternMetadata)

getValidationPatternMetadata
```
public PropertyMetadata getValidationPatternMetadata()
```
Get validationPatternMetadata

Returns:
validationPatternMetadata

setValidationPatternMetadata

public void setValidationPatternMetadata(PropertyMetadata validationPatternMetadata)

value
```
public Ssn value(String value)
```

getValue
```
public String getValue()
```
Specifies the value of the tab.

Returns:
value

setValue
```
public void setValue(String value)
```

valueMetadata

public Ssn valueMetadata(PropertyMetadata valueMetadata)

getValueMetadata
```
public PropertyMetadata getValueMetadata()
```
Get valueMetadata

Returns:
valueMetadata

setValueMetadata

public void setValueMetadata(PropertyMetadata valueMetadata)

width
```
public Ssn width(String width)
```

getWidth
```
public String getWidth()
```
Width of the tab in pixels.

Returns:
width

setWidth
```
public void setWidth(String width)
```

widthMetadata

public Ssn widthMetadata(PropertyMetadata widthMetadata)

getWidthMetadata
```
public PropertyMetadata getWidthMetadata()
```
Get widthMetadata

Returns:
widthMetadata

setWidthMetadata

public void setWidthMetadata(PropertyMetadata widthMetadata)

xPosition

public Ssn xPosition(String xPosition)

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

Returns:
xPosition

setXPosition

public void setXPosition(String xPosition)

xPositionMetadata

public Ssn xPositionMetadata(PropertyMetadata xPositionMetadata)

getXPositionMetadata
```
public PropertyMetadata getXPositionMetadata()
```
Get xPositionMetadata

Returns:
xPositionMetadata

setXPositionMetadata

public void setXPositionMetadata(PropertyMetadata xPositionMetadata)

yPosition

public Ssn yPosition(String yPosition)

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

Returns:
yPosition

setYPosition

public void setYPosition(String yPosition)

yPositionMetadata

public Ssn yPositionMetadata(PropertyMetadata yPositionMetadata)

getYPositionMetadata
```
public PropertyMetadata getYPositionMetadata()
```
Get yPositionMetadata

Returns:
yPositionMetadata

setYPositionMetadata

public void setYPositionMetadata(PropertyMetadata yPositionMetadata)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

Class Ssn

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Ssn

Method Detail

anchorCaseSensitive

getAnchorCaseSensitive

setAnchorCaseSensitive

anchorCaseSensitiveMetadata

getAnchorCaseSensitiveMetadata

setAnchorCaseSensitiveMetadata

anchorHorizontalAlignment

getAnchorHorizontalAlignment

setAnchorHorizontalAlignment

anchorHorizontalAlignmentMetadata

getAnchorHorizontalAlignmentMetadata

setAnchorHorizontalAlignmentMetadata

anchorIgnoreIfNotPresent

getAnchorIgnoreIfNotPresent

setAnchorIgnoreIfNotPresent

anchorIgnoreIfNotPresentMetadata

getAnchorIgnoreIfNotPresentMetadata

setAnchorIgnoreIfNotPresentMetadata

anchorMatchWholeWord

getAnchorMatchWholeWord

setAnchorMatchWholeWord

anchorMatchWholeWordMetadata

getAnchorMatchWholeWordMetadata

setAnchorMatchWholeWordMetadata

anchorString

getAnchorString

setAnchorString

anchorStringMetadata

getAnchorStringMetadata

setAnchorStringMetadata

anchorTabProcessorVersion

getAnchorTabProcessorVersion

setAnchorTabProcessorVersion

anchorTabProcessorVersionMetadata

getAnchorTabProcessorVersionMetadata

setAnchorTabProcessorVersionMetadata

anchorUnits

getAnchorUnits

setAnchorUnits

anchorUnitsMetadata

getAnchorUnitsMetadata

setAnchorUnitsMetadata

anchorXOffset

getAnchorXOffset

setAnchorXOffset

anchorXOffsetMetadata

getAnchorXOffsetMetadata

setAnchorXOffsetMetadata

anchorYOffset

getAnchorYOffset

setAnchorYOffset

anchorYOffsetMetadata

getAnchorYOffsetMetadata

setAnchorYOffsetMetadata

bold

getBold

setBold

boldMetadata

getBoldMetadata

setBoldMetadata

concealValueOnDocument

getConcealValueOnDocument

setConcealValueOnDocument

concealValueOnDocumentMetadata

getConcealValueOnDocumentMetadata

setConcealValueOnDocumentMetadata

conditionalParentLabel

getConditionalParentLabel

setConditionalParentLabel

conditionalParentLabelMetadata

getConditionalParentLabelMetadata

setConditionalParentLabelMetadata

conditionalParentValue