EnvelopeId (docusign-esign-java 2.4.0 API)

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

```
public class EnvelopeId
extends Object
```
EnvelopeId

Constructor Summary

Constructors
Constructor and Description

EnvelopeId()

Constructors
Constructor and Description
`EnvelopeId()`

Method Summary

Methods
Modifier and Type	Method and Description
`EnvelopeId`	`anchorCaseSensitive(String anchorCaseSensitive)`
`EnvelopeId`	`anchorHorizontalAlignment(String anchorHorizontalAlignment)`
`EnvelopeId`	`anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`
`EnvelopeId`	`anchorMatchWholeWord(String anchorMatchWholeWord)`
`EnvelopeId`	`anchorString(String anchorString)`
`EnvelopeId`	`anchorUnits(String anchorUnits)`
`EnvelopeId`	`anchorXOffset(String anchorXOffset)`
`EnvelopeId`	`anchorYOffset(String anchorYOffset)`
`EnvelopeId`	`bold(String bold)`
`EnvelopeId`	`conditionalParentLabel(String conditionalParentLabel)`
`EnvelopeId`	`conditionalParentValue(String conditionalParentValue)`
`EnvelopeId`	`customTabId(String customTabId)`
`EnvelopeId`	`documentId(String documentId)`
`boolean`	`equals(Object o)`
`EnvelopeId`	`errorDetails(ErrorDetails errorDetails)`
`EnvelopeId`	`font(String font)`
`EnvelopeId`	`fontColor(String fontColor)`
`EnvelopeId`	`fontSize(String fontSize)`
`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 achorUnits, relative to the anchorString.
`String`	`getAnchorYOffset()` Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
`String`	`getBold()` When set to true, the information in the tab is bold.
`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
`String`	`getFont()` The font to be used for the tab value.
`String`	`getFontColor()` The font color used for the information in the tab.
`String`	`getFontSize()` The font size used for the information in the tab.
`String`	`getItalic()` When set to true, the information in the tab is italic.
`MergeField`	`getMergeField()` Get mergeField
`String`	`getName()`
`String`	`getPageNumber()` Specifies the page number on which the tab is located.
`String`	`getRecipientId()` Unique for the recipient.
`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`	`getUnderline()` When set to true, the information in the tab is underlined.
`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()`
`EnvelopeId`	`italic(String italic)`
`EnvelopeId`	`mergeField(MergeField mergeField)`
`EnvelopeId`	`name(String name)`
`EnvelopeId`	`pageNumber(String pageNumber)`
`EnvelopeId`	`recipientId(String recipientId)`
`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`	`setBold(String bold)`
`void`	`setConditionalParentLabel(String conditionalParentLabel)`
`void`	`setConditionalParentValue(String conditionalParentValue)`
`void`	`setCustomTabId(String customTabId)`
`void`	`setDocumentId(String documentId)`
`void`	`setErrorDetails(ErrorDetails errorDetails)`
`void`	`setFont(String font)`
`void`	`setFontColor(String fontColor)`
`void`	`setFontSize(String fontSize)`
`void`	`setItalic(String italic)`
`void`	`setMergeField(MergeField mergeField)`
`void`	`setName(String name)`
`void`	`setPageNumber(String pageNumber)`
`void`	`setRecipientId(String recipientId)`
`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`	`setUnderline(String underline)`
`void`	`setXPosition(String xPosition)`
`void`	`setYPosition(String yPosition)`
`EnvelopeId`	`status(String status)`
`EnvelopeId`	`tabId(String tabId)`
`EnvelopeId`	`tabLabel(String tabLabel)`
`EnvelopeId`	`tabOrder(String tabOrder)`
`EnvelopeId`	`templateLocked(String templateLocked)`
`EnvelopeId`	`templateRequired(String templateRequired)`
`String`	`toString()`
`EnvelopeId`	`underline(String underline)`
`EnvelopeId`	`xPosition(String xPosition)`
`EnvelopeId`	`yPosition(String yPosition)`

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

- Constructor Detail
  - EnvelopeId
```
public EnvelopeId()
```
- Method Detail
  - 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)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - anchorXOffset
```
public EnvelopeId anchorXOffset(String anchorXOffset)
```
  - getAnchorXOffset
```
public String getAnchorXOffset()
```
    Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
    
    Returns:
    anchorXOffset
  - setAnchorXOffset
```
public void setAnchorXOffset(String anchorXOffset)
```
  - anchorYOffset
```
public EnvelopeId anchorYOffset(String anchorYOffset)
```
  - getAnchorYOffset
```
public String getAnchorYOffset()
```
    Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
    
    Returns:
    anchorYOffset
  - setAnchorYOffset
```
public void setAnchorYOffset(String anchorYOffset)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - mergeField
```
public EnvelopeId mergeField(MergeField mergeField)
```
  - getMergeField
```
public MergeField getMergeField()
```
    Get mergeField
    
    Returns:
    mergeField
  - setMergeField
```
public void setMergeField(MergeField mergeField)
```
  - name
```
public EnvelopeId name(String name)
```
  - getName
```
public String getName()
```
    Returns:
    name
  - setName
```
public void setName(String name)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - tabOrder
```
public EnvelopeId tabOrder(String tabOrder)
```
  - getTabOrder
```
public String getTabOrder()
```
    Returns:
    tabOrder
  - setTabOrder
```
public void setTabOrder(String tabOrder)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - 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)
```
  - 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 EnvelopeId

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnvelopeId

Method Detail

anchorCaseSensitive

getAnchorCaseSensitive

setAnchorCaseSensitive

anchorHorizontalAlignment

getAnchorHorizontalAlignment

setAnchorHorizontalAlignment

anchorIgnoreIfNotPresent

getAnchorIgnoreIfNotPresent

setAnchorIgnoreIfNotPresent

anchorMatchWholeWord

getAnchorMatchWholeWord

setAnchorMatchWholeWord

anchorString

getAnchorString

setAnchorString

anchorUnits

getAnchorUnits

setAnchorUnits

anchorXOffset

getAnchorXOffset

setAnchorXOffset

anchorYOffset

getAnchorYOffset

setAnchorYOffset

bold

getBold

setBold

conditionalParentLabel

getConditionalParentLabel

setConditionalParentLabel

conditionalParentValue

getConditionalParentValue

setConditionalParentValue

customTabId

getCustomTabId

setCustomTabId

documentId

getDocumentId

setDocumentId

errorDetails

getErrorDetails

setErrorDetails

font

getFont

setFont

fontColor

getFontColor

setFontColor

fontSize

getFontSize

setFontSize

italic

getItalic

setItalic

mergeField

getMergeField

setMergeField

name

getName

setName

pageNumber

getPageNumber

setPageNumber

recipientId

getRecipientId

setRecipientId

status

getStatus

setStatus

tabId

getTabId

setTabId

tabLabel