com.docusign.esign.model

Class SignerAttachment

java.lang.Object

com.docusign.esign.model.SignerAttachment

public class SignerAttachment
extends Object

SignerAttachment

Constructor Summary

Constructors

Constructor and Description
SignerAttachment()

Method Summary

Methods

Modifier and Type	Method and Description
SignerAttachment	anchorCaseSensitive(String anchorCaseSensitive)
SignerAttachment	anchorHorizontalAlignment(String anchorHorizontalAlignment)
SignerAttachment	anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
SignerAttachment	anchorMatchWholeWord(String anchorMatchWholeWord)
SignerAttachment	anchorString(String anchorString)
SignerAttachment	anchorUnits(String anchorUnits)
SignerAttachment	anchorXOffset(String anchorXOffset)
SignerAttachment	anchorYOffset(String anchorYOffset)
SignerAttachment	conditionalParentLabel(String conditionalParentLabel)
SignerAttachment	conditionalParentValue(String conditionalParentValue)
SignerAttachment	customTabId(String customTabId)
SignerAttachment	documentId(String documentId)
boolean	equals(Object o)
SignerAttachment	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.
String	getDocumentId() Specifies the document ID number that the tab is placed on.
ErrorDetails	getErrorDetails() Get errorDetails
MergeField	getMergeField() Get mergeField
String	getName()
String	getOptional()
String	getPageNumber() Specifies the page number on which the tab is located.
String	getRecipientId() Unique for the recipient.
String	getScaleValue()
String	getStatus() Indicates the envelope status.
String	getTabId() The unique identifier for the tab.
String	getTabLabel() The label string associated with 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	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()
SignerAttachment	mergeField(MergeField mergeField)
SignerAttachment	name(String name)
SignerAttachment	optional(String optional)
SignerAttachment	pageNumber(String pageNumber)
SignerAttachment	recipientId(String recipientId)
SignerAttachment	scaleValue(String scaleValue)
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	setConditionalParentLabel(String conditionalParentLabel)
void	setConditionalParentValue(String conditionalParentValue)
void	setCustomTabId(String customTabId)
void	setDocumentId(String documentId)
void	setErrorDetails(ErrorDetails errorDetails)
void	setMergeField(MergeField mergeField)
void	setName(String name)
void	setOptional(String optional)
void	setPageNumber(String pageNumber)
void	setRecipientId(String recipientId)
void	setScaleValue(String scaleValue)
void	setStatus(String status)
void	setTabId(String tabId)
void	setTabLabel(String tabLabel)
void	setTabOrder(String tabOrder)
void	setTemplateLocked(String templateLocked)
void	setTemplateRequired(String templateRequired)
void	setXPosition(String xPosition)
void	setYPosition(String yPosition)
SignerAttachment	status(String status)
SignerAttachment	tabId(String tabId)
SignerAttachment	tabLabel(String tabLabel)
SignerAttachment	tabOrder(String tabOrder)
SignerAttachment	templateLocked(String templateLocked)
SignerAttachment	templateRequired(String templateRequired)
String	toString()
SignerAttachment	xPosition(String xPosition)
SignerAttachment	yPosition(String yPosition)

Methods inherited from class java.lang.Object

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

Constructor Detail

SignerAttachment

public SignerAttachment()

Method Detail

anchorCaseSensitive

public SignerAttachment 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 SignerAttachment 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 SignerAttachment 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 SignerAttachment 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 SignerAttachment anchorString(String anchorString)

getAnchorString

public String getAnchorString()

Anchor text information for a radio button.

Returns:

anchorString

setAnchorString

public void setAnchorString(String anchorString)

anchorUnits

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

conditionalParentLabel

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

documentId

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

errorDetails

public SignerAttachment errorDetails(ErrorDetails errorDetails)

getErrorDetails

public ErrorDetails getErrorDetails()

Get errorDetails

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

mergeField

public SignerAttachment mergeField(MergeField mergeField)

getMergeField

public MergeField getMergeField()

Get mergeField

Returns:

mergeField

setMergeField

public void setMergeField(MergeField mergeField)

name

public SignerAttachment name(String name)

getName

public String getName()

Returns:

name

setName

public void setName(String name)

optional

public SignerAttachment optional(String optional)

getOptional

public String getOptional()

Returns:

optional

setOptional

public void setOptional(String optional)

pageNumber

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

scaleValue

public SignerAttachment scaleValue(String scaleValue)

getScaleValue

public String getScaleValue()

Returns:

scaleValue

setScaleValue

public void setScaleValue(String scaleValue)

status

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

tabId

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

tabLabel

public SignerAttachment tabLabel(String tabLabel)

getTabLabel

public String getTabLabel()

The label string associated with the tab.

Returns:

tabLabel

setTabLabel

public void setTabLabel(String tabLabel)

tabOrder

public SignerAttachment tabOrder(String tabOrder)

getTabOrder

public String getTabOrder()

Returns:

tabOrder

setTabOrder

public void setTabOrder(String tabOrder)

templateLocked

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

xPosition

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