Package com.docusign.esign.model

Class RadioGroup

  • All Implemented Interfaces:
    Serializable
    public class RadioGroup
extends Object
implements Serializable
    This group tab is used to place radio buttons on a document. The `radios` property contains a list of [`radio`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/) objects associated with the group. Only one radio button can be selected in a group. .
    See Also:
    Serialized Form

    • Constructor Detail

      • RadioGroup

        public RadioGroup()

    • 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.

      • conditionalParentLabelMetadata

        public RadioGroup conditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)
        conditionalParentLabelMetadata.
        Returns:
        RadioGroup

      • getConditionalParentLabelMetadata

        public PropertyMetadata getConditionalParentLabelMetadata()
        Metadata that indicates whether the `conditionalParentLabel` property is editable..
        Returns:
        conditionalParentLabelMetadata

      • setConditionalParentLabelMetadata

        public void setConditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)
        setConditionalParentLabelMetadata.

      • 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.

      • conditionalParentValueMetadata

        public RadioGroup conditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)
        conditionalParentValueMetadata.
        Returns:
        RadioGroup

      • getConditionalParentValueMetadata

        public PropertyMetadata getConditionalParentValueMetadata()
        Metadata that indicates whether the `conditionalParentValue` property is editable..
        Returns:
        conditionalParentValueMetadata

      • setConditionalParentValueMetadata

        public void setConditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)
        setConditionalParentValueMetadata.

      • 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.

      • documentIdMetadata

        public RadioGroup documentIdMetadata​(PropertyMetadata documentIdMetadata)
        documentIdMetadata.
        Returns:
        RadioGroup

      • getDocumentIdMetadata

        public PropertyMetadata getDocumentIdMetadata()
        Metadata that indicates whether the `documentId` property is editable..
        Returns:
        documentIdMetadata

      • setDocumentIdMetadata

        public void setDocumentIdMetadata​(PropertyMetadata documentIdMetadata)
        setDocumentIdMetadata.

      • 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.

      • groupNameMetadata

        public RadioGroup groupNameMetadata​(PropertyMetadata groupNameMetadata)
        groupNameMetadata.
        Returns:
        RadioGroup

      • getGroupNameMetadata

        public PropertyMetadata getGroupNameMetadata()
        Metadata that indicates whether the `groupName` property is editable..
        Returns:
        groupNameMetadata

      • setGroupNameMetadata

        public void setGroupNameMetadata​(PropertyMetadata groupNameMetadata)
        setGroupNameMetadata.

      • originalValue

        public RadioGroup originalValue​(String originalValue)
        originalValue.
        Returns:
        RadioGroup

      • 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 RadioGroup originalValueMetadata​(PropertyMetadata originalValueMetadata)
        originalValueMetadata.
        Returns:
        RadioGroup

      • getOriginalValueMetadata

        public PropertyMetadata getOriginalValueMetadata()
        Metadata that indicates whether the `originalValue` property is editable..
        Returns:
        originalValueMetadata

      • setOriginalValueMetadata

        public void setOriginalValueMetadata​(PropertyMetadata originalValueMetadata)
        setOriginalValueMetadata.

      • 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

      • setRadios

        public void setRadios​(List<Radio> radios)
        setRadios.

      • 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.

      • recipientIdGuid

        public RadioGroup recipientIdGuid​(String recipientIdGuid)
        recipientIdGuid.
        Returns:
        RadioGroup

      • getRecipientIdGuid

        public String getRecipientIdGuid()
        .
        Returns:
        recipientIdGuid

      • setRecipientIdGuid

        public void setRecipientIdGuid​(String recipientIdGuid)
        setRecipientIdGuid.

      • recipientIdGuidMetadata

        public RadioGroup recipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)
        recipientIdGuidMetadata.
        Returns:
        RadioGroup

      • getRecipientIdGuidMetadata

        public PropertyMetadata getRecipientIdGuidMetadata()
        Metadata that indicates whether the `recipientIdGuid` property is editable..
        Returns:
        recipientIdGuidMetadata

      • setRecipientIdGuidMetadata

        public void setRecipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)
        setRecipientIdGuidMetadata.

      • recipientIdMetadata

        public RadioGroup recipientIdMetadata​(PropertyMetadata recipientIdMetadata)
        recipientIdMetadata.
        Returns:
        RadioGroup

      • getRecipientIdMetadata

        public PropertyMetadata getRecipientIdMetadata()
        Metadata that indicates whether the `recipientId` property is editable..
        Returns:
        recipientIdMetadata

      • setRecipientIdMetadata

        public void setRecipientIdMetadata​(PropertyMetadata recipientIdMetadata)
        setRecipientIdMetadata.

      • 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.

      • requireAllMetadata

        public RadioGroup requireAllMetadata​(PropertyMetadata requireAllMetadata)
        requireAllMetadata.
        Returns:
        RadioGroup

      • getRequireAllMetadata

        public PropertyMetadata getRequireAllMetadata()
        Metadata that indicates whether the `requireAll` property is editable..
        Returns:
        requireAllMetadata

      • setRequireAllMetadata

        public void setRequireAllMetadata​(PropertyMetadata requireAllMetadata)
        setRequireAllMetadata.

      • 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.

      • requireInitialOnSharedChangeMetadata

        public RadioGroup requireInitialOnSharedChangeMetadata​(PropertyMetadata requireInitialOnSharedChangeMetadata)
        requireInitialOnSharedChangeMetadata.
        Returns:
        RadioGroup

      • getRequireInitialOnSharedChangeMetadata

        public PropertyMetadata getRequireInitialOnSharedChangeMetadata()
        Metadata that indicates whether the `requireInitialOnSharedChange` property is editable..
        Returns:
        requireInitialOnSharedChangeMetadata

      • setRequireInitialOnSharedChangeMetadata

        public void setRequireInitialOnSharedChangeMetadata​(PropertyMetadata requireInitialOnSharedChangeMetadata)
        setRequireInitialOnSharedChangeMetadata.

      • 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.

      • getSharedMetadata

        public PropertyMetadata getSharedMetadata()
        Metadata that indicates whether the `shared` property is editable..
        Returns:
        sharedMetadata

      • setSharedMetadata

        public void setSharedMetadata​(PropertyMetadata sharedMetadata)
        setSharedMetadata.

      • shareToRecipients

        public RadioGroup shareToRecipients​(String shareToRecipients)
        shareToRecipients.
        Returns:
        RadioGroup

      • getShareToRecipients

        public String getShareToRecipients()
        .
        Returns:
        shareToRecipients

      • setShareToRecipients

        public void setShareToRecipients​(String shareToRecipients)
        setShareToRecipients.

      • shareToRecipientsMetadata

        public RadioGroup shareToRecipientsMetadata​(PropertyMetadata shareToRecipientsMetadata)
        shareToRecipientsMetadata.
        Returns:
        RadioGroup

      • getShareToRecipientsMetadata

        public PropertyMetadata getShareToRecipientsMetadata()
        Reserved for DocuSign..
        Returns:
        shareToRecipientsMetadata

      • setShareToRecipientsMetadata

        public void setShareToRecipientsMetadata​(PropertyMetadata shareToRecipientsMetadata)
        setShareToRecipientsMetadata.

      • tabType

        public RadioGroup tabType​(String tabType)
        tabType.
        Returns:
        RadioGroup

      • getTabType

        public String getTabType()
        .
        Returns:
        tabType

      • setTabType

        public void setTabType​(String tabType)
        setTabType.

      • getTabTypeMetadata

        public PropertyMetadata getTabTypeMetadata()
        Metadata that indicates whether the `tabType` property is editable..
        Returns:
        tabTypeMetadata

      • setTabTypeMetadata

        public void setTabTypeMetadata​(PropertyMetadata tabTypeMetadata)
        setTabTypeMetadata.

      • 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.

      • templateLockedMetadata

        public RadioGroup templateLockedMetadata​(PropertyMetadata templateLockedMetadata)
        templateLockedMetadata.
        Returns:
        RadioGroup

      • getTemplateLockedMetadata

        public PropertyMetadata getTemplateLockedMetadata()
        Metadata that indicates whether the `templateLocked` property is editable..
        Returns:
        templateLockedMetadata

      • setTemplateLockedMetadata

        public void setTemplateLockedMetadata​(PropertyMetadata templateLockedMetadata)
        setTemplateLockedMetadata.

      • 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.

      • templateRequiredMetadata

        public RadioGroup templateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)
        templateRequiredMetadata.
        Returns:
        RadioGroup

      • getTemplateRequiredMetadata

        public PropertyMetadata getTemplateRequiredMetadata()
        Metadata that indicates whether the `templateRequired` property is editable..
        Returns:
        templateRequiredMetadata

      • setTemplateRequiredMetadata

        public void setTemplateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)
        setTemplateRequiredMetadata.

      • tooltip

        public RadioGroup tooltip​(String tooltip)
        tooltip.
        Returns:
        RadioGroup

      • getTooltip

        public String getTooltip()
        .
        Returns:
        tooltip

      • setTooltip

        public void setTooltip​(String tooltip)
        setTooltip.

      • getTooltipMetadata

        public PropertyMetadata getTooltipMetadata()
        Metadata that indicates whether the `tooltip` property is editable..
        Returns:
        tooltipMetadata

      • setTooltipMetadata

        public void setTooltipMetadata​(PropertyMetadata tooltipMetadata)
        setTooltipMetadata.

      • getValue

        public String getValue()
        Specifies the value of the tab. .
        Returns:
        value

      • setValue

        public void setValue​(String value)
        setValue.

      • getValueMetadata

        public PropertyMetadata getValueMetadata()
        Metadata that indicates whether the `value` property is editable..
        Returns:
        valueMetadata

      • setValueMetadata

        public void setValueMetadata​(PropertyMetadata valueMetadata)
        setValueMetadata.

      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.

      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object

      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object