com.docusign.esign.model

Class EnvelopeId

java.lang.Object

com.docusign.esign.model.EnvelopeId

public class EnvelopeId
extends Object

EnvelopeId

Constructor Summary

Constructors

Constructor and Description
EnvelopeId()

Method Summary

Modifier and Type	Method and Description
EnvelopeId	addTabGroupLabelsItem(String tabGroupLabelsItem)
EnvelopeId	anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
EnvelopeId	anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
EnvelopeId	anchorCaseSensitive(String anchorCaseSensitive)
EnvelopeId	anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
EnvelopeId	anchorHorizontalAlignment(String anchorHorizontalAlignment)
EnvelopeId	anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
EnvelopeId	anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
EnvelopeId	anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
EnvelopeId	anchorMatchWholeWord(String anchorMatchWholeWord)
EnvelopeId	anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
EnvelopeId	anchorString(String anchorString)
EnvelopeId	anchorStringMetadata(PropertyMetadata anchorStringMetadata)
EnvelopeId	anchorTabProcessorVersion(String anchorTabProcessorVersion)
EnvelopeId	anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
EnvelopeId	anchorUnits(String anchorUnits)
EnvelopeId	anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
EnvelopeId	anchorXOffset(String anchorXOffset)
EnvelopeId	anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
EnvelopeId	anchorYOffset(String anchorYOffset)
EnvelopeId	anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
EnvelopeId	bold(String bold)
EnvelopeId	boldMetadata(PropertyMetadata boldMetadata)
EnvelopeId	conditionalParentLabel(String conditionalParentLabel)
EnvelopeId	conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
EnvelopeId	conditionalParentValue(String conditionalParentValue)
EnvelopeId	conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
EnvelopeId	customTabId(String customTabId)
EnvelopeId	customTabIdMetadata(PropertyMetadata customTabIdMetadata)
EnvelopeId	documentId(String documentId)
EnvelopeId	documentIdMetadata(PropertyMetadata documentIdMetadata)
boolean	equals(Object o)
EnvelopeId	errorDetails(ErrorDetails errorDetails)
EnvelopeId	font(String font)
EnvelopeId	fontColor(String fontColor)
EnvelopeId	fontColorMetadata(PropertyMetadata fontColorMetadata)
EnvelopeId	fontMetadata(PropertyMetadata fontMetadata)
EnvelopeId	fontSize(String fontSize)
EnvelopeId	fontSizeMetadata(PropertyMetadata fontSizeMetadata)
EnvelopeId	formOrder(String formOrder)
EnvelopeId	formOrderMetadata(PropertyMetadata formOrderMetadata)
EnvelopeId	formPageLabel(String formPageLabel)
EnvelopeId	formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
EnvelopeId	formPageNumber(String formPageNumber)
EnvelopeId	formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
String	getAnchorAllowWhiteSpaceInCharacters()
PropertyMetadata	getAnchorAllowWhiteSpaceInCharactersMetadata() Get anchorAllowWhiteSpaceInCharactersMetadata
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	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	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
MergeField	getMergeField() Get mergeField
String	getMergeFieldXml()
String	getName()
PropertyMetadata	getNameMetadata() Get nameMetadata
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
SmartContractInformation	getSmartContractInformation() Get smartContractInformation
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	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()
EnvelopeId	height(String height)
EnvelopeId	heightMetadata(PropertyMetadata heightMetadata)
EnvelopeId	italic(String italic)
EnvelopeId	italicMetadata(PropertyMetadata italicMetadata)
EnvelopeId	localePolicy(LocalePolicyTab localePolicy)
EnvelopeId	mergeField(MergeField mergeField)
EnvelopeId	mergeFieldXml(String mergeFieldXml)
EnvelopeId	name(String name)
EnvelopeId	nameMetadata(PropertyMetadata nameMetadata)
EnvelopeId	pageNumber(String pageNumber)
EnvelopeId	pageNumberMetadata(PropertyMetadata pageNumberMetadata)
EnvelopeId	recipientId(String recipientId)
EnvelopeId	recipientIdGuid(String recipientIdGuid)
EnvelopeId	recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
EnvelopeId	recipientIdMetadata(PropertyMetadata recipientIdMetadata)
void	setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
void	setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
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	setConditionalParentLabel(String conditionalParentLabel)
void	setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
void	setConditionalParentValue(String conditionalParentValue)
void	setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
void	setCustomTabId(String customTabId)
void	setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)
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	setMergeField(MergeField mergeField)
void	setMergeFieldXml(String mergeFieldXml)
void	setName(String name)
void	setNameMetadata(PropertyMetadata nameMetadata)
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	setSmartContractInformation(SmartContractInformation smartContractInformation)
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	setWidth(String width)
void	setWidthMetadata(PropertyMetadata widthMetadata)
void	setXPosition(String xPosition)
void	setXPositionMetadata(PropertyMetadata xPositionMetadata)
void	setYPosition(String yPosition)
void	setYPositionMetadata(PropertyMetadata yPositionMetadata)
EnvelopeId	smartContractInformation(SmartContractInformation smartContractInformation)
EnvelopeId	status(String status)
EnvelopeId	statusMetadata(PropertyMetadata statusMetadata)
EnvelopeId	tabGroupLabels(List<String> tabGroupLabels)
EnvelopeId	tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
EnvelopeId	tabId(String tabId)
EnvelopeId	tabIdMetadata(PropertyMetadata tabIdMetadata)
EnvelopeId	tabLabel(String tabLabel)
EnvelopeId	tabLabelMetadata(PropertyMetadata tabLabelMetadata)
EnvelopeId	tabOrder(String tabOrder)
EnvelopeId	tabOrderMetadata(PropertyMetadata tabOrderMetadata)
EnvelopeId	tabType(String tabType)
EnvelopeId	tabTypeMetadata(PropertyMetadata tabTypeMetadata)
EnvelopeId	templateLocked(String templateLocked)
EnvelopeId	templateLockedMetadata(PropertyMetadata templateLockedMetadata)
EnvelopeId	templateRequired(String templateRequired)
EnvelopeId	templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
EnvelopeId	tooltip(String tooltip)
EnvelopeId	toolTipMetadata(PropertyMetadata toolTipMetadata)
String	toString()
EnvelopeId	underline(String underline)
EnvelopeId	underlineMetadata(PropertyMetadata underlineMetadata)
EnvelopeId	width(String width)
EnvelopeId	widthMetadata(PropertyMetadata widthMetadata)
EnvelopeId	xPosition(String xPosition)
EnvelopeId	xPositionMetadata(PropertyMetadata xPositionMetadata)
EnvelopeId	yPosition(String yPosition)
EnvelopeId	yPositionMetadata(PropertyMetadata yPositionMetadata)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EnvelopeId

public EnvelopeId()

Method Detail

anchorAllowWhiteSpaceInCharacters

public EnvelopeId anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)

getAnchorAllowWhiteSpaceInCharacters

public String getAnchorAllowWhiteSpaceInCharacters()

Returns:

anchorAllowWhiteSpaceInCharacters

setAnchorAllowWhiteSpaceInCharacters

public void setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)

anchorAllowWhiteSpaceInCharactersMetadata

public EnvelopeId anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)

getAnchorAllowWhiteSpaceInCharactersMetadata

public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()

Get anchorAllowWhiteSpaceInCharactersMetadata

Returns:

anchorAllowWhiteSpaceInCharactersMetadata

setAnchorAllowWhiteSpaceInCharactersMetadata

public void setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)

anchorCaseSensitive

public EnvelopeId 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 EnvelopeId anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)

getAnchorCaseSensitiveMetadata

public PropertyMetadata getAnchorCaseSensitiveMetadata()

Get anchorCaseSensitiveMetadata

Returns:

anchorCaseSensitiveMetadata

setAnchorCaseSensitiveMetadata

public void setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)

anchorHorizontalAlignment

public EnvelopeId 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 EnvelopeId anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)

getAnchorHorizontalAlignmentMetadata

public PropertyMetadata getAnchorHorizontalAlignmentMetadata()

Get anchorHorizontalAlignmentMetadata

Returns:

anchorHorizontalAlignmentMetadata

setAnchorHorizontalAlignmentMetadata

public void setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)

anchorIgnoreIfNotPresent

public EnvelopeId 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 EnvelopeId anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)

getAnchorIgnoreIfNotPresentMetadata

public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()

Get anchorIgnoreIfNotPresentMetadata

Returns:

anchorIgnoreIfNotPresentMetadata

setAnchorIgnoreIfNotPresentMetadata

public void setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)

anchorMatchWholeWord

public EnvelopeId 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 EnvelopeId anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)

getAnchorMatchWholeWordMetadata

public PropertyMetadata getAnchorMatchWholeWordMetadata()

Get anchorMatchWholeWordMetadata

Returns:

anchorMatchWholeWordMetadata

setAnchorMatchWholeWordMetadata

public void setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)

anchorString

public EnvelopeId anchorString(String anchorString)

getAnchorString

public String getAnchorString()

Anchor text information for a radio button.

Returns:

anchorString

setAnchorString

public void setAnchorString(String anchorString)

anchorStringMetadata

public EnvelopeId anchorStringMetadata(PropertyMetadata anchorStringMetadata)

getAnchorStringMetadata

public PropertyMetadata getAnchorStringMetadata()

Get anchorStringMetadata

Returns:

anchorStringMetadata

setAnchorStringMetadata

public void setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)

anchorTabProcessorVersion

public EnvelopeId anchorTabProcessorVersion(String anchorTabProcessorVersion)

getAnchorTabProcessorVersion

public String getAnchorTabProcessorVersion()

Returns:

anchorTabProcessorVersion

setAnchorTabProcessorVersion

public void setAnchorTabProcessorVersion(String anchorTabProcessorVersion)

anchorTabProcessorVersionMetadata

public EnvelopeId anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)

getAnchorTabProcessorVersionMetadata

public PropertyMetadata getAnchorTabProcessorVersionMetadata()

Get anchorTabProcessorVersionMetadata

Returns:

anchorTabProcessorVersionMetadata

setAnchorTabProcessorVersionMetadata

public void setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)

anchorUnits

public EnvelopeId 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 EnvelopeId anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)

getAnchorUnitsMetadata

public PropertyMetadata getAnchorUnitsMetadata()

Get anchorUnitsMetadata

Returns:

anchorUnitsMetadata

setAnchorUnitsMetadata

public void setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)

anchorXOffset

public EnvelopeId 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 EnvelopeId anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)

getAnchorXOffsetMetadata

public PropertyMetadata getAnchorXOffsetMetadata()

Get anchorXOffsetMetadata

Returns:

anchorXOffsetMetadata

setAnchorXOffsetMetadata

public void setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)

anchorYOffset

public EnvelopeId 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 EnvelopeId anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)

getAnchorYOffsetMetadata

public PropertyMetadata getAnchorYOffsetMetadata()

Get anchorYOffsetMetadata

Returns:

anchorYOffsetMetadata

setAnchorYOffsetMetadata

public void setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)

bold

public EnvelopeId 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 EnvelopeId boldMetadata(PropertyMetadata boldMetadata)

getBoldMetadata

public PropertyMetadata getBoldMetadata()

Get boldMetadata

Returns:

boldMetadata

setBoldMetadata

public void setBoldMetadata(PropertyMetadata boldMetadata)

conditionalParentLabel

public EnvelopeId 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 EnvelopeId conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)

getConditionalParentLabelMetadata

public PropertyMetadata getConditionalParentLabelMetadata()

Get conditionalParentLabelMetadata

Returns:

conditionalParentLabelMetadata

setConditionalParentLabelMetadata

public void setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)

conditionalParentValue

public EnvelopeId 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 EnvelopeId conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)

getConditionalParentValueMetadata

public PropertyMetadata getConditionalParentValueMetadata()

Get conditionalParentValueMetadata

Returns:

conditionalParentValueMetadata

setConditionalParentValueMetadata

public void setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)

customTabId

public EnvelopeId 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 EnvelopeId customTabIdMetadata(PropertyMetadata customTabIdMetadata)

getCustomTabIdMetadata

public PropertyMetadata getCustomTabIdMetadata()

Get customTabIdMetadata

Returns:

customTabIdMetadata

setCustomTabIdMetadata

public void setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)

documentId

public EnvelopeId 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 EnvelopeId documentIdMetadata(PropertyMetadata documentIdMetadata)

getDocumentIdMetadata

public PropertyMetadata getDocumentIdMetadata()

Get documentIdMetadata

Returns:

documentIdMetadata

setDocumentIdMetadata

public void setDocumentIdMetadata(PropertyMetadata documentIdMetadata)

errorDetails

public EnvelopeId errorDetails(ErrorDetails errorDetails)

getErrorDetails

public ErrorDetails getErrorDetails()

Get errorDetails

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

font

public EnvelopeId 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 EnvelopeId 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 EnvelopeId fontColorMetadata(PropertyMetadata fontColorMetadata)

getFontColorMetadata

public PropertyMetadata getFontColorMetadata()

Get fontColorMetadata

Returns:

fontColorMetadata

setFontColorMetadata

public void setFontColorMetadata(PropertyMetadata fontColorMetadata)

fontMetadata

public EnvelopeId fontMetadata(PropertyMetadata fontMetadata)

getFontMetadata

public PropertyMetadata getFontMetadata()

Get fontMetadata

Returns:

fontMetadata

setFontMetadata

public void setFontMetadata(PropertyMetadata fontMetadata)

fontSize

public EnvelopeId 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 EnvelopeId fontSizeMetadata(PropertyMetadata fontSizeMetadata)

getFontSizeMetadata

public PropertyMetadata getFontSizeMetadata()

Get fontSizeMetadata

Returns:

fontSizeMetadata

setFontSizeMetadata

public void setFontSizeMetadata(PropertyMetadata fontSizeMetadata)

formOrder

public EnvelopeId formOrder(String formOrder)

getFormOrder

public String getFormOrder()

Returns:

formOrder

setFormOrder

public void setFormOrder(String formOrder)

formOrderMetadata

public EnvelopeId formOrderMetadata(PropertyMetadata formOrderMetadata)

getFormOrderMetadata

public PropertyMetadata getFormOrderMetadata()

Get formOrderMetadata

Returns:

formOrderMetadata

setFormOrderMetadata

public void setFormOrderMetadata(PropertyMetadata formOrderMetadata)

formPageLabel

public EnvelopeId formPageLabel(String formPageLabel)

getFormPageLabel

public String getFormPageLabel()

Returns:

formPageLabel

setFormPageLabel

public void setFormPageLabel(String formPageLabel)

formPageLabelMetadata

public EnvelopeId formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)

getFormPageLabelMetadata

public PropertyMetadata getFormPageLabelMetadata()

Get formPageLabelMetadata

Returns:

formPageLabelMetadata

setFormPageLabelMetadata

public void setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)

formPageNumber

public EnvelopeId formPageNumber(String formPageNumber)

getFormPageNumber

public String getFormPageNumber()

Returns:

formPageNumber

setFormPageNumber

public void setFormPageNumber(String formPageNumber)

formPageNumberMetadata

public EnvelopeId formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)

getFormPageNumberMetadata

public PropertyMetadata getFormPageNumberMetadata()

Get formPageNumberMetadata

Returns:

formPageNumberMetadata

setFormPageNumberMetadata

public void setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)

height

public EnvelopeId height(String height)

getHeight

public String getHeight()

Height of the tab in pixels.

Returns:

height

setHeight

public void setHeight(String height)

heightMetadata

public EnvelopeId heightMetadata(PropertyMetadata heightMetadata)

getHeightMetadata

public PropertyMetadata getHeightMetadata()

Get heightMetadata

Returns:

heightMetadata

setHeightMetadata

public void setHeightMetadata(PropertyMetadata heightMetadata)

italic

public EnvelopeId 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 EnvelopeId italicMetadata(PropertyMetadata italicMetadata)

getItalicMetadata

public PropertyMetadata getItalicMetadata()

Get italicMetadata

Returns:

italicMetadata

setItalicMetadata

public void setItalicMetadata(PropertyMetadata italicMetadata)

localePolicy

public EnvelopeId localePolicy(LocalePolicyTab localePolicy)

getLocalePolicy

public LocalePolicyTab getLocalePolicy()

Get localePolicy

Returns:

localePolicy

setLocalePolicy

public void setLocalePolicy(LocalePolicyTab localePolicy)

mergeField

public EnvelopeId mergeField(MergeField mergeField)

getMergeField

public MergeField getMergeField()

Get mergeField

Returns:

mergeField

setMergeField

public void setMergeField(MergeField mergeField)

mergeFieldXml

public EnvelopeId mergeFieldXml(String mergeFieldXml)

getMergeFieldXml

public String getMergeFieldXml()

Returns:

mergeFieldXml

setMergeFieldXml

public void setMergeFieldXml(String mergeFieldXml)

name

public EnvelopeId name(String name)

getName

public String getName()

Returns:

name

setName

public void setName(String name)

nameMetadata

public EnvelopeId nameMetadata(PropertyMetadata nameMetadata)

getNameMetadata

public PropertyMetadata getNameMetadata()

Get nameMetadata

Returns:

nameMetadata

setNameMetadata

public void setNameMetadata(PropertyMetadata nameMetadata)

pageNumber

public EnvelopeId 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 EnvelopeId pageNumberMetadata(PropertyMetadata pageNumberMetadata)

getPageNumberMetadata

public PropertyMetadata getPageNumberMetadata()

Get pageNumberMetadata

Returns:

pageNumberMetadata

setPageNumberMetadata

public void setPageNumberMetadata(PropertyMetadata pageNumberMetadata)

recipientId

public EnvelopeId 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 EnvelopeId recipientIdGuid(String recipientIdGuid)

getRecipientIdGuid

public String getRecipientIdGuid()

Returns:

recipientIdGuid

setRecipientIdGuid

public void setRecipientIdGuid(String recipientIdGuid)

recipientIdGuidMetadata

public EnvelopeId recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)

getRecipientIdGuidMetadata

public PropertyMetadata getRecipientIdGuidMetadata()

Get recipientIdGuidMetadata

Returns:

recipientIdGuidMetadata

setRecipientIdGuidMetadata

public void setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)

recipientIdMetadata

public EnvelopeId recipientIdMetadata(PropertyMetadata recipientIdMetadata)

getRecipientIdMetadata

public PropertyMetadata getRecipientIdMetadata()

Get recipientIdMetadata

Returns:

recipientIdMetadata

setRecipientIdMetadata

public void setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)

smartContractInformation

public EnvelopeId smartContractInformation(SmartContractInformation smartContractInformation)

getSmartContractInformation

public SmartContractInformation getSmartContractInformation()

Get smartContractInformation

Returns:

smartContractInformation

setSmartContractInformation

public void setSmartContractInformation(SmartContractInformation smartContractInformation)

status

public EnvelopeId 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 EnvelopeId statusMetadata(PropertyMetadata statusMetadata)

getStatusMetadata

public PropertyMetadata getStatusMetadata()

Get statusMetadata

Returns:

statusMetadata

setStatusMetadata

public void setStatusMetadata(PropertyMetadata statusMetadata)

tabGroupLabels

public EnvelopeId tabGroupLabels(List<String> tabGroupLabels)

addTabGroupLabelsItem

public EnvelopeId addTabGroupLabelsItem(String tabGroupLabelsItem)

getTabGroupLabels

public List<String> getTabGroupLabels()

Returns:

tabGroupLabels

setTabGroupLabels

public void setTabGroupLabels(List<String> tabGroupLabels)

tabGroupLabelsMetadata

public EnvelopeId tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)

getTabGroupLabelsMetadata

public PropertyMetadata getTabGroupLabelsMetadata()

Get tabGroupLabelsMetadata

Returns:

tabGroupLabelsMetadata

setTabGroupLabelsMetadata

public void setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)

tabId

public EnvelopeId 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 EnvelopeId tabIdMetadata(PropertyMetadata tabIdMetadata)

getTabIdMetadata

public PropertyMetadata getTabIdMetadata()

Get tabIdMetadata

Returns:

tabIdMetadata

setTabIdMetadata

public void setTabIdMetadata(PropertyMetadata tabIdMetadata)

tabLabel

public EnvelopeId tabLabel(String tabLabel)

getTabLabel

public String getTabLabel()

The label string associated with the tab.

Returns:

tabLabel

setTabLabel

public void setTabLabel(String tabLabel)

tabLabelMetadata

public EnvelopeId tabLabelMetadata(PropertyMetadata tabLabelMetadata)

getTabLabelMetadata

public PropertyMetadata getTabLabelMetadata()

Get tabLabelMetadata

Returns:

tabLabelMetadata

setTabLabelMetadata

public void setTabLabelMetadata(PropertyMetadata tabLabelMetadata)

tabOrder

public EnvelopeId tabOrder(String tabOrder)

getTabOrder

public String getTabOrder()

Returns:

tabOrder

setTabOrder

public void setTabOrder(String tabOrder)

tabOrderMetadata

public EnvelopeId tabOrderMetadata(PropertyMetadata tabOrderMetadata)

getTabOrderMetadata

public PropertyMetadata getTabOrderMetadata()

Get tabOrderMetadata

Returns:

tabOrderMetadata

setTabOrderMetadata

public void setTabOrderMetadata(PropertyMetadata tabOrderMetadata)

tabType

public EnvelopeId tabType(String tabType)

getTabType

public String getTabType()

Returns:

tabType

setTabType

public void setTabType(String tabType)

tabTypeMetadata

public EnvelopeId tabTypeMetadata(PropertyMetadata tabTypeMetadata)

getTabTypeMetadata

public PropertyMetadata getTabTypeMetadata()

Get tabTypeMetadata

Returns:

tabTypeMetadata

setTabTypeMetadata

public void setTabTypeMetadata(PropertyMetadata tabTypeMetadata)

templateLocked

public EnvelopeId 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 EnvelopeId templateLockedMetadata(PropertyMetadata templateLockedMetadata)

getTemplateLockedMetadata

public PropertyMetadata getTemplateLockedMetadata()

Get templateLockedMetadata

Returns:

templateLockedMetadata

setTemplateLockedMetadata

public void setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)

templateRequired

public EnvelopeId 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 EnvelopeId templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)

getTemplateRequiredMetadata

public PropertyMetadata getTemplateRequiredMetadata()

Get templateRequiredMetadata

Returns:

templateRequiredMetadata

setTemplateRequiredMetadata

public void setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)

tooltip

public EnvelopeId tooltip(String tooltip)

getTooltip

public String getTooltip()

Returns:

tooltip

setTooltip

public void setTooltip(String tooltip)

toolTipMetadata

public EnvelopeId toolTipMetadata(PropertyMetadata toolTipMetadata)

getToolTipMetadata

public PropertyMetadata getToolTipMetadata()

Get toolTipMetadata

Returns:

toolTipMetadata

setToolTipMetadata

public void setToolTipMetadata(PropertyMetadata toolTipMetadata)

underline

public EnvelopeId 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 EnvelopeId underlineMetadata(PropertyMetadata underlineMetadata)

getUnderlineMetadata

public PropertyMetadata getUnderlineMetadata()

Get underlineMetadata

Returns:

underlineMetadata

setUnderlineMetadata

public void setUnderlineMetadata(PropertyMetadata underlineMetadata)

width

public EnvelopeId width(String width)

getWidth

public String getWidth()

Width of the tab in pixels.

Returns:

width

setWidth

public void setWidth(String width)

widthMetadata

public EnvelopeId widthMetadata(PropertyMetadata widthMetadata)

getWidthMetadata

public PropertyMetadata getWidthMetadata()

Get widthMetadata

Returns:

widthMetadata

setWidthMetadata

public void setWidthMetadata(PropertyMetadata widthMetadata)

xPosition

public EnvelopeId 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 EnvelopeId xPositionMetadata(PropertyMetadata xPositionMetadata)

getXPositionMetadata

public PropertyMetadata getXPositionMetadata()

Get xPositionMetadata

Returns:

xPositionMetadata

setXPositionMetadata

public void setXPositionMetadata(PropertyMetadata xPositionMetadata)

yPosition

public EnvelopeId 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 EnvelopeId 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