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

Methods

Modifier and Type	Method and Description
RadioGroup	addRadiosItem(Radio radiosItem)
RadioGroup	conditionalParentLabel(String conditionalParentLabel)
RadioGroup	conditionalParentValue(String conditionalParentValue)
RadioGroup	documentId(String documentId)
boolean	equals(Object o)
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	getDocumentId() Specifies the document ID number that the tab is placed on.
String	getGroupName() The name of the group.
List<Radio>	getRadios() Specifies the locations and status for radio buttons that are grouped together.
String	getRecipientId() Unique for the recipient.
String	getRequireAll() When set to **true** and shared is true, information must be entered in this field to complete the envelope.
String	getRequireInitialOnSharedChange() Optional element for field markup.
String	getShared() When set to **true**, this custom tab is shared.
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.
RadioGroup	groupName(String groupName)
int	hashCode()
RadioGroup	radios(List<Radio> radios)
RadioGroup	recipientId(String recipientId)
RadioGroup	requireAll(String requireAll)
RadioGroup	requireInitialOnSharedChange(String requireInitialOnSharedChange)
void	setConditionalParentLabel(String conditionalParentLabel)
void	setConditionalParentValue(String conditionalParentValue)
void	setDocumentId(String documentId)
void	setGroupName(String groupName)
void	setRadios(List<Radio> radios)
void	setRecipientId(String recipientId)
void	setRequireAll(String requireAll)
void	setRequireInitialOnSharedChange(String requireInitialOnSharedChange)
void	setShared(String shared)
void	setTemplateLocked(String templateLocked)
void	setTemplateRequired(String templateRequired)
RadioGroup	shared(String shared)
RadioGroup	templateLocked(String templateLocked)
RadioGroup	templateRequired(String templateRequired)
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)

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)

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)

groupName

public RadioGroup groupName(String groupName)

getGroupName

public String getGroupName()

The name of the group.

Returns:

groupName

setGroupName

public void setGroupName(String groupName)

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)

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)

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)

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)

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)

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)

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