Package com.docusign.esign.model
Class SignHere
- java.lang.Object
-
- com.docusign.esign.model.SignHere
-
public class SignHere extends Object
SignHere.
-
-
Constructor Summary
Constructors Constructor Description SignHere()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description SignHereaddTabGroupLabelsItem(String tabGroupLabelsItem)addTabGroupLabelsItem.SignHereanchorCaseSensitive(String anchorCaseSensitive)anchorCaseSensitive.SignHereanchorHorizontalAlignment(String anchorHorizontalAlignment)anchorHorizontalAlignment.SignHereanchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)anchorIgnoreIfNotPresent.SignHereanchorMatchWholeWord(String anchorMatchWholeWord)anchorMatchWholeWord.SignHereanchorString(String anchorString)anchorString.SignHereanchorUnits(String anchorUnits)anchorUnits.SignHereanchorXOffset(String anchorXOffset)anchorXOffset.SignHereanchorYOffset(String anchorYOffset)anchorYOffset.SignHereconditionalParentLabel(String conditionalParentLabel)conditionalParentLabel.SignHereconditionalParentValue(String conditionalParentValue)conditionalParentValue.SignHerecustomTabId(String customTabId)customTabId.SignHeredocumentId(String documentId)documentId.booleanequals(Object o)Compares objects.SignHereerrorDetails(ErrorDetails errorDetails)errorDetails.StringgetAnchorCaseSensitive()When set to **true**, the anchor string does not consider case when matching strings in the document.StringgetAnchorHorizontalAlignment()Specifies the alignment of anchor tabs with anchor strings.StringgetAnchorIgnoreIfNotPresent()When set to **true**, this tab is ignored if anchorString is not found in the document..StringgetAnchorMatchWholeWord()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**..StringgetAnchorString()Anchor text information for a radio button..StringgetAnchorUnits()Specifies units of the X and Y offset.StringgetAnchorXOffset()Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..StringgetAnchorYOffset()Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..StringgetConditionalParentLabel()For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility..StringgetConditionalParentValue()For conditional fields, this is the value of the parent tab that controls the tab's visibility.StringgetCustomTabId()The DocuSign generated custom tab ID for the custom tab to be applied.StringgetDocumentId()Specifies the document ID number that the tab is placed on.ErrorDetailsgetErrorDetails()Get errorDetails.MergeFieldgetMergeField()Get mergeField.StringgetName()Specifies the tool tip text for the tab..StringgetOptional().StringgetPageNumber()Specifies the page number on which the tab is located..StringgetRecipientId()Unique for the recipient.StringgetScaleValue().StringgetStampType().PropertyMetadatagetStampTypeMetadata()Get stampTypeMetadata.StringgetStatus()Indicates the envelope status.List<String>getTabGroupLabels().StringgetTabId()The unique identifier for the tab.StringgetTabLabel()The label string associated with the tab..StringgetTabOrder().StringgetTemplateLocked()When set to **true**, the sender cannot change any attributes of the recipient.StringgetTemplateRequired()When set to **true**, the sender may not remove the recipient.StringgetTooltip().StringgetXPosition()This indicates the horizontal offset of the object on the page.StringgetYPosition()This indicates the vertical offset of the object on the page.inthashCode()Returns the HashCode.SignHeremergeField(MergeField mergeField)mergeField.SignHerename(String name)name.SignHereoptional(String optional)optional.SignHerepageNumber(String pageNumber)pageNumber.SignHererecipientId(String recipientId)recipientId.SignHerescaleValue(String scaleValue)scaleValue.voidsetAnchorCaseSensitive(String anchorCaseSensitive)setAnchorCaseSensitive.voidsetAnchorHorizontalAlignment(String anchorHorizontalAlignment)setAnchorHorizontalAlignment.voidsetAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)setAnchorIgnoreIfNotPresent.voidsetAnchorMatchWholeWord(String anchorMatchWholeWord)setAnchorMatchWholeWord.voidsetAnchorString(String anchorString)setAnchorString.voidsetAnchorUnits(String anchorUnits)setAnchorUnits.voidsetAnchorXOffset(String anchorXOffset)setAnchorXOffset.voidsetAnchorYOffset(String anchorYOffset)setAnchorYOffset.voidsetConditionalParentLabel(String conditionalParentLabel)setConditionalParentLabel.voidsetConditionalParentValue(String conditionalParentValue)setConditionalParentValue.voidsetCustomTabId(String customTabId)setCustomTabId.voidsetDocumentId(String documentId)setDocumentId.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetMergeField(MergeField mergeField)setMergeField.voidsetName(String name)setName.voidsetOptional(String optional)setOptional.voidsetPageNumber(String pageNumber)setPageNumber.voidsetRecipientId(String recipientId)setRecipientId.voidsetScaleValue(String scaleValue)setScaleValue.voidsetStampType(String stampType)setStampType.voidsetStampTypeMetadata(PropertyMetadata stampTypeMetadata)setStampTypeMetadata.voidsetStatus(String status)setStatus.voidsetTabGroupLabels(List<String> tabGroupLabels)setTabGroupLabels.voidsetTabId(String tabId)setTabId.voidsetTabLabel(String tabLabel)setTabLabel.voidsetTabOrder(String tabOrder)setTabOrder.voidsetTemplateLocked(String templateLocked)setTemplateLocked.voidsetTemplateRequired(String templateRequired)setTemplateRequired.voidsetTooltip(String tooltip)setTooltip.voidsetXPosition(String xPosition)setXPosition.voidsetYPosition(String yPosition)setYPosition.SignHerestampType(String stampType)stampType.SignHerestampTypeMetadata(PropertyMetadata stampTypeMetadata)stampTypeMetadata.SignHerestatus(String status)status.SignHeretabGroupLabels(List<String> tabGroupLabels)tabGroupLabels.SignHeretabId(String tabId)tabId.SignHeretabLabel(String tabLabel)tabLabel.SignHeretabOrder(String tabOrder)tabOrder.SignHeretemplateLocked(String templateLocked)templateLocked.SignHeretemplateRequired(String templateRequired)templateRequired.SignHeretooltip(String tooltip)tooltip.StringtoString()Converts the given object to string.SignHerexPosition(String xPosition)xPosition.SignHereyPosition(String yPosition)yPosition.
-
-
-
Method Detail
-
anchorCaseSensitive
public SignHere anchorCaseSensitive(String anchorCaseSensitive)
anchorCaseSensitive.- Returns:
- SignHere
-
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)
setAnchorCaseSensitive.
-
anchorHorizontalAlignment
public SignHere anchorHorizontalAlignment(String anchorHorizontalAlignment)
anchorHorizontalAlignment.- Returns:
- SignHere
-
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)
setAnchorHorizontalAlignment.
-
anchorIgnoreIfNotPresent
public SignHere anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
anchorIgnoreIfNotPresent.- Returns:
- SignHere
-
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)
setAnchorIgnoreIfNotPresent.
-
anchorMatchWholeWord
public SignHere anchorMatchWholeWord(String anchorMatchWholeWord)
anchorMatchWholeWord.- Returns:
- SignHere
-
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)
setAnchorMatchWholeWord.
-
getAnchorString
public String getAnchorString()
Anchor text information for a radio button..- Returns:
- anchorString
-
setAnchorString
public void setAnchorString(String anchorString)
setAnchorString.
-
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)
setAnchorUnits.
-
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)
setAnchorXOffset.
-
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)
setAnchorYOffset.
-
conditionalParentLabel
public SignHere conditionalParentLabel(String conditionalParentLabel)
conditionalParentLabel.- Returns:
- SignHere
-
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)
setConditionalParentLabel.
-
conditionalParentValue
public SignHere conditionalParentValue(String conditionalParentValue)
conditionalParentValue.- Returns:
- SignHere
-
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)
setConditionalParentValue.
-
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)
setCustomTabId.
-
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)
setDocumentId.
-
errorDetails
public SignHere errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- SignHere
-
getErrorDetails
public ErrorDetails getErrorDetails()
Get errorDetails.- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
mergeField
public SignHere mergeField(MergeField mergeField)
mergeField.- Returns:
- SignHere
-
getMergeField
public MergeField getMergeField()
Get mergeField.- Returns:
- mergeField
-
setMergeField
public void setMergeField(MergeField mergeField)
setMergeField.
-
getName
public String getName()
Specifies the tool tip text for the tab..- Returns:
- name
-
setName
public void setName(String name)
setName.
-
getOptional
public String getOptional()
.- Returns:
- optional
-
setOptional
public void setOptional(String optional)
setOptional.
-
getPageNumber
public String getPageNumber()
Specifies the page number on which the tab is located..- Returns:
- pageNumber
-
setPageNumber
public void setPageNumber(String pageNumber)
setPageNumber.
-
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)
setRecipientId.
-
getScaleValue
public String getScaleValue()
.- Returns:
- scaleValue
-
setScaleValue
public void setScaleValue(String scaleValue)
setScaleValue.
-
getStampType
public String getStampType()
.- Returns:
- stampType
-
setStampType
public void setStampType(String stampType)
setStampType.
-
stampTypeMetadata
public SignHere stampTypeMetadata(PropertyMetadata stampTypeMetadata)
stampTypeMetadata.- Returns:
- SignHere
-
getStampTypeMetadata
public PropertyMetadata getStampTypeMetadata()
Get stampTypeMetadata.- Returns:
- stampTypeMetadata
-
setStampTypeMetadata
public void setStampTypeMetadata(PropertyMetadata stampTypeMetadata)
setStampTypeMetadata.
-
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)
setStatus.
-
tabGroupLabels
public SignHere tabGroupLabels(List<String> tabGroupLabels)
tabGroupLabels.- Returns:
- SignHere
-
addTabGroupLabelsItem
public SignHere addTabGroupLabelsItem(String tabGroupLabelsItem)
addTabGroupLabelsItem.- Returns:
- SignHere
-
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)
setTabId.
-
getTabLabel
public String getTabLabel()
The label string associated with the tab..- Returns:
- tabLabel
-
setTabLabel
public void setTabLabel(String tabLabel)
setTabLabel.
-
getTabOrder
public String getTabOrder()
.- Returns:
- tabOrder
-
setTabOrder
public void setTabOrder(String tabOrder)
setTabOrder.
-
templateLocked
public SignHere templateLocked(String templateLocked)
templateLocked.- Returns:
- SignHere
-
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)
setTemplateLocked.
-
templateRequired
public SignHere templateRequired(String templateRequired)
templateRequired.- Returns:
- SignHere
-
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)
setTemplateRequired.
-
getTooltip
public String getTooltip()
.- Returns:
- tooltip
-
setTooltip
public void setTooltip(String tooltip)
setTooltip.
-
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)
setXPosition.
-
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)
setYPosition.
-
equals
public boolean equals(Object o)
Compares objects.
-
-