Package com.docusign.esign.model
Class Company
- java.lang.Object
-
- com.docusign.esign.model.Company
-
- All Implemented Interfaces:
Serializable
public class Company extends Object implements Serializable
A tab that displays the recipient's company name. .- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description Company()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description CompanyaddTabGroupLabelsItem(String tabGroupLabelsItem)addTabGroupLabelsItem.CompanyanchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)anchorAllowWhiteSpaceInCharacters.CompanyanchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)anchorAllowWhiteSpaceInCharactersMetadata.CompanyanchorCaseSensitive(String anchorCaseSensitive)anchorCaseSensitive.CompanyanchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)anchorCaseSensitiveMetadata.CompanyanchorHorizontalAlignment(String anchorHorizontalAlignment)anchorHorizontalAlignment.CompanyanchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)anchorHorizontalAlignmentMetadata.CompanyanchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)anchorIgnoreIfNotPresent.CompanyanchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)anchorIgnoreIfNotPresentMetadata.CompanyanchorMatchWholeWord(String anchorMatchWholeWord)anchorMatchWholeWord.CompanyanchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)anchorMatchWholeWordMetadata.CompanyanchorString(String anchorString)anchorString.CompanyanchorStringMetadata(PropertyMetadata anchorStringMetadata)anchorStringMetadata.CompanyanchorTabProcessorVersion(String anchorTabProcessorVersion)anchorTabProcessorVersion.CompanyanchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)anchorTabProcessorVersionMetadata.CompanyanchorUnits(String anchorUnits)anchorUnits.CompanyanchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)anchorUnitsMetadata.CompanyanchorXOffset(String anchorXOffset)anchorXOffset.CompanyanchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)anchorXOffsetMetadata.CompanyanchorYOffset(String anchorYOffset)anchorYOffset.CompanyanchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)anchorYOffsetMetadata.Companybold(String bold)bold.CompanyboldMetadata(PropertyMetadata boldMetadata)boldMetadata.Companycaption(String caption)caption.CompanycaptionMetadata(PropertyMetadata captionMetadata)captionMetadata.CompanyconcealValueOnDocument(String concealValueOnDocument)concealValueOnDocument.CompanyconcealValueOnDocumentMetadata(PropertyMetadata concealValueOnDocumentMetadata)concealValueOnDocumentMetadata.CompanyconditionalParentLabel(String conditionalParentLabel)conditionalParentLabel.CompanyconditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)conditionalParentLabelMetadata.CompanyconditionalParentValue(String conditionalParentValue)conditionalParentValue.CompanyconditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)conditionalParentValueMetadata.CompanycustomTabId(String customTabId)customTabId.CompanycustomTabIdMetadata(PropertyMetadata customTabIdMetadata)customTabIdMetadata.CompanydisableAutoSize(String disableAutoSize)disableAutoSize.CompanydisableAutoSizeMetadata(PropertyMetadata disableAutoSizeMetadata)disableAutoSizeMetadata.CompanydocumentId(String documentId)documentId.CompanydocumentIdMetadata(PropertyMetadata documentIdMetadata)documentIdMetadata.booleanequals(Object o)Compares objects.CompanyerrorDetails(ErrorDetails errorDetails)errorDetails.Companyfont(String font)font.CompanyfontColor(String fontColor)fontColor.CompanyfontColorMetadata(PropertyMetadata fontColorMetadata)fontColorMetadata.CompanyfontMetadata(PropertyMetadata fontMetadata)fontMetadata.CompanyfontSize(String fontSize)fontSize.CompanyfontSizeMetadata(PropertyMetadata fontSizeMetadata)fontSizeMetadata.CompanyformOrder(String formOrder)formOrder.CompanyformOrderMetadata(PropertyMetadata formOrderMetadata)formOrderMetadata.CompanyformPageLabel(String formPageLabel)formPageLabel.CompanyformPageLabelMetadata(PropertyMetadata formPageLabelMetadata)formPageLabelMetadata.CompanyformPageNumber(String formPageNumber)formPageNumber.CompanyformPageNumberMetadata(PropertyMetadata formPageNumberMetadata)formPageNumberMetadata.StringgetAnchorAllowWhiteSpaceInCharacters().PropertyMetadatagetAnchorAllowWhiteSpaceInCharactersMetadata()Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..StringgetAnchorCaseSensitive()When set to **true**, the anchor string does not consider case when matching strings in the document.PropertyMetadatagetAnchorCaseSensitiveMetadata()Metadata that indicates whether the `anchorCaseSensitive` property is editable..StringgetAnchorHorizontalAlignment()Specifies the alignment of anchor tabs with anchor strings.PropertyMetadatagetAnchorHorizontalAlignmentMetadata()Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..StringgetAnchorIgnoreIfNotPresent()When set to **true**, this tab is ignored if anchorString is not found in the document..PropertyMetadatagetAnchorIgnoreIfNotPresentMetadata()Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..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**..PropertyMetadatagetAnchorMatchWholeWordMetadata()Metadata that indicates whether the `anchorMatchWholeWord` property is editable..StringgetAnchorString()Anchor text information for a radio button..PropertyMetadatagetAnchorStringMetadata()Metadata that indicates whether the `anchorString` property is editable..StringgetAnchorTabProcessorVersion().PropertyMetadatagetAnchorTabProcessorVersionMetadata()Reserved for DocuSign..StringgetAnchorUnits()Specifies units of the X and Y offset.PropertyMetadatagetAnchorUnitsMetadata()Metadata that indicates whether the `anchorUnits` property is editable..StringgetAnchorXOffset()Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..PropertyMetadatagetAnchorXOffsetMetadata()Metadata that indicates whether the `anchorXOffset` property is editable..StringgetAnchorYOffset()Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..PropertyMetadatagetAnchorYOffsetMetadata()Metadata that indicates whether the `anchorYOffset` property is editable..StringgetBold()When set to **true**, the information in the tab is bold..PropertyMetadatagetBoldMetadata()Metadata that indicates whether the `bold` property is editable..StringgetCaption().PropertyMetadatagetCaptionMetadata().StringgetConcealValueOnDocument()When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.PropertyMetadatagetConcealValueOnDocumentMetadata()Metadata that indicates whether the `concealValueOnDocument` property is editable..StringgetConditionalParentLabel()For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility..PropertyMetadatagetConditionalParentLabelMetadata()Metadata that indicates whether the `conditionalParentLabel` property is editable..StringgetConditionalParentValue()For conditional fields, this is the value of the parent tab that controls the tab's visibility.PropertyMetadatagetConditionalParentValueMetadata()Metadata that indicates whether the `conditionalParentValue` property is editable..StringgetCustomTabId()The DocuSign generated custom tab ID for the custom tab to be applied.PropertyMetadatagetCustomTabIdMetadata()Metadata that indicates whether the `customTabId` property is editable..StringgetDisableAutoSize()When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data.PropertyMetadatagetDisableAutoSizeMetadata()Metadata that indicates whether the `disableAutoSize` property is editable..StringgetDocumentId()Specifies the document ID number that the tab is placed on.PropertyMetadatagetDocumentIdMetadata()Metadata that indicates whether the `documentId` property is editable..ErrorDetailsgetErrorDetails()Array or errors..StringgetFont()The font to be used for the tab value.StringgetFontColor()The font color used for the information in the tab.PropertyMetadatagetFontColorMetadata()Metadata that indicates whether the `fontColor` property is editable..PropertyMetadatagetFontMetadata()Metadata that indicates whether the `font` property is editable..StringgetFontSize()The font size used for the information in the tab.PropertyMetadatagetFontSizeMetadata()Metadata that indicates whether the `fontSize` property is editable..StringgetFormOrder().PropertyMetadatagetFormOrderMetadata()Metadata that indicates whether the `formOrder` property is editable..StringgetFormPageLabel().PropertyMetadatagetFormPageLabelMetadata()Metadata that indicates whether the `formPageLabel` property is editable..StringgetFormPageNumber().PropertyMetadatagetFormPageNumberMetadata()Metadata that indicates whether the `fromPageNumber` property is editable..StringgetHeight()Height of the tab in pixels..PropertyMetadatagetHeightMetadata()Metadata that indicates whether the `height` property is editable..StringgetItalic()When set to **true**, the information in the tab is italic..PropertyMetadatagetItalicMetadata()Metadata that indicates whether the `italic` property is editable..LocalePolicyTabgetLocalePolicy()Reserved for DocuSign..StringgetLocked()When set to **true**, the signer cannot change the data of the custom tab..PropertyMetadatagetLockedMetadata()Metadata that indicates whether the `locked` property is editable..StringgetMaxLength()An optional value that describes the maximum length of the property when the property is a string..PropertyMetadatagetMaxLengthMetadata()Metadata that indicates whether the `maxLength` property is editable..MergeFieldgetMergeField()Contains the information necessary to map the tab to a field in SalesForce..StringgetMergeFieldXml().StringgetName()Specifies the tool tip text for the tab..PropertyMetadatagetNameMetadata()Metadata that indicates whether the `name` property is editable.StringgetOriginalValue()The initial value of the tab when it was sent to the recipient.PropertyMetadatagetOriginalValueMetadata()Metadata that indicates whether the `originalValue` property is editable..StringgetPageNumber()Specifies the page number on which the tab is located..PropertyMetadatagetPageNumberMetadata()Metadata that indicates whether the `pageNumber` property is editable..StringgetRecipientId()Unique for the recipient.StringgetRecipientIdGuid().PropertyMetadatagetRecipientIdGuidMetadata()Metadata that indicates whether the `recipientIdGuid` property is editable..PropertyMetadatagetRecipientIdMetadata()Metadata that indicates whether the `recipientId` property is editable..StringgetRequired()When set to **true**, the signer is required to fill out this tab.PropertyMetadatagetRequiredMetadata()Metadata that indicates whether the `required` property is editable..SmartContractInformationgetSmartContractInformation()Reserved for DocuSign..StringgetSource().StringgetStatus()Indicates the envelope status.PropertyMetadatagetStatusMetadata()Metadata that indicates whether the `status` property is editable..List<String>getTabGroupLabels().PropertyMetadatagetTabGroupLabelsMetadata()Metadata that indicates whether the `tabGroupLabels` property is editable..StringgetTabId()The unique identifier for the tab.PropertyMetadatagetTabIdMetadata()Metadata that indicates whether the `tabId` property is editable..StringgetTabLabel()The label string associated with the tab..PropertyMetadatagetTabLabelMetadata()Metadata that indicates whether the `tabLabel` property is editable..StringgetTabOrder().PropertyMetadatagetTabOrderMetadata()Metadata that indicates whether the `tabOrder` property is editable..StringgetTabType().PropertyMetadatagetTabTypeMetadata()Metadata that indicates whether the `tabType` property is editable..StringgetTemplateLocked()When set to **true**, the sender cannot change any attributes of the recipient.PropertyMetadatagetTemplateLockedMetadata()Metadata that indicates whether the `templateLocked` property is editable..StringgetTemplateRequired()When set to **true**, the sender may not remove the recipient.PropertyMetadatagetTemplateRequiredMetadata()Metadata that indicates whether the `templateRequired` property is editable..StringgetTooltip().PropertyMetadatagetToolTipMetadata()Metadata that indicates whether the `toolTip` property is editable..StringgetUnderline()When set to **true**, the information in the tab is underlined..PropertyMetadatagetUnderlineMetadata()Metadata that indicates whether the `underline` property is editable..StringgetValue()Specifies the value of the tab.PropertyMetadatagetValueMetadata()Metadata that indicates whether the `value` property is editable..StringgetWidth()Width of the tab in pixels..PropertyMetadatagetWidthMetadata()Metadata that indicates whether the `width` property is editable..StringgetXPosition()This indicates the horizontal offset of the object on the page.PropertyMetadatagetXPositionMetadata()Metadata that indicates whether the `xPosition` property is editable..StringgetYPosition()This indicates the vertical offset of the object on the page.PropertyMetadatagetYPositionMetadata()Metadata that indicates whether the `yPosition` property is editable..inthashCode()Returns the HashCode.Companyheight(String height)height.CompanyheightMetadata(PropertyMetadata heightMetadata)heightMetadata.Companyitalic(String italic)italic.CompanyitalicMetadata(PropertyMetadata italicMetadata)italicMetadata.CompanylocalePolicy(LocalePolicyTab localePolicy)localePolicy.Companylocked(String locked)locked.CompanylockedMetadata(PropertyMetadata lockedMetadata)lockedMetadata.CompanymaxLength(String maxLength)maxLength.CompanymaxLengthMetadata(PropertyMetadata maxLengthMetadata)maxLengthMetadata.CompanymergeField(MergeField mergeField)mergeField.CompanymergeFieldXml(String mergeFieldXml)mergeFieldXml.Companyname(String name)name.CompanynameMetadata(PropertyMetadata nameMetadata)nameMetadata.CompanyoriginalValue(String originalValue)originalValue.CompanyoriginalValueMetadata(PropertyMetadata originalValueMetadata)originalValueMetadata.CompanypageNumber(String pageNumber)pageNumber.CompanypageNumberMetadata(PropertyMetadata pageNumberMetadata)pageNumberMetadata.CompanyrecipientId(String recipientId)recipientId.CompanyrecipientIdGuid(String recipientIdGuid)recipientIdGuid.CompanyrecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)recipientIdGuidMetadata.CompanyrecipientIdMetadata(PropertyMetadata recipientIdMetadata)recipientIdMetadata.Companyrequired(String required)required.CompanyrequiredMetadata(PropertyMetadata requiredMetadata)requiredMetadata.voidsetAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)setAnchorAllowWhiteSpaceInCharacters.voidsetAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)setAnchorAllowWhiteSpaceInCharactersMetadata.voidsetAnchorCaseSensitive(String anchorCaseSensitive)setAnchorCaseSensitive.voidsetAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)setAnchorCaseSensitiveMetadata.voidsetAnchorHorizontalAlignment(String anchorHorizontalAlignment)setAnchorHorizontalAlignment.voidsetAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)setAnchorHorizontalAlignmentMetadata.voidsetAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)setAnchorIgnoreIfNotPresent.voidsetAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)setAnchorIgnoreIfNotPresentMetadata.voidsetAnchorMatchWholeWord(String anchorMatchWholeWord)setAnchorMatchWholeWord.voidsetAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)setAnchorMatchWholeWordMetadata.voidsetAnchorString(String anchorString)setAnchorString.voidsetAnchorStringMetadata(PropertyMetadata anchorStringMetadata)setAnchorStringMetadata.voidsetAnchorTabProcessorVersion(String anchorTabProcessorVersion)setAnchorTabProcessorVersion.voidsetAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)setAnchorTabProcessorVersionMetadata.voidsetAnchorUnits(String anchorUnits)setAnchorUnits.voidsetAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)setAnchorUnitsMetadata.voidsetAnchorXOffset(String anchorXOffset)setAnchorXOffset.voidsetAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)setAnchorXOffsetMetadata.voidsetAnchorYOffset(String anchorYOffset)setAnchorYOffset.voidsetAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)setAnchorYOffsetMetadata.voidsetBold(String bold)setBold.voidsetBoldMetadata(PropertyMetadata boldMetadata)setBoldMetadata.voidsetCaption(String caption)setCaption.voidsetCaptionMetadata(PropertyMetadata captionMetadata)setCaptionMetadata.voidsetConcealValueOnDocument(String concealValueOnDocument)setConcealValueOnDocument.voidsetConcealValueOnDocumentMetadata(PropertyMetadata concealValueOnDocumentMetadata)setConcealValueOnDocumentMetadata.voidsetConditionalParentLabel(String conditionalParentLabel)setConditionalParentLabel.voidsetConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)setConditionalParentLabelMetadata.voidsetConditionalParentValue(String conditionalParentValue)setConditionalParentValue.voidsetConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)setConditionalParentValueMetadata.voidsetCustomTabId(String customTabId)setCustomTabId.voidsetCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)setCustomTabIdMetadata.voidsetDisableAutoSize(String disableAutoSize)setDisableAutoSize.voidsetDisableAutoSizeMetadata(PropertyMetadata disableAutoSizeMetadata)setDisableAutoSizeMetadata.voidsetDocumentId(String documentId)setDocumentId.voidsetDocumentIdMetadata(PropertyMetadata documentIdMetadata)setDocumentIdMetadata.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetFont(String font)setFont.voidsetFontColor(String fontColor)setFontColor.voidsetFontColorMetadata(PropertyMetadata fontColorMetadata)setFontColorMetadata.voidsetFontMetadata(PropertyMetadata fontMetadata)setFontMetadata.voidsetFontSize(String fontSize)setFontSize.voidsetFontSizeMetadata(PropertyMetadata fontSizeMetadata)setFontSizeMetadata.voidsetFormOrder(String formOrder)setFormOrder.voidsetFormOrderMetadata(PropertyMetadata formOrderMetadata)setFormOrderMetadata.voidsetFormPageLabel(String formPageLabel)setFormPageLabel.voidsetFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)setFormPageLabelMetadata.voidsetFormPageNumber(String formPageNumber)setFormPageNumber.voidsetFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)setFormPageNumberMetadata.voidsetHeight(String height)setHeight.voidsetHeightMetadata(PropertyMetadata heightMetadata)setHeightMetadata.voidsetItalic(String italic)setItalic.voidsetItalicMetadata(PropertyMetadata italicMetadata)setItalicMetadata.voidsetLocalePolicy(LocalePolicyTab localePolicy)setLocalePolicy.voidsetLocked(String locked)setLocked.voidsetLockedMetadata(PropertyMetadata lockedMetadata)setLockedMetadata.voidsetMaxLength(String maxLength)setMaxLength.voidsetMaxLengthMetadata(PropertyMetadata maxLengthMetadata)setMaxLengthMetadata.voidsetMergeField(MergeField mergeField)setMergeField.voidsetMergeFieldXml(String mergeFieldXml)setMergeFieldXml.voidsetName(String name)setName.voidsetNameMetadata(PropertyMetadata nameMetadata)setNameMetadata.voidsetOriginalValue(String originalValue)setOriginalValue.voidsetOriginalValueMetadata(PropertyMetadata originalValueMetadata)setOriginalValueMetadata.voidsetPageNumber(String pageNumber)setPageNumber.voidsetPageNumberMetadata(PropertyMetadata pageNumberMetadata)setPageNumberMetadata.voidsetRecipientId(String recipientId)setRecipientId.voidsetRecipientIdGuid(String recipientIdGuid)setRecipientIdGuid.voidsetRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)setRecipientIdGuidMetadata.voidsetRecipientIdMetadata(PropertyMetadata recipientIdMetadata)setRecipientIdMetadata.voidsetRequired(String required)setRequired.voidsetRequiredMetadata(PropertyMetadata requiredMetadata)setRequiredMetadata.voidsetSmartContractInformation(SmartContractInformation smartContractInformation)setSmartContractInformation.voidsetSource(String source)setSource.voidsetStatus(String status)setStatus.voidsetStatusMetadata(PropertyMetadata statusMetadata)setStatusMetadata.voidsetTabGroupLabels(List<String> tabGroupLabels)setTabGroupLabels.voidsetTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)setTabGroupLabelsMetadata.voidsetTabId(String tabId)setTabId.voidsetTabIdMetadata(PropertyMetadata tabIdMetadata)setTabIdMetadata.voidsetTabLabel(String tabLabel)setTabLabel.voidsetTabLabelMetadata(PropertyMetadata tabLabelMetadata)setTabLabelMetadata.voidsetTabOrder(String tabOrder)setTabOrder.voidsetTabOrderMetadata(PropertyMetadata tabOrderMetadata)setTabOrderMetadata.voidsetTabType(String tabType)setTabType.voidsetTabTypeMetadata(PropertyMetadata tabTypeMetadata)setTabTypeMetadata.voidsetTemplateLocked(String templateLocked)setTemplateLocked.voidsetTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)setTemplateLockedMetadata.voidsetTemplateRequired(String templateRequired)setTemplateRequired.voidsetTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)setTemplateRequiredMetadata.voidsetTooltip(String tooltip)setTooltip.voidsetToolTipMetadata(PropertyMetadata toolTipMetadata)setToolTipMetadata.voidsetUnderline(String underline)setUnderline.voidsetUnderlineMetadata(PropertyMetadata underlineMetadata)setUnderlineMetadata.voidsetValue(String value)setValue.voidsetValueMetadata(PropertyMetadata valueMetadata)setValueMetadata.voidsetWidth(String width)setWidth.voidsetWidthMetadata(PropertyMetadata widthMetadata)setWidthMetadata.voidsetXPosition(String xPosition)setXPosition.voidsetXPositionMetadata(PropertyMetadata xPositionMetadata)setXPositionMetadata.voidsetYPosition(String yPosition)setYPosition.voidsetYPositionMetadata(PropertyMetadata yPositionMetadata)setYPositionMetadata.CompanysmartContractInformation(SmartContractInformation smartContractInformation)smartContractInformation.Companysource(String source)source.Companystatus(String status)status.CompanystatusMetadata(PropertyMetadata statusMetadata)statusMetadata.CompanytabGroupLabels(List<String> tabGroupLabels)tabGroupLabels.CompanytabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)tabGroupLabelsMetadata.CompanytabId(String tabId)tabId.CompanytabIdMetadata(PropertyMetadata tabIdMetadata)tabIdMetadata.CompanytabLabel(String tabLabel)tabLabel.CompanytabLabelMetadata(PropertyMetadata tabLabelMetadata)tabLabelMetadata.CompanytabOrder(String tabOrder)tabOrder.CompanytabOrderMetadata(PropertyMetadata tabOrderMetadata)tabOrderMetadata.CompanytabType(String tabType)tabType.CompanytabTypeMetadata(PropertyMetadata tabTypeMetadata)tabTypeMetadata.CompanytemplateLocked(String templateLocked)templateLocked.CompanytemplateLockedMetadata(PropertyMetadata templateLockedMetadata)templateLockedMetadata.CompanytemplateRequired(String templateRequired)templateRequired.CompanytemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)templateRequiredMetadata.Companytooltip(String tooltip)tooltip.CompanytoolTipMetadata(PropertyMetadata toolTipMetadata)toolTipMetadata.StringtoString()Converts the given object to string.Companyunderline(String underline)underline.CompanyunderlineMetadata(PropertyMetadata underlineMetadata)underlineMetadata.Companyvalue(String value)value.CompanyvalueMetadata(PropertyMetadata valueMetadata)valueMetadata.Companywidth(String width)width.CompanywidthMetadata(PropertyMetadata widthMetadata)widthMetadata.CompanyxPosition(String xPosition)xPosition.CompanyxPositionMetadata(PropertyMetadata xPositionMetadata)xPositionMetadata.CompanyyPosition(String yPosition)yPosition.CompanyyPositionMetadata(PropertyMetadata yPositionMetadata)yPositionMetadata.
-
-
-
Method Detail
-
anchorAllowWhiteSpaceInCharacters
public Company anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
anchorAllowWhiteSpaceInCharacters.- Returns:
- Company
-
getAnchorAllowWhiteSpaceInCharacters
public String getAnchorAllowWhiteSpaceInCharacters()
.- Returns:
- anchorAllowWhiteSpaceInCharacters
-
setAnchorAllowWhiteSpaceInCharacters
public void setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
setAnchorAllowWhiteSpaceInCharacters.
-
anchorAllowWhiteSpaceInCharactersMetadata
public Company anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
anchorAllowWhiteSpaceInCharactersMetadata.- Returns:
- Company
-
getAnchorAllowWhiteSpaceInCharactersMetadata
public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..- Returns:
- anchorAllowWhiteSpaceInCharactersMetadata
-
setAnchorAllowWhiteSpaceInCharactersMetadata
public void setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
setAnchorAllowWhiteSpaceInCharactersMetadata.
-
anchorCaseSensitive
public Company anchorCaseSensitive(String anchorCaseSensitive)
anchorCaseSensitive.- Returns:
- Company
-
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.
-
anchorCaseSensitiveMetadata
public Company anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
anchorCaseSensitiveMetadata.- Returns:
- Company
-
getAnchorCaseSensitiveMetadata
public PropertyMetadata getAnchorCaseSensitiveMetadata()
Metadata that indicates whether the `anchorCaseSensitive` property is editable..- Returns:
- anchorCaseSensitiveMetadata
-
setAnchorCaseSensitiveMetadata
public void setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
setAnchorCaseSensitiveMetadata.
-
anchorHorizontalAlignment
public Company anchorHorizontalAlignment(String anchorHorizontalAlignment)
anchorHorizontalAlignment.- Returns:
- Company
-
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.
-
anchorHorizontalAlignmentMetadata
public Company anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
anchorHorizontalAlignmentMetadata.- Returns:
- Company
-
getAnchorHorizontalAlignmentMetadata
public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..- Returns:
- anchorHorizontalAlignmentMetadata
-
setAnchorHorizontalAlignmentMetadata
public void setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
setAnchorHorizontalAlignmentMetadata.
-
anchorIgnoreIfNotPresent
public Company anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
anchorIgnoreIfNotPresent.- Returns:
- Company
-
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.
-
anchorIgnoreIfNotPresentMetadata
public Company anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
anchorIgnoreIfNotPresentMetadata.- Returns:
- Company
-
getAnchorIgnoreIfNotPresentMetadata
public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..- Returns:
- anchorIgnoreIfNotPresentMetadata
-
setAnchorIgnoreIfNotPresentMetadata
public void setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
setAnchorIgnoreIfNotPresentMetadata.
-
anchorMatchWholeWord
public Company anchorMatchWholeWord(String anchorMatchWholeWord)
anchorMatchWholeWord.- Returns:
- Company
-
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.
-
anchorMatchWholeWordMetadata
public Company anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
anchorMatchWholeWordMetadata.- Returns:
- Company
-
getAnchorMatchWholeWordMetadata
public PropertyMetadata getAnchorMatchWholeWordMetadata()
Metadata that indicates whether the `anchorMatchWholeWord` property is editable..- Returns:
- anchorMatchWholeWordMetadata
-
setAnchorMatchWholeWordMetadata
public void setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
setAnchorMatchWholeWordMetadata.
-
getAnchorString
public String getAnchorString()
Anchor text information for a radio button..- Returns:
- anchorString
-
setAnchorString
public void setAnchorString(String anchorString)
setAnchorString.
-
anchorStringMetadata
public Company anchorStringMetadata(PropertyMetadata anchorStringMetadata)
anchorStringMetadata.- Returns:
- Company
-
getAnchorStringMetadata
public PropertyMetadata getAnchorStringMetadata()
Metadata that indicates whether the `anchorString` property is editable..- Returns:
- anchorStringMetadata
-
setAnchorStringMetadata
public void setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)
setAnchorStringMetadata.
-
anchorTabProcessorVersion
public Company anchorTabProcessorVersion(String anchorTabProcessorVersion)
anchorTabProcessorVersion.- Returns:
- Company
-
getAnchorTabProcessorVersion
public String getAnchorTabProcessorVersion()
.- Returns:
- anchorTabProcessorVersion
-
setAnchorTabProcessorVersion
public void setAnchorTabProcessorVersion(String anchorTabProcessorVersion)
setAnchorTabProcessorVersion.
-
anchorTabProcessorVersionMetadata
public Company anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
anchorTabProcessorVersionMetadata.- Returns:
- Company
-
getAnchorTabProcessorVersionMetadata
public PropertyMetadata getAnchorTabProcessorVersionMetadata()
Reserved for DocuSign..- Returns:
- anchorTabProcessorVersionMetadata
-
setAnchorTabProcessorVersionMetadata
public void setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
setAnchorTabProcessorVersionMetadata.
-
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.
-
anchorUnitsMetadata
public Company anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
anchorUnitsMetadata.- Returns:
- Company
-
getAnchorUnitsMetadata
public PropertyMetadata getAnchorUnitsMetadata()
Metadata that indicates whether the `anchorUnits` property is editable..- Returns:
- anchorUnitsMetadata
-
setAnchorUnitsMetadata
public void setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
setAnchorUnitsMetadata.
-
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.
-
anchorXOffsetMetadata
public Company anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
anchorXOffsetMetadata.- Returns:
- Company
-
getAnchorXOffsetMetadata
public PropertyMetadata getAnchorXOffsetMetadata()
Metadata that indicates whether the `anchorXOffset` property is editable..- Returns:
- anchorXOffsetMetadata
-
setAnchorXOffsetMetadata
public void setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
setAnchorXOffsetMetadata.
-
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.
-
anchorYOffsetMetadata
public Company anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
anchorYOffsetMetadata.- Returns:
- Company
-
getAnchorYOffsetMetadata
public PropertyMetadata getAnchorYOffsetMetadata()
Metadata that indicates whether the `anchorYOffset` property is editable..- Returns:
- anchorYOffsetMetadata
-
setAnchorYOffsetMetadata
public void setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
setAnchorYOffsetMetadata.
-
getBold
public String getBold()
When set to **true**, the information in the tab is bold..- Returns:
- bold
-
setBold
public void setBold(String bold)
setBold.
-
boldMetadata
public Company boldMetadata(PropertyMetadata boldMetadata)
boldMetadata.- Returns:
- Company
-
getBoldMetadata
public PropertyMetadata getBoldMetadata()
Metadata that indicates whether the `bold` property is editable..- Returns:
- boldMetadata
-
setBoldMetadata
public void setBoldMetadata(PropertyMetadata boldMetadata)
setBoldMetadata.
-
getCaption
public String getCaption()
.- Returns:
- caption
-
setCaption
public void setCaption(String caption)
setCaption.
-
captionMetadata
public Company captionMetadata(PropertyMetadata captionMetadata)
captionMetadata.- Returns:
- Company
-
getCaptionMetadata
public PropertyMetadata getCaptionMetadata()
.- Returns:
- captionMetadata
-
setCaptionMetadata
public void setCaptionMetadata(PropertyMetadata captionMetadata)
setCaptionMetadata.
-
concealValueOnDocument
public Company concealValueOnDocument(String concealValueOnDocument)
concealValueOnDocument.- Returns:
- Company
-
getConcealValueOnDocument
public String getConcealValueOnDocument()
When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes..- Returns:
- concealValueOnDocument
-
setConcealValueOnDocument
public void setConcealValueOnDocument(String concealValueOnDocument)
setConcealValueOnDocument.
-
concealValueOnDocumentMetadata
public Company concealValueOnDocumentMetadata(PropertyMetadata concealValueOnDocumentMetadata)
concealValueOnDocumentMetadata.- Returns:
- Company
-
getConcealValueOnDocumentMetadata
public PropertyMetadata getConcealValueOnDocumentMetadata()
Metadata that indicates whether the `concealValueOnDocument` property is editable..- Returns:
- concealValueOnDocumentMetadata
-
setConcealValueOnDocumentMetadata
public void setConcealValueOnDocumentMetadata(PropertyMetadata concealValueOnDocumentMetadata)
setConcealValueOnDocumentMetadata.
-
conditionalParentLabel
public Company conditionalParentLabel(String conditionalParentLabel)
conditionalParentLabel.- Returns:
- Company
-
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.
-
conditionalParentLabelMetadata
public Company conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
conditionalParentLabelMetadata.- Returns:
- Company
-
getConditionalParentLabelMetadata
public PropertyMetadata getConditionalParentLabelMetadata()
Metadata that indicates whether the `conditionalParentLabel` property is editable..- Returns:
- conditionalParentLabelMetadata
-
setConditionalParentLabelMetadata
public void setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
setConditionalParentLabelMetadata.
-
conditionalParentValue
public Company conditionalParentValue(String conditionalParentValue)
conditionalParentValue.- Returns:
- Company
-
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.
-
conditionalParentValueMetadata
public Company conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
conditionalParentValueMetadata.- Returns:
- Company
-
getConditionalParentValueMetadata
public PropertyMetadata getConditionalParentValueMetadata()
Metadata that indicates whether the `conditionalParentValue` property is editable..- Returns:
- conditionalParentValueMetadata
-
setConditionalParentValueMetadata
public void setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
setConditionalParentValueMetadata.
-
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.
-
customTabIdMetadata
public Company customTabIdMetadata(PropertyMetadata customTabIdMetadata)
customTabIdMetadata.- Returns:
- Company
-
getCustomTabIdMetadata
public PropertyMetadata getCustomTabIdMetadata()
Metadata that indicates whether the `customTabId` property is editable..- Returns:
- customTabIdMetadata
-
setCustomTabIdMetadata
public void setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)
setCustomTabIdMetadata.
-
disableAutoSize
public Company disableAutoSize(String disableAutoSize)
disableAutoSize.- Returns:
- Company
-
getDisableAutoSize
public String getDisableAutoSize()
When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes..- Returns:
- disableAutoSize
-
setDisableAutoSize
public void setDisableAutoSize(String disableAutoSize)
setDisableAutoSize.
-
disableAutoSizeMetadata
public Company disableAutoSizeMetadata(PropertyMetadata disableAutoSizeMetadata)
disableAutoSizeMetadata.- Returns:
- Company
-
getDisableAutoSizeMetadata
public PropertyMetadata getDisableAutoSizeMetadata()
Metadata that indicates whether the `disableAutoSize` property is editable..- Returns:
- disableAutoSizeMetadata
-
setDisableAutoSizeMetadata
public void setDisableAutoSizeMetadata(PropertyMetadata disableAutoSizeMetadata)
setDisableAutoSizeMetadata.
-
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.
-
documentIdMetadata
public Company documentIdMetadata(PropertyMetadata documentIdMetadata)
documentIdMetadata.- Returns:
- Company
-
getDocumentIdMetadata
public PropertyMetadata getDocumentIdMetadata()
Metadata that indicates whether the `documentId` property is editable..- Returns:
- documentIdMetadata
-
setDocumentIdMetadata
public void setDocumentIdMetadata(PropertyMetadata documentIdMetadata)
setDocumentIdMetadata.
-
errorDetails
public Company errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- Company
-
getErrorDetails
public ErrorDetails getErrorDetails()
Array or errors..- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
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)
setFont.
-
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)
setFontColor.
-
fontColorMetadata
public Company fontColorMetadata(PropertyMetadata fontColorMetadata)
fontColorMetadata.- Returns:
- Company
-
getFontColorMetadata
public PropertyMetadata getFontColorMetadata()
Metadata that indicates whether the `fontColor` property is editable..- Returns:
- fontColorMetadata
-
setFontColorMetadata
public void setFontColorMetadata(PropertyMetadata fontColorMetadata)
setFontColorMetadata.
-
fontMetadata
public Company fontMetadata(PropertyMetadata fontMetadata)
fontMetadata.- Returns:
- Company
-
getFontMetadata
public PropertyMetadata getFontMetadata()
Metadata that indicates whether the `font` property is editable..- Returns:
- fontMetadata
-
setFontMetadata
public void setFontMetadata(PropertyMetadata fontMetadata)
setFontMetadata.
-
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)
setFontSize.
-
fontSizeMetadata
public Company fontSizeMetadata(PropertyMetadata fontSizeMetadata)
fontSizeMetadata.- Returns:
- Company
-
getFontSizeMetadata
public PropertyMetadata getFontSizeMetadata()
Metadata that indicates whether the `fontSize` property is editable..- Returns:
- fontSizeMetadata
-
setFontSizeMetadata
public void setFontSizeMetadata(PropertyMetadata fontSizeMetadata)
setFontSizeMetadata.
-
getFormOrder
public String getFormOrder()
.- Returns:
- formOrder
-
setFormOrder
public void setFormOrder(String formOrder)
setFormOrder.
-
formOrderMetadata
public Company formOrderMetadata(PropertyMetadata formOrderMetadata)
formOrderMetadata.- Returns:
- Company
-
getFormOrderMetadata
public PropertyMetadata getFormOrderMetadata()
Metadata that indicates whether the `formOrder` property is editable..- Returns:
- formOrderMetadata
-
setFormOrderMetadata
public void setFormOrderMetadata(PropertyMetadata formOrderMetadata)
setFormOrderMetadata.
-
getFormPageLabel
public String getFormPageLabel()
.- Returns:
- formPageLabel
-
setFormPageLabel
public void setFormPageLabel(String formPageLabel)
setFormPageLabel.
-
formPageLabelMetadata
public Company formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
formPageLabelMetadata.- Returns:
- Company
-
getFormPageLabelMetadata
public PropertyMetadata getFormPageLabelMetadata()
Metadata that indicates whether the `formPageLabel` property is editable..- Returns:
- formPageLabelMetadata
-
setFormPageLabelMetadata
public void setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
setFormPageLabelMetadata.
-
formPageNumber
public Company formPageNumber(String formPageNumber)
formPageNumber.- Returns:
- Company
-
getFormPageNumber
public String getFormPageNumber()
.- Returns:
- formPageNumber
-
setFormPageNumber
public void setFormPageNumber(String formPageNumber)
setFormPageNumber.
-
formPageNumberMetadata
public Company formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
formPageNumberMetadata.- Returns:
- Company
-
getFormPageNumberMetadata
public PropertyMetadata getFormPageNumberMetadata()
Metadata that indicates whether the `fromPageNumber` property is editable..- Returns:
- formPageNumberMetadata
-
setFormPageNumberMetadata
public void setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
setFormPageNumberMetadata.
-
getHeight
public String getHeight()
Height of the tab in pixels..- Returns:
- height
-
setHeight
public void setHeight(String height)
setHeight.
-
heightMetadata
public Company heightMetadata(PropertyMetadata heightMetadata)
heightMetadata.- Returns:
- Company
-
getHeightMetadata
public PropertyMetadata getHeightMetadata()
Metadata that indicates whether the `height` property is editable..- Returns:
- heightMetadata
-
setHeightMetadata
public void setHeightMetadata(PropertyMetadata heightMetadata)
setHeightMetadata.
-
getItalic
public String getItalic()
When set to **true**, the information in the tab is italic..- Returns:
- italic
-
setItalic
public void setItalic(String italic)
setItalic.
-
italicMetadata
public Company italicMetadata(PropertyMetadata italicMetadata)
italicMetadata.- Returns:
- Company
-
getItalicMetadata
public PropertyMetadata getItalicMetadata()
Metadata that indicates whether the `italic` property is editable..- Returns:
- italicMetadata
-
setItalicMetadata
public void setItalicMetadata(PropertyMetadata italicMetadata)
setItalicMetadata.
-
localePolicy
public Company localePolicy(LocalePolicyTab localePolicy)
localePolicy.- Returns:
- Company
-
getLocalePolicy
public LocalePolicyTab getLocalePolicy()
Reserved for DocuSign..- Returns:
- localePolicy
-
setLocalePolicy
public void setLocalePolicy(LocalePolicyTab localePolicy)
setLocalePolicy.
-
getLocked
public String getLocked()
When set to **true**, the signer cannot change the data of the custom tab..- Returns:
- locked
-
setLocked
public void setLocked(String locked)
setLocked.
-
lockedMetadata
public Company lockedMetadata(PropertyMetadata lockedMetadata)
lockedMetadata.- Returns:
- Company
-
getLockedMetadata
public PropertyMetadata getLockedMetadata()
Metadata that indicates whether the `locked` property is editable..- Returns:
- lockedMetadata
-
setLockedMetadata
public void setLockedMetadata(PropertyMetadata lockedMetadata)
setLockedMetadata.
-
getMaxLength
public String getMaxLength()
An optional value that describes the maximum length of the property when the property is a string..- Returns:
- maxLength
-
setMaxLength
public void setMaxLength(String maxLength)
setMaxLength.
-
maxLengthMetadata
public Company maxLengthMetadata(PropertyMetadata maxLengthMetadata)
maxLengthMetadata.- Returns:
- Company
-
getMaxLengthMetadata
public PropertyMetadata getMaxLengthMetadata()
Metadata that indicates whether the `maxLength` property is editable..- Returns:
- maxLengthMetadata
-
setMaxLengthMetadata
public void setMaxLengthMetadata(PropertyMetadata maxLengthMetadata)
setMaxLengthMetadata.
-
mergeField
public Company mergeField(MergeField mergeField)
mergeField.- Returns:
- Company
-
getMergeField
public MergeField getMergeField()
Contains the information necessary to map the tab to a field in SalesForce..- Returns:
- mergeField
-
setMergeField
public void setMergeField(MergeField mergeField)
setMergeField.
-
getMergeFieldXml
public String getMergeFieldXml()
.- Returns:
- mergeFieldXml
-
setMergeFieldXml
public void setMergeFieldXml(String mergeFieldXml)
setMergeFieldXml.
-
getName
public String getName()
Specifies the tool tip text for the tab..- Returns:
- name
-
setName
public void setName(String name)
setName.
-
nameMetadata
public Company nameMetadata(PropertyMetadata nameMetadata)
nameMetadata.- Returns:
- Company
-
getNameMetadata
public PropertyMetadata getNameMetadata()
Metadata that indicates whether the `name` property is editable. This property is read-only..- Returns:
- nameMetadata
-
setNameMetadata
public void setNameMetadata(PropertyMetadata nameMetadata)
setNameMetadata.
-
getOriginalValue
public String getOriginalValue()
The initial value of the tab when it was sent to the recipient. .- Returns:
- originalValue
-
setOriginalValue
public void setOriginalValue(String originalValue)
setOriginalValue.
-
originalValueMetadata
public Company originalValueMetadata(PropertyMetadata originalValueMetadata)
originalValueMetadata.- Returns:
- Company
-
getOriginalValueMetadata
public PropertyMetadata getOriginalValueMetadata()
Metadata that indicates whether the `originalValue` property is editable..- Returns:
- originalValueMetadata
-
setOriginalValueMetadata
public void setOriginalValueMetadata(PropertyMetadata originalValueMetadata)
setOriginalValueMetadata.
-
getPageNumber
public String getPageNumber()
Specifies the page number on which the tab is located..- Returns:
- pageNumber
-
setPageNumber
public void setPageNumber(String pageNumber)
setPageNumber.
-
pageNumberMetadata
public Company pageNumberMetadata(PropertyMetadata pageNumberMetadata)
pageNumberMetadata.- Returns:
- Company
-
getPageNumberMetadata
public PropertyMetadata getPageNumberMetadata()
Metadata that indicates whether the `pageNumber` property is editable..- Returns:
- pageNumberMetadata
-
setPageNumberMetadata
public void setPageNumberMetadata(PropertyMetadata pageNumberMetadata)
setPageNumberMetadata.
-
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.
-
recipientIdGuid
public Company recipientIdGuid(String recipientIdGuid)
recipientIdGuid.- Returns:
- Company
-
getRecipientIdGuid
public String getRecipientIdGuid()
.- Returns:
- recipientIdGuid
-
setRecipientIdGuid
public void setRecipientIdGuid(String recipientIdGuid)
setRecipientIdGuid.
-
recipientIdGuidMetadata
public Company recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
recipientIdGuidMetadata.- Returns:
- Company
-
getRecipientIdGuidMetadata
public PropertyMetadata getRecipientIdGuidMetadata()
Metadata that indicates whether the `recipientIdGuid` property is editable..- Returns:
- recipientIdGuidMetadata
-
setRecipientIdGuidMetadata
public void setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
setRecipientIdGuidMetadata.
-
recipientIdMetadata
public Company recipientIdMetadata(PropertyMetadata recipientIdMetadata)
recipientIdMetadata.- Returns:
- Company
-
getRecipientIdMetadata
public PropertyMetadata getRecipientIdMetadata()
Metadata that indicates whether the `recipientId` property is editable..- Returns:
- recipientIdMetadata
-
setRecipientIdMetadata
public void setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)
setRecipientIdMetadata.
-
getRequired
public String getRequired()
When set to **true**, the signer is required to fill out this tab.- Returns:
- required
-
setRequired
public void setRequired(String required)
setRequired.
-
requiredMetadata
public Company requiredMetadata(PropertyMetadata requiredMetadata)
requiredMetadata.- Returns:
- Company
-
getRequiredMetadata
public PropertyMetadata getRequiredMetadata()
Metadata that indicates whether the `required` property is editable..- Returns:
- requiredMetadata
-
setRequiredMetadata
public void setRequiredMetadata(PropertyMetadata requiredMetadata)
setRequiredMetadata.
-
smartContractInformation
public Company smartContractInformation(SmartContractInformation smartContractInformation)
smartContractInformation.- Returns:
- Company
-
getSmartContractInformation
public SmartContractInformation getSmartContractInformation()
Reserved for DocuSign..- Returns:
- smartContractInformation
-
setSmartContractInformation
public void setSmartContractInformation(SmartContractInformation smartContractInformation)
setSmartContractInformation.
-
getSource
public String getSource()
.- Returns:
- source
-
setSource
public void setSource(String source)
setSource.
-
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.
-
statusMetadata
public Company statusMetadata(PropertyMetadata statusMetadata)
statusMetadata.- Returns:
- Company
-
getStatusMetadata
public PropertyMetadata getStatusMetadata()
Metadata that indicates whether the `status` property is editable..- Returns:
- statusMetadata
-
setStatusMetadata
public void setStatusMetadata(PropertyMetadata statusMetadata)
setStatusMetadata.
-
tabGroupLabels
public Company tabGroupLabels(List<String> tabGroupLabels)
tabGroupLabels.- Returns:
- Company
-
addTabGroupLabelsItem
public Company addTabGroupLabelsItem(String tabGroupLabelsItem)
addTabGroupLabelsItem.- Returns:
- Company
-
tabGroupLabelsMetadata
public Company tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
tabGroupLabelsMetadata.- Returns:
- Company
-
getTabGroupLabelsMetadata
public PropertyMetadata getTabGroupLabelsMetadata()
Metadata that indicates whether the `tabGroupLabels` property is editable..- Returns:
- tabGroupLabelsMetadata
-
setTabGroupLabelsMetadata
public void setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
setTabGroupLabelsMetadata.
-
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.
-
tabIdMetadata
public Company tabIdMetadata(PropertyMetadata tabIdMetadata)
tabIdMetadata.- Returns:
- Company
-
getTabIdMetadata
public PropertyMetadata getTabIdMetadata()
Metadata that indicates whether the `tabId` property is editable..- Returns:
- tabIdMetadata
-
setTabIdMetadata
public void setTabIdMetadata(PropertyMetadata tabIdMetadata)
setTabIdMetadata.
-
getTabLabel
public String getTabLabel()
The label string associated with the tab..- Returns:
- tabLabel
-
setTabLabel
public void setTabLabel(String tabLabel)
setTabLabel.
-
tabLabelMetadata
public Company tabLabelMetadata(PropertyMetadata tabLabelMetadata)
tabLabelMetadata.- Returns:
- Company
-
getTabLabelMetadata
public PropertyMetadata getTabLabelMetadata()
Metadata that indicates whether the `tabLabel` property is editable..- Returns:
- tabLabelMetadata
-
setTabLabelMetadata
public void setTabLabelMetadata(PropertyMetadata tabLabelMetadata)
setTabLabelMetadata.
-
getTabOrder
public String getTabOrder()
.- Returns:
- tabOrder
-
setTabOrder
public void setTabOrder(String tabOrder)
setTabOrder.
-
tabOrderMetadata
public Company tabOrderMetadata(PropertyMetadata tabOrderMetadata)
tabOrderMetadata.- Returns:
- Company
-
getTabOrderMetadata
public PropertyMetadata getTabOrderMetadata()
Metadata that indicates whether the `tabOrder` property is editable..- Returns:
- tabOrderMetadata
-
setTabOrderMetadata
public void setTabOrderMetadata(PropertyMetadata tabOrderMetadata)
setTabOrderMetadata.
-
getTabType
public String getTabType()
.- Returns:
- tabType
-
setTabType
public void setTabType(String tabType)
setTabType.
-
tabTypeMetadata
public Company tabTypeMetadata(PropertyMetadata tabTypeMetadata)
tabTypeMetadata.- Returns:
- Company
-
getTabTypeMetadata
public PropertyMetadata getTabTypeMetadata()
Metadata that indicates whether the `tabType` property is editable..- Returns:
- tabTypeMetadata
-
setTabTypeMetadata
public void setTabTypeMetadata(PropertyMetadata tabTypeMetadata)
setTabTypeMetadata.
-
templateLocked
public Company templateLocked(String templateLocked)
templateLocked.- Returns:
- Company
-
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.
-
templateLockedMetadata
public Company templateLockedMetadata(PropertyMetadata templateLockedMetadata)
templateLockedMetadata.- Returns:
- Company
-
getTemplateLockedMetadata
public PropertyMetadata getTemplateLockedMetadata()
Metadata that indicates whether the `templateLocked` property is editable..- Returns:
- templateLockedMetadata
-
setTemplateLockedMetadata
public void setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)
setTemplateLockedMetadata.
-
templateRequired
public Company templateRequired(String templateRequired)
templateRequired.- Returns:
- Company
-
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.
-
templateRequiredMetadata
public Company templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
templateRequiredMetadata.- Returns:
- Company
-
getTemplateRequiredMetadata
public PropertyMetadata getTemplateRequiredMetadata()
Metadata that indicates whether the `templateRequired` property is editable..- Returns:
- templateRequiredMetadata
-
setTemplateRequiredMetadata
public void setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
setTemplateRequiredMetadata.
-
getTooltip
public String getTooltip()
.- Returns:
- tooltip
-
setTooltip
public void setTooltip(String tooltip)
setTooltip.
-
toolTipMetadata
public Company toolTipMetadata(PropertyMetadata toolTipMetadata)
toolTipMetadata.- Returns:
- Company
-
getToolTipMetadata
public PropertyMetadata getToolTipMetadata()
Metadata that indicates whether the `toolTip` property is editable..- Returns:
- toolTipMetadata
-
setToolTipMetadata
public void setToolTipMetadata(PropertyMetadata toolTipMetadata)
setToolTipMetadata.
-
getUnderline
public String getUnderline()
When set to **true**, the information in the tab is underlined..- Returns:
- underline
-
setUnderline
public void setUnderline(String underline)
setUnderline.
-
underlineMetadata
public Company underlineMetadata(PropertyMetadata underlineMetadata)
underlineMetadata.- Returns:
- Company
-
getUnderlineMetadata
public PropertyMetadata getUnderlineMetadata()
Metadata that indicates whether the `underline` property is editable..- Returns:
- underlineMetadata
-
setUnderlineMetadata
public void setUnderlineMetadata(PropertyMetadata underlineMetadata)
setUnderlineMetadata.
-
getValue
public String getValue()
Specifies the value of the tab. .- Returns:
- value
-
setValue
public void setValue(String value)
setValue.
-
valueMetadata
public Company valueMetadata(PropertyMetadata valueMetadata)
valueMetadata.- Returns:
- Company
-
getValueMetadata
public PropertyMetadata getValueMetadata()
Metadata that indicates whether the `value` property is editable..- Returns:
- valueMetadata
-
setValueMetadata
public void setValueMetadata(PropertyMetadata valueMetadata)
setValueMetadata.
-
getWidth
public String getWidth()
Width of the tab in pixels..- Returns:
- width
-
setWidth
public void setWidth(String width)
setWidth.
-
widthMetadata
public Company widthMetadata(PropertyMetadata widthMetadata)
widthMetadata.- Returns:
- Company
-
getWidthMetadata
public PropertyMetadata getWidthMetadata()
Metadata that indicates whether the `width` property is editable..- Returns:
- widthMetadata
-
setWidthMetadata
public void setWidthMetadata(PropertyMetadata widthMetadata)
setWidthMetadata.
-
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.
-
xPositionMetadata
public Company xPositionMetadata(PropertyMetadata xPositionMetadata)
xPositionMetadata.- Returns:
- Company
-
getXPositionMetadata
public PropertyMetadata getXPositionMetadata()
Metadata that indicates whether the `xPosition` property is editable..- Returns:
- xPositionMetadata
-
setXPositionMetadata
public void setXPositionMetadata(PropertyMetadata xPositionMetadata)
setXPositionMetadata.
-
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.
-
yPositionMetadata
public Company yPositionMetadata(PropertyMetadata yPositionMetadata)
yPositionMetadata.- Returns:
- Company
-
getYPositionMetadata
public PropertyMetadata getYPositionMetadata()
Metadata that indicates whether the `yPosition` property is editable..- Returns:
- yPositionMetadata
-
setYPositionMetadata
public void setYPositionMetadata(PropertyMetadata yPositionMetadata)
setYPositionMetadata.
-
equals
public boolean equals(Object o)
Compares objects.
-
-