Package com.docusign.esign.model
Class RadioGroup
- java.lang.Object
-
- com.docusign.esign.model.RadioGroup
-
public class RadioGroup extends Object
RadioGroup.
-
-
Constructor Summary
Constructors Constructor Description RadioGroup()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description RadioGroupaddRadiosItem(Radio radiosItem)addRadiosItem.RadioGroupconditionalParentLabel(String conditionalParentLabel)conditionalParentLabel.RadioGroupconditionalParentValue(String conditionalParentValue)conditionalParentValue.RadioGroupdocumentId(String documentId)documentId.booleanequals(Object o)Compares objects.StringgetConditionalParentLabel()For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility..StringgetConditionalParentValue()For conditional fields, this is the value of the parent tab that controls the tab's visibility.StringgetDocumentId()Specifies the document ID number that the tab is placed on.StringgetGroupName()The name of the group..List<Radio>getRadios()Specifies the locations and status for radio buttons that are grouped together..StringgetRecipientId()Unique for the recipient.StringgetRequireAll()When set to **true** and shared is true, information must be entered in this field to complete the envelope.StringgetRequireInitialOnSharedChange()Optional element for field markup.StringgetShared()When set to **true**, this custom tab is shared..StringgetTemplateLocked()When set to **true**, the sender cannot change any attributes of the recipient.StringgetTemplateRequired()When set to **true**, the sender may not remove the recipient.StringgetTooltip().RadioGroupgroupName(String groupName)groupName.inthashCode()Returns the HashCode.RadioGroupradios(List<Radio> radios)radios.RadioGrouprecipientId(String recipientId)recipientId.RadioGrouprequireAll(String requireAll)requireAll.RadioGrouprequireInitialOnSharedChange(String requireInitialOnSharedChange)requireInitialOnSharedChange.voidsetConditionalParentLabel(String conditionalParentLabel)setConditionalParentLabel.voidsetConditionalParentValue(String conditionalParentValue)setConditionalParentValue.voidsetDocumentId(String documentId)setDocumentId.voidsetGroupName(String groupName)setGroupName.voidsetRadios(List<Radio> radios)setRadios.voidsetRecipientId(String recipientId)setRecipientId.voidsetRequireAll(String requireAll)setRequireAll.voidsetRequireInitialOnSharedChange(String requireInitialOnSharedChange)setRequireInitialOnSharedChange.voidsetShared(String shared)setShared.voidsetTemplateLocked(String templateLocked)setTemplateLocked.voidsetTemplateRequired(String templateRequired)setTemplateRequired.voidsetTooltip(String tooltip)setTooltip.RadioGroupshared(String shared)shared.RadioGrouptemplateLocked(String templateLocked)templateLocked.RadioGrouptemplateRequired(String templateRequired)templateRequired.RadioGrouptooltip(String tooltip)tooltip.StringtoString()Converts the given object to string.
-
-
-
Method Detail
-
conditionalParentLabel
public RadioGroup conditionalParentLabel(String conditionalParentLabel)
conditionalParentLabel.- Returns:
- RadioGroup
-
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.
-
conditionalParentValue
public RadioGroup conditionalParentValue(String conditionalParentValue)
conditionalParentValue.- Returns:
- RadioGroup
-
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.
-
documentId
public RadioGroup documentId(String documentId)
documentId.- Returns:
- RadioGroup
-
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.
-
groupName
public RadioGroup groupName(String groupName)
groupName.- Returns:
- RadioGroup
-
getGroupName
public String getGroupName()
The name of the group..- Returns:
- groupName
-
setGroupName
public void setGroupName(String groupName)
setGroupName.
-
radios
public RadioGroup radios(List<Radio> radios)
radios.- Returns:
- RadioGroup
-
addRadiosItem
public RadioGroup addRadiosItem(Radio radiosItem)
addRadiosItem.- Returns:
- RadioGroup
-
getRadios
public List<Radio> getRadios()
Specifies the locations and status for radio buttons that are grouped together..- Returns:
- radios
-
recipientId
public RadioGroup recipientId(String recipientId)
recipientId.- Returns:
- RadioGroup
-
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.
-
requireAll
public RadioGroup requireAll(String requireAll)
requireAll.- Returns:
- RadioGroup
-
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)
setRequireAll.
-
requireInitialOnSharedChange
public RadioGroup requireInitialOnSharedChange(String requireInitialOnSharedChange)
requireInitialOnSharedChange.- Returns:
- RadioGroup
-
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)
setRequireInitialOnSharedChange.
-
shared
public RadioGroup shared(String shared)
shared.- Returns:
- RadioGroup
-
getShared
public String getShared()
When set to **true**, this custom tab is shared..- Returns:
- shared
-
setShared
public void setShared(String shared)
setShared.
-
templateLocked
public RadioGroup templateLocked(String templateLocked)
templateLocked.- Returns:
- RadioGroup
-
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.
-
templateRequired
public RadioGroup templateRequired(String templateRequired)
templateRequired.- Returns:
- RadioGroup
-
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.
-
tooltip
public RadioGroup tooltip(String tooltip)
tooltip.- Returns:
- RadioGroup
-
getTooltip
public String getTooltip()
.- Returns:
- tooltip
-
setTooltip
public void setTooltip(String tooltip)
setTooltip.
-
equals
public boolean equals(Object o)
Compares objects.
-
-