com.docusign.esign.model

Class TabGroup

java.lang.Object

com.docusign.esign.model.TabGroup

public class TabGroup
extends Object

TabGroup

Constructor Summary

Constructors

Constructor and Description
TabGroup()

Method Summary

Methods

Modifier and Type	Method and Description
TabGroup	addChildTabLabelsItem(String childTabLabelsItem)
TabGroup	childTabLabels(List<String> childTabLabels)
TabGroup	childTabLabelsMetadata(PropertyMetadata childTabLabelsMetadata)
boolean	equals(Object o)
TabGroup	errorDetails(ErrorDetails errorDetails)
List<String>	getChildTabLabels()
PropertyMetadata	getChildTabLabelsMetadata() Get childTabLabelsMetadata
ErrorDetails	getErrorDetails() Get errorDetails
String	getGroupLabel()
PropertyMetadata	getGroupLabelMetadata() Get groupLabelMetadata
String	getGroupRule()
PropertyMetadata	getGroupRuleMetadata() Get groupRuleMetadata
String	getMaximumAllowed()
PropertyMetadata	getMaximumAllowedMetadata() Get maximumAllowedMetadata
String	getMinimumRequired()
PropertyMetadata	getMinimumRequiredMetadata() Get minimumRequiredMetadata
String	getRecipientId() Unique for the recipient.
PropertyMetadata	getRecipientIdMetadata() Get recipientIdMetadata
String	getTabId() The unique identifier for the tab.
PropertyMetadata	getTabIdMetadata() Get tabIdMetadata
String	getTemplateLocked() When set to **true**, the sender cannot change any attributes of the recipient.
PropertyMetadata	getTemplateLockedMetadata() Get templateLockedMetadata
String	getTemplateRequired() When set to **true**, the sender may not remove the recipient.
PropertyMetadata	getTemplateRequiredMetadata() Get templateRequiredMetadata
String	getValidationMessage() The message displayed if the custom tab fails input validation (either custom of embedded).
PropertyMetadata	getValidationMessageMetadata() Get validationMessageMetadata
TabGroup	groupLabel(String groupLabel)
TabGroup	groupLabelMetadata(PropertyMetadata groupLabelMetadata)
TabGroup	groupRule(String groupRule)
TabGroup	groupRuleMetadata(PropertyMetadata groupRuleMetadata)
int	hashCode()
TabGroup	maximumAllowed(String maximumAllowed)
TabGroup	maximumAllowedMetadata(PropertyMetadata maximumAllowedMetadata)
TabGroup	minimumRequired(String minimumRequired)
TabGroup	minimumRequiredMetadata(PropertyMetadata minimumRequiredMetadata)
TabGroup	recipientId(String recipientId)
TabGroup	recipientIdMetadata(PropertyMetadata recipientIdMetadata)
void	setChildTabLabels(List<String> childTabLabels)
void	setChildTabLabelsMetadata(PropertyMetadata childTabLabelsMetadata)
void	setErrorDetails(ErrorDetails errorDetails)
void	setGroupLabel(String groupLabel)
void	setGroupLabelMetadata(PropertyMetadata groupLabelMetadata)
void	setGroupRule(String groupRule)
void	setGroupRuleMetadata(PropertyMetadata groupRuleMetadata)
void	setMaximumAllowed(String maximumAllowed)
void	setMaximumAllowedMetadata(PropertyMetadata maximumAllowedMetadata)
void	setMinimumRequired(String minimumRequired)
void	setMinimumRequiredMetadata(PropertyMetadata minimumRequiredMetadata)
void	setRecipientId(String recipientId)
void	setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)
void	setTabId(String tabId)
void	setTabIdMetadata(PropertyMetadata tabIdMetadata)
void	setTemplateLocked(String templateLocked)
void	setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)
void	setTemplateRequired(String templateRequired)
void	setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
void	setValidationMessage(String validationMessage)
void	setValidationMessageMetadata(PropertyMetadata validationMessageMetadata)
TabGroup	tabId(String tabId)
TabGroup	tabIdMetadata(PropertyMetadata tabIdMetadata)
TabGroup	templateLocked(String templateLocked)
TabGroup	templateLockedMetadata(PropertyMetadata templateLockedMetadata)
TabGroup	templateRequired(String templateRequired)
TabGroup	templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
String	toString()
TabGroup	validationMessage(String validationMessage)
TabGroup	validationMessageMetadata(PropertyMetadata validationMessageMetadata)

Methods inherited from class java.lang.Object

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

Constructor Detail

TabGroup

public TabGroup()

Method Detail

childTabLabels

public TabGroup childTabLabels(List<String> childTabLabels)

addChildTabLabelsItem

public TabGroup addChildTabLabelsItem(String childTabLabelsItem)

getChildTabLabels

public List<String> getChildTabLabels()

Returns:

childTabLabels

setChildTabLabels

public void setChildTabLabels(List<String> childTabLabels)

childTabLabelsMetadata

public TabGroup childTabLabelsMetadata(PropertyMetadata childTabLabelsMetadata)

getChildTabLabelsMetadata

public PropertyMetadata getChildTabLabelsMetadata()

Get childTabLabelsMetadata

Returns:

childTabLabelsMetadata

setChildTabLabelsMetadata

public void setChildTabLabelsMetadata(PropertyMetadata childTabLabelsMetadata)

errorDetails

public TabGroup errorDetails(ErrorDetails errorDetails)

getErrorDetails

public ErrorDetails getErrorDetails()

Get errorDetails

Returns:

errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

groupLabel

public TabGroup groupLabel(String groupLabel)

getGroupLabel

public String getGroupLabel()

Returns:

groupLabel

setGroupLabel

public void setGroupLabel(String groupLabel)

groupLabelMetadata

public TabGroup groupLabelMetadata(PropertyMetadata groupLabelMetadata)

getGroupLabelMetadata

public PropertyMetadata getGroupLabelMetadata()

Get groupLabelMetadata

Returns:

groupLabelMetadata

setGroupLabelMetadata

public void setGroupLabelMetadata(PropertyMetadata groupLabelMetadata)

groupRule

public TabGroup groupRule(String groupRule)

getGroupRule

public String getGroupRule()

Returns:

groupRule

setGroupRule

public void setGroupRule(String groupRule)

groupRuleMetadata

public TabGroup groupRuleMetadata(PropertyMetadata groupRuleMetadata)

getGroupRuleMetadata

public PropertyMetadata getGroupRuleMetadata()

Get groupRuleMetadata

Returns:

groupRuleMetadata

setGroupRuleMetadata

public void setGroupRuleMetadata(PropertyMetadata groupRuleMetadata)

maximumAllowed

public TabGroup maximumAllowed(String maximumAllowed)

getMaximumAllowed

public String getMaximumAllowed()

Returns:

maximumAllowed

setMaximumAllowed

public void setMaximumAllowed(String maximumAllowed)

maximumAllowedMetadata

public TabGroup maximumAllowedMetadata(PropertyMetadata maximumAllowedMetadata)

getMaximumAllowedMetadata

public PropertyMetadata getMaximumAllowedMetadata()

Get maximumAllowedMetadata

Returns:

maximumAllowedMetadata

setMaximumAllowedMetadata

public void setMaximumAllowedMetadata(PropertyMetadata maximumAllowedMetadata)

minimumRequired

public TabGroup minimumRequired(String minimumRequired)

getMinimumRequired

public String getMinimumRequired()

Returns:

minimumRequired

setMinimumRequired

public void setMinimumRequired(String minimumRequired)

minimumRequiredMetadata

public TabGroup minimumRequiredMetadata(PropertyMetadata minimumRequiredMetadata)

getMinimumRequiredMetadata

public PropertyMetadata getMinimumRequiredMetadata()

Get minimumRequiredMetadata

Returns:

minimumRequiredMetadata

setMinimumRequiredMetadata

public void setMinimumRequiredMetadata(PropertyMetadata minimumRequiredMetadata)

recipientId

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

recipientIdMetadata

public TabGroup recipientIdMetadata(PropertyMetadata recipientIdMetadata)

getRecipientIdMetadata

public PropertyMetadata getRecipientIdMetadata()

Get recipientIdMetadata

Returns:

recipientIdMetadata

setRecipientIdMetadata

public void setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)

tabId

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

tabIdMetadata

public TabGroup tabIdMetadata(PropertyMetadata tabIdMetadata)

getTabIdMetadata

public PropertyMetadata getTabIdMetadata()

Get tabIdMetadata

Returns:

tabIdMetadata

setTabIdMetadata

public void setTabIdMetadata(PropertyMetadata tabIdMetadata)

templateLocked

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

templateLockedMetadata

public TabGroup templateLockedMetadata(PropertyMetadata templateLockedMetadata)

getTemplateLockedMetadata

public PropertyMetadata getTemplateLockedMetadata()

Get templateLockedMetadata

Returns:

templateLockedMetadata

setTemplateLockedMetadata

public void setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)

templateRequired

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

templateRequiredMetadata

public TabGroup templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)

getTemplateRequiredMetadata

public PropertyMetadata getTemplateRequiredMetadata()

Get templateRequiredMetadata

Returns:

templateRequiredMetadata

setTemplateRequiredMetadata

public void setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)

validationMessage

public TabGroup validationMessage(String validationMessage)

getValidationMessage

public String getValidationMessage()

The message displayed if the custom tab fails input validation (either custom of embedded).

Returns:

validationMessage

setValidationMessage

public void setValidationMessage(String validationMessage)

validationMessageMetadata

public TabGroup validationMessageMetadata(PropertyMetadata validationMessageMetadata)

getValidationMessageMetadata

public PropertyMetadata getValidationMessageMetadata()

Get validationMessageMetadata

Returns:

validationMessageMetadata

setValidationMessageMetadata

public void setValidationMessageMetadata(PropertyMetadata validationMessageMetadata)

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