com.docusign.esign.model

Class RadioGroup

java.lang.Object

com.docusign.esign.model.RadioGroup

public class RadioGroup
extends Object

RadioGroup

Constructor Summary

Constructors

Constructor and Description
RadioGroup()

Method Summary

Modifier and Type	Method and Description
RadioGroup	addRadiosItem(Radio radiosItem)
RadioGroup	conditionalParentLabel(String conditionalParentLabel)
RadioGroup	conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
RadioGroup	conditionalParentValue(String conditionalParentValue)
RadioGroup	conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
RadioGroup	documentId(String documentId)
RadioGroup	documentIdMetadata(PropertyMetadata documentIdMetadata)
boolean	equals(Object o)
String	getConditionalParentLabel() For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
PropertyMetadata	getConditionalParentLabelMetadata() Get conditionalParentLabelMetadata
String	getConditionalParentValue() For conditional fields, this is the value of the parent tab that controls the tab's visibility.
PropertyMetadata	getConditionalParentValueMetadata() Get conditionalParentValueMetadata
String	getDocumentId() Specifies the document ID number that the tab is placed on.
PropertyMetadata	getDocumentIdMetadata() Get documentIdMetadata
String	getGroupName() The name of the group.
PropertyMetadata	getGroupNameMetadata() Get groupNameMetadata
List<Radio>	getRadios() Specifies the locations and status for radio buttons that are grouped together.
String	getRecipientId() Unique for the recipient.
String	getRecipientIdGuid()
PropertyMetadata	getRecipientIdGuidMetadata() Get recipientIdGuidMetadata
PropertyMetadata	getRecipientIdMetadata() Get recipientIdMetadata
String	getRequireAll() When set to **true** and shared is true, information must be entered in this field to complete the envelope.
PropertyMetadata	getRequireAllMetadata() Get requireAllMetadata
String	getRequireInitialOnSharedChange() Optional element for field markup.
PropertyMetadata	getRequireInitialOnSharedChangeMetadata() Get requireInitialOnSharedChangeMetadata
String	getShared() When set to **true**, this custom tab is shared.
PropertyMetadata	getSharedMetadata() Get sharedMetadata
String	getTabType()
PropertyMetadata	getTabTypeMetadata() Get tabTypeMetadata
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	getTooltip()
PropertyMetadata	getTooltipMetadata() Get tooltipMetadata
RadioGroup	groupName(String groupName)
RadioGroup	groupNameMetadata(PropertyMetadata groupNameMetadata)
int	hashCode()
RadioGroup	radios(List<Radio> radios)
RadioGroup	recipientId(String recipientId)
RadioGroup	recipientIdGuid(String recipientIdGuid)
RadioGroup	recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
RadioGroup	recipientIdMetadata(PropertyMetadata recipientIdMetadata)
RadioGroup	requireAll(String requireAll)
RadioGroup	requireAllMetadata(PropertyMetadata requireAllMetadata)
RadioGroup	requireInitialOnSharedChange(String requireInitialOnSharedChange)
RadioGroup	requireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)
void	setConditionalParentLabel(String conditionalParentLabel)
void	setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
void	setConditionalParentValue(String conditionalParentValue)
void	setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
void	setDocumentId(String documentId)
void	setDocumentIdMetadata(PropertyMetadata documentIdMetadata)
void	setGroupName(String groupName)
void	setGroupNameMetadata(PropertyMetadata groupNameMetadata)
void	setRadios(List<Radio> radios)
void	setRecipientId(String recipientId)
void	setRecipientIdGuid(String recipientIdGuid)
void	setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
void	setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)
void	setRequireAll(String requireAll)
void	setRequireAllMetadata(PropertyMetadata requireAllMetadata)
void	setRequireInitialOnSharedChange(String requireInitialOnSharedChange)
void	setRequireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)
void	setShared(String shared)
void	setSharedMetadata(PropertyMetadata sharedMetadata)
void	setTabType(String tabType)
void	setTabTypeMetadata(PropertyMetadata tabTypeMetadata)
void	setTemplateLocked(String templateLocked)
void	setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)
void	setTemplateRequired(String templateRequired)
void	setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
void	setTooltip(String tooltip)
void	setTooltipMetadata(PropertyMetadata tooltipMetadata)
RadioGroup	shared(String shared)
RadioGroup	sharedMetadata(PropertyMetadata sharedMetadata)
RadioGroup	tabType(String tabType)
RadioGroup	tabTypeMetadata(PropertyMetadata tabTypeMetadata)
RadioGroup	templateLocked(String templateLocked)
RadioGroup	templateLockedMetadata(PropertyMetadata templateLockedMetadata)
RadioGroup	templateRequired(String templateRequired)
RadioGroup	templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
RadioGroup	tooltip(String tooltip)
RadioGroup	tooltipMetadata(PropertyMetadata tooltipMetadata)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

RadioGroup

public RadioGroup()

Method Detail

conditionalParentLabel

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

conditionalParentLabelMetadata

public RadioGroup conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)

getConditionalParentLabelMetadata

public PropertyMetadata getConditionalParentLabelMetadata()

Get conditionalParentLabelMetadata

Returns:

conditionalParentLabelMetadata

setConditionalParentLabelMetadata

public void setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)

conditionalParentValue

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

conditionalParentValueMetadata

public RadioGroup conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)

getConditionalParentValueMetadata

public PropertyMetadata getConditionalParentValueMetadata()

Get conditionalParentValueMetadata

Returns:

conditionalParentValueMetadata

setConditionalParentValueMetadata

public void setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)

documentId

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

documentIdMetadata

public RadioGroup documentIdMetadata(PropertyMetadata documentIdMetadata)

getDocumentIdMetadata

public PropertyMetadata getDocumentIdMetadata()

Get documentIdMetadata

Returns:

documentIdMetadata

setDocumentIdMetadata

public void setDocumentIdMetadata(PropertyMetadata documentIdMetadata)

groupName

public RadioGroup groupName(String groupName)

getGroupName

public String getGroupName()

The name of the group.

Returns:

groupName

setGroupName

public void setGroupName(String groupName)

groupNameMetadata

public RadioGroup groupNameMetadata(PropertyMetadata groupNameMetadata)

getGroupNameMetadata

public PropertyMetadata getGroupNameMetadata()

Get groupNameMetadata

Returns:

groupNameMetadata

setGroupNameMetadata

public void setGroupNameMetadata(PropertyMetadata groupNameMetadata)

radios

public RadioGroup radios(List<Radio> radios)

addRadiosItem

public RadioGroup addRadiosItem(Radio radiosItem)

getRadios

public List<Radio> getRadios()

Specifies the locations and status for radio buttons that are grouped together.

Returns:

radios

setRadios

public void setRadios(List<Radio> radios)

recipientId

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

recipientIdGuid

public RadioGroup recipientIdGuid(String recipientIdGuid)

getRecipientIdGuid

public String getRecipientIdGuid()

Returns:

recipientIdGuid

setRecipientIdGuid

public void setRecipientIdGuid(String recipientIdGuid)

recipientIdGuidMetadata

public RadioGroup recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)

getRecipientIdGuidMetadata

public PropertyMetadata getRecipientIdGuidMetadata()

Get recipientIdGuidMetadata

Returns:

recipientIdGuidMetadata

setRecipientIdGuidMetadata

public void setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)

recipientIdMetadata

public RadioGroup recipientIdMetadata(PropertyMetadata recipientIdMetadata)

getRecipientIdMetadata

public PropertyMetadata getRecipientIdMetadata()

Get recipientIdMetadata

Returns:

recipientIdMetadata

setRecipientIdMetadata

public void setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)

requireAll

public RadioGroup requireAll(String requireAll)

getRequireAll

public String getRequireAll()

When set to **true** and shared is true, information must be entered in this field to complete the envelope.

Returns:

requireAll

setRequireAll

public void setRequireAll(String requireAll)

requireAllMetadata

public RadioGroup requireAllMetadata(PropertyMetadata requireAllMetadata)

getRequireAllMetadata

public PropertyMetadata getRequireAllMetadata()

Get requireAllMetadata

Returns:

requireAllMetadata

setRequireAllMetadata

public void setRequireAllMetadata(PropertyMetadata requireAllMetadata)

requireInitialOnSharedChange

public RadioGroup requireInitialOnSharedChange(String requireInitialOnSharedChange)

getRequireInitialOnSharedChange

public String getRequireInitialOnSharedChange()

Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.

Returns:

requireInitialOnSharedChange

setRequireInitialOnSharedChange

public void setRequireInitialOnSharedChange(String requireInitialOnSharedChange)

requireInitialOnSharedChangeMetadata

public RadioGroup requireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)

getRequireInitialOnSharedChangeMetadata

public PropertyMetadata getRequireInitialOnSharedChangeMetadata()

Get requireInitialOnSharedChangeMetadata

Returns:

requireInitialOnSharedChangeMetadata

setRequireInitialOnSharedChangeMetadata

public void setRequireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)

shared

public RadioGroup shared(String shared)

getShared

public String getShared()

When set to **true**, this custom tab is shared.

Returns:

shared

setShared

public void setShared(String shared)

sharedMetadata

public RadioGroup sharedMetadata(PropertyMetadata sharedMetadata)

getSharedMetadata

public PropertyMetadata getSharedMetadata()

Get sharedMetadata

Returns:

sharedMetadata

setSharedMetadata

public void setSharedMetadata(PropertyMetadata sharedMetadata)

tabType

public RadioGroup tabType(String tabType)

getTabType

public String getTabType()

Returns:

tabType

setTabType

public void setTabType(String tabType)

tabTypeMetadata

public RadioGroup tabTypeMetadata(PropertyMetadata tabTypeMetadata)

getTabTypeMetadata

public PropertyMetadata getTabTypeMetadata()

Get tabTypeMetadata

Returns:

tabTypeMetadata

setTabTypeMetadata

public void setTabTypeMetadata(PropertyMetadata tabTypeMetadata)

templateLocked

public RadioGroup 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 RadioGroup templateLockedMetadata(PropertyMetadata templateLockedMetadata)

getTemplateLockedMetadata

public PropertyMetadata getTemplateLockedMetadata()

Get templateLockedMetadata

Returns:

templateLockedMetadata

setTemplateLockedMetadata

public void setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)

templateRequired

public RadioGroup 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 RadioGroup templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)

getTemplateRequiredMetadata

public PropertyMetadata getTemplateRequiredMetadata()

Get templateRequiredMetadata

Returns:

templateRequiredMetadata

setTemplateRequiredMetadata

public void setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)

tooltip

public RadioGroup tooltip(String tooltip)

getTooltip

public String getTooltip()

Returns:

tooltip

setTooltip

public void setTooltip(String tooltip)

tooltipMetadata

public RadioGroup tooltipMetadata(PropertyMetadata tooltipMetadata)

getTooltipMetadata

public PropertyMetadata getTooltipMetadata()

Get tooltipMetadata

Returns:

tooltipMetadata

setTooltipMetadata

public void setTooltipMetadata(PropertyMetadata tooltipMetadata)

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