com.docusign.esign.model

Class SmartSection

java.lang.Object

com.docusign.esign.model.SmartSection

public class SmartSection
extends Object

SmartSection

Constructor Summary

Constructors

Constructor and Description
SmartSection()

Method Summary

Modifier and Type	Method and Description
SmartSection	addTabGroupLabelsItem(String tabGroupLabelsItem)
SmartSection	anchorCaseSensitive(String anchorCaseSensitive)
SmartSection	anchorHorizontalAlignment(String anchorHorizontalAlignment)
SmartSection	anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
SmartSection	anchorMatchWholeWord(String anchorMatchWholeWord)
SmartSection	anchorString(String anchorString)
SmartSection	anchorUnits(String anchorUnits)
SmartSection	anchorXOffset(String anchorXOffset)
SmartSection	anchorYOffset(String anchorYOffset)
SmartSection	caseSensitive(Boolean caseSensitive)
SmartSection	conditionalParentLabel(String conditionalParentLabel)
SmartSection	conditionalParentValue(String conditionalParentValue)
SmartSection	customTabId(String customTabId)
SmartSection	displaySettings(SmartSectionDisplaySettings displaySettings)
SmartSection	documentId(String documentId)
SmartSection	endAnchor(String endAnchor)
SmartSection	endPosition(SmartSectionAnchorPosition endPosition)
boolean	equals(Object o)
SmartSection	errorDetails(ErrorDetails errorDetails)
String	getAnchorCaseSensitive() When set to **true**, the anchor string does not consider case when matching strings in the document.
String	getAnchorHorizontalAlignment() Specifies the alignment of anchor tabs with anchor strings.
String	getAnchorIgnoreIfNotPresent() When set to **true**, this tab is ignored if anchorString is not found in the document.
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**.
String	getAnchorString() Anchor text information for a radio button.
String	getAnchorUnits() Specifies units of the X and Y offset.
String	getAnchorXOffset() Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
String	getAnchorYOffset() Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
String	getConditionalParentLabel() For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
String	getConditionalParentValue() For conditional fields, this is the value of the parent tab that controls the tab's visibility.
String	getCustomTabId() The DocuSign generated custom tab ID for the custom tab to be applied.
SmartSectionDisplaySettings	getDisplaySettings() Get displaySettings
String	getDocumentId() Specifies the document ID number that the tab is placed on.
String	getEndAnchor()
SmartSectionAnchorPosition	getEndPosition() Get endPosition
ErrorDetails	getErrorDetails() Get errorDetails
MergeField	getMergeField() Get mergeField
String	getPageNumber() Specifies the page number on which the tab is located.
String	getRecipientId() Unique for the recipient.
String	getStartAnchor()
SmartSectionAnchorPosition	getStartPosition() Get startPosition
String	getStatus() Indicates the envelope status.
List<String>	getTabGroupLabels()
String	getTabId() The unique identifier for the tab.
String	getTabOrder()
String	getTemplateLocked() When set to **true**, the sender cannot change any attributes of the recipient.
String	getTemplateRequired() When set to **true**, the sender may not remove the recipient.
String	getTooltip()
String	getXPosition() This indicates the horizontal offset of the object on the page.
String	getYPosition() This indicates the vertical offset of the object on the page.
int	hashCode()
Boolean	isCaseSensitive()
Boolean	isRemoveEndAnchor()
Boolean	isRemoveStartAnchor()
SmartSection	mergeField(MergeField mergeField)
SmartSection	pageNumber(String pageNumber)
SmartSection	recipientId(String recipientId)
SmartSection	removeEndAnchor(Boolean removeEndAnchor)
SmartSection	removeStartAnchor(Boolean removeStartAnchor)
void	setAnchorCaseSensitive(String anchorCaseSensitive)
void	setAnchorHorizontalAlignment(String anchorHorizontalAlignment)
void	setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
void	setAnchorMatchWholeWord(String anchorMatchWholeWord)
void	setAnchorString(String anchorString)
void	setAnchorUnits(String anchorUnits)
void	setAnchorXOffset(String anchorXOffset)
void	setAnchorYOffset(String anchorYOffset)
void	setCaseSensitive(Boolean caseSensitive)
void	setConditionalParentLabel(String conditionalParentLabel)
void	setConditionalParentValue(String conditionalParentValue)
void	setCustomTabId(String customTabId)
void	setDisplaySettings(SmartSectionDisplaySettings displaySettings)
void	setDocumentId(String documentId)
void	setEndAnchor(String endAnchor)
void	setEndPosition(SmartSectionAnchorPosition endPosition)
void	setErrorDetails(ErrorDetails errorDetails)
void	setMergeField(MergeField mergeField)
void	setPageNumber(String pageNumber)
void	setRecipientId(String recipientId)
void	setRemoveEndAnchor(Boolean removeEndAnchor)
void	setRemoveStartAnchor(Boolean removeStartAnchor)
void	setStartAnchor(String startAnchor)
void	setStartPosition(SmartSectionAnchorPosition startPosition)
void	setStatus(String status)
void	setTabGroupLabels(List<String> tabGroupLabels)
void	setTabId(String tabId)
void	setTabOrder(String tabOrder)
void	setTemplateLocked(String templateLocked)
void	setTemplateRequired(String templateRequired)
void	setTooltip(String tooltip)
void	setXPosition(String xPosition)
void	setYPosition(String yPosition)
SmartSection	startAnchor(String startAnchor)
SmartSection	startPosition(SmartSectionAnchorPosition startPosition)
SmartSection	status(String status)
SmartSection	tabGroupLabels(List<String> tabGroupLabels)
SmartSection	tabId(String tabId)
SmartSection	tabOrder(String tabOrder)
SmartSection	templateLocked(String templateLocked)
SmartSection	templateRequired(String templateRequired)
SmartSection	tooltip(String tooltip)
String	toString()
SmartSection	xPosition(String xPosition)
SmartSection	yPosition(String yPosition)

Methods inherited from class java.lang.Object

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

Constructor Detail

SmartSection

public SmartSection()

Method Detail

anchorCaseSensitive

public SmartSection 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)

anchorHorizontalAlignment

public SmartSection 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)

anchorIgnoreIfNotPresent

public SmartSection 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)

anchorMatchWholeWord

public SmartSection 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)

anchorString

public SmartSection anchorString(String anchorString)

getAnchorString

public String getAnchorString()

Anchor text information for a radio button.

Returns:

anchorString

setAnchorString

public void setAnchorString(String anchorString)

anchorUnits

public SmartSection 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)

anchorXOffset

public SmartSection 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)

anchorYOffset

public SmartSection 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)

caseSensitive

public SmartSection caseSensitive(Boolean caseSensitive)

isCaseSensitive

public Boolean isCaseSensitive()

Returns:

caseSensitive

setCaseSensitive

public void setCaseSensitive(Boolean caseSensitive)

conditionalParentLabel

public SmartSection 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)

conditionalParentValue

public SmartSection 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)

customTabId

public SmartSection 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)

displaySettings

public SmartSection displaySettings(SmartSectionDisplaySettings displaySettings)

getDisplaySettings

public SmartSectionDisplaySettings getDisplaySettings()

Get displaySettings

Returns:

displaySettings

setDisplaySettings

public void setDisplaySettings(SmartSectionDisplaySettings displaySettings)

documentId

public SmartSection 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)

endAnchor

public SmartSection endAnchor(String endAnchor)

getEndAnchor

public String getEndAnchor()

Returns:

endAnchor

setEndAnchor

public void setEndAnchor(String endAnchor)

endPosition

public SmartSection endPosition(SmartSectionAnchorPosition endPosition)

getEndPosition

public SmartSectionAnchorPosition getEndPosition()

Get endPosition

Returns:

endPosition

setEndPosition

public void setEndPosition(SmartSectionAnchorPosition endPosition)

errorDetails

public SmartSection errorDetails(ErrorDetails errorDetails)

getErrorDetails

public ErrorDetails getErrorDetails()

Get errorDetails

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

mergeField

public SmartSection mergeField(MergeField mergeField)

getMergeField

public MergeField getMergeField()

Get mergeField

Returns:

mergeField

setMergeField

public void setMergeField(MergeField mergeField)

pageNumber

public SmartSection 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)

recipientId

public SmartSection 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)

removeEndAnchor

public SmartSection removeEndAnchor(Boolean removeEndAnchor)

isRemoveEndAnchor

public Boolean isRemoveEndAnchor()

Returns:

removeEndAnchor

setRemoveEndAnchor

public void setRemoveEndAnchor(Boolean removeEndAnchor)

removeStartAnchor

public SmartSection removeStartAnchor(Boolean removeStartAnchor)

isRemoveStartAnchor

public Boolean isRemoveStartAnchor()

Returns:

removeStartAnchor

setRemoveStartAnchor

public void setRemoveStartAnchor(Boolean removeStartAnchor)

startAnchor

public SmartSection startAnchor(String startAnchor)

getStartAnchor

public String getStartAnchor()

Returns:

startAnchor

setStartAnchor

public void setStartAnchor(String startAnchor)

startPosition

public SmartSection startPosition(SmartSectionAnchorPosition startPosition)

getStartPosition

public SmartSectionAnchorPosition getStartPosition()

Get startPosition

Returns:

startPosition

setStartPosition

public void setStartPosition(SmartSectionAnchorPosition startPosition)

status

public SmartSection 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)

tabGroupLabels

public SmartSection tabGroupLabels(List<String> tabGroupLabels)

addTabGroupLabelsItem

public SmartSection addTabGroupLabelsItem(String tabGroupLabelsItem)

getTabGroupLabels

public List<String> getTabGroupLabels()

Returns:

tabGroupLabels

setTabGroupLabels

public void setTabGroupLabels(List<String> tabGroupLabels)

tabId

public SmartSection 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)

tabOrder

public SmartSection tabOrder(String tabOrder)

getTabOrder

public String getTabOrder()

Returns:

tabOrder

setTabOrder

public void setTabOrder(String tabOrder)

templateLocked

public SmartSection 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)

templateRequired

public SmartSection 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)

tooltip

public SmartSection tooltip(String tooltip)

getTooltip

public String getTooltip()

Returns:

tooltip

setTooltip

public void setTooltip(String tooltip)

xPosition

public SmartSection 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)

yPosition

public SmartSection 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)

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