Package com.docusign.esign.model

Class SmartSection

  • public class SmartSection
extends Object
    SmartSection.

    • Constructor Detail

      • SmartSection

        public SmartSection()

    • Method Detail

      • anchorCaseSensitive

        public SmartSection anchorCaseSensitive​(String anchorCaseSensitive)
        anchorCaseSensitive.
        Returns:
        SmartSection

      • getAnchorCaseSensitive

        public String getAnchorCaseSensitive()
        When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**..
        Returns:
        anchorCaseSensitive

      • setAnchorCaseSensitive

        public void setAnchorCaseSensitive​(String anchorCaseSensitive)
        setAnchorCaseSensitive.

      • anchorHorizontalAlignment

        public SmartSection anchorHorizontalAlignment​(String anchorHorizontalAlignment)
        anchorHorizontalAlignment.
        Returns:
        SmartSection

      • getAnchorHorizontalAlignment

        public String getAnchorHorizontalAlignment()
        Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**..
        Returns:
        anchorHorizontalAlignment

      • setAnchorHorizontalAlignment

        public void setAnchorHorizontalAlignment​(String anchorHorizontalAlignment)
        setAnchorHorizontalAlignment.

      • anchorIgnoreIfNotPresent

        public SmartSection anchorIgnoreIfNotPresent​(String anchorIgnoreIfNotPresent)
        anchorIgnoreIfNotPresent.
        Returns:
        SmartSection

      • getAnchorIgnoreIfNotPresent

        public String getAnchorIgnoreIfNotPresent()
        When set to **true**, this tab is ignored if anchorString is not found in the document..
        Returns:
        anchorIgnoreIfNotPresent

      • setAnchorIgnoreIfNotPresent

        public void setAnchorIgnoreIfNotPresent​(String anchorIgnoreIfNotPresent)
        setAnchorIgnoreIfNotPresent.

      • anchorMatchWholeWord

        public SmartSection anchorMatchWholeWord​(String anchorMatchWholeWord)
        anchorMatchWholeWord.
        Returns:
        SmartSection

      • getAnchorMatchWholeWord

        public String getAnchorMatchWholeWord()
        When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**..
        Returns:
        anchorMatchWholeWord

      • setAnchorMatchWholeWord

        public void setAnchorMatchWholeWord​(String anchorMatchWholeWord)
        setAnchorMatchWholeWord.

      • anchorString

        public SmartSection anchorString​(String anchorString)
        anchorString.
        Returns:
        SmartSection

      • getAnchorString

        public String getAnchorString()
        Anchor text information for a radio button..
        Returns:
        anchorString

      • setAnchorString

        public void setAnchorString​(String anchorString)
        setAnchorString.

      • anchorUnits

        public SmartSection anchorUnits​(String anchorUnits)
        anchorUnits.
        Returns:
        SmartSection

      • getAnchorUnits

        public String getAnchorUnits()
        Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches..
        Returns:
        anchorUnits

      • setAnchorUnits

        public void setAnchorUnits​(String anchorUnits)
        setAnchorUnits.

      • anchorXOffset

        public SmartSection anchorXOffset​(String anchorXOffset)
        anchorXOffset.
        Returns:
        SmartSection

      • getAnchorXOffset

        public String getAnchorXOffset()
        Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..
        Returns:
        anchorXOffset

      • setAnchorXOffset

        public void setAnchorXOffset​(String anchorXOffset)
        setAnchorXOffset.

      • anchorYOffset

        public SmartSection anchorYOffset​(String anchorYOffset)
        anchorYOffset.
        Returns:
        SmartSection

      • getAnchorYOffset

        public String getAnchorYOffset()
        Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..
        Returns:
        anchorYOffset

      • setAnchorYOffset

        public void setAnchorYOffset​(String anchorYOffset)
        setAnchorYOffset.

      • caseSensitive

        public SmartSection caseSensitive​(Boolean caseSensitive)
        caseSensitive.
        Returns:
        SmartSection

      • isCaseSensitive

        public Boolean isCaseSensitive()
        .
        Returns:
        caseSensitive

      • setCaseSensitive

        public void setCaseSensitive​(Boolean caseSensitive)
        setCaseSensitive.

      • conditionalParentLabel

        public SmartSection conditionalParentLabel​(String conditionalParentLabel)
        conditionalParentLabel.
        Returns:
        SmartSection

      • 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 SmartSection conditionalParentValue​(String conditionalParentValue)
        conditionalParentValue.
        Returns:
        SmartSection

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

      • customTabId

        public SmartSection customTabId​(String customTabId)
        customTabId.
        Returns:
        SmartSection

      • getCustomTabId

        public String getCustomTabId()
        The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties..
        Returns:
        customTabId

      • setCustomTabId

        public void setCustomTabId​(String customTabId)
        setCustomTabId.

      • documentId

        public SmartSection documentId​(String documentId)
        documentId.
        Returns:
        SmartSection

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

      • endAnchor

        public SmartSection endAnchor​(String endAnchor)
        endAnchor.
        Returns:
        SmartSection

      • getEndAnchor

        public String getEndAnchor()
        .
        Returns:
        endAnchor

      • setEndAnchor

        public void setEndAnchor​(String endAnchor)
        setEndAnchor.

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Get errorDetails.
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • getMergeField

        public MergeField getMergeField()
        Get mergeField.
        Returns:
        mergeField

      • setMergeField

        public void setMergeField​(MergeField mergeField)
        setMergeField.

      • pageNumber

        public SmartSection pageNumber​(String pageNumber)
        pageNumber.
        Returns:
        SmartSection

      • getPageNumber

        public String getPageNumber()
        Specifies the page number on which the tab is located..
        Returns:
        pageNumber

      • setPageNumber

        public void setPageNumber​(String pageNumber)
        setPageNumber.

      • recipientId

        public SmartSection recipientId​(String recipientId)
        recipientId.
        Returns:
        SmartSection

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

      • removeEndAnchor

        public SmartSection removeEndAnchor​(Boolean removeEndAnchor)
        removeEndAnchor.
        Returns:
        SmartSection

      • isRemoveEndAnchor

        public Boolean isRemoveEndAnchor()
        .
        Returns:
        removeEndAnchor

      • setRemoveEndAnchor

        public void setRemoveEndAnchor​(Boolean removeEndAnchor)
        setRemoveEndAnchor.

      • removeStartAnchor

        public SmartSection removeStartAnchor​(Boolean removeStartAnchor)
        removeStartAnchor.
        Returns:
        SmartSection

      • isRemoveStartAnchor

        public Boolean isRemoveStartAnchor()
        .
        Returns:
        removeStartAnchor

      • setRemoveStartAnchor

        public void setRemoveStartAnchor​(Boolean removeStartAnchor)
        setRemoveStartAnchor.

      • startAnchor

        public SmartSection startAnchor​(String startAnchor)
        startAnchor.
        Returns:
        SmartSection

      • getStartAnchor

        public String getStartAnchor()
        .
        Returns:
        startAnchor

      • setStartAnchor

        public void setStartAnchor​(String startAnchor)
        setStartAnchor.

      • getStatus

        public String getStatus()
        Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..
        Returns:
        status

      • setStatus

        public void setStatus​(String status)
        setStatus.

      • tabGroupLabels

        public SmartSection tabGroupLabels​(List<String> tabGroupLabels)
        tabGroupLabels.
        Returns:
        SmartSection

      • addTabGroupLabelsItem

        public SmartSection addTabGroupLabelsItem​(String tabGroupLabelsItem)
        addTabGroupLabelsItem.
        Returns:
        SmartSection

      • getTabGroupLabels

        public List<String> getTabGroupLabels()
        .
        Returns:
        tabGroupLabels

      • setTabGroupLabels

        public void setTabGroupLabels​(List<String> tabGroupLabels)
        setTabGroupLabels.

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

      • tabOrder

        public SmartSection tabOrder​(String tabOrder)
        tabOrder.
        Returns:
        SmartSection

      • getTabOrder

        public String getTabOrder()
        .
        Returns:
        tabOrder

      • setTabOrder

        public void setTabOrder​(String tabOrder)
        setTabOrder.

      • templateLocked

        public SmartSection templateLocked​(String templateLocked)
        templateLocked.
        Returns:
        SmartSection

      • 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 SmartSection templateRequired​(String templateRequired)
        templateRequired.
        Returns:
        SmartSection

      • 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 SmartSection tooltip​(String tooltip)
        tooltip.
        Returns:
        SmartSection

      • getTooltip

        public String getTooltip()
        .
        Returns:
        tooltip

      • setTooltip

        public void setTooltip​(String tooltip)
        setTooltip.

      • xPosition

        public SmartSection xPosition​(String xPosition)
        xPosition.
        Returns:
        SmartSection

      • getXPosition

        public String getXPosition()
        This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position..
        Returns:
        xPosition

      • setXPosition

        public void setXPosition​(String xPosition)
        setXPosition.

      • yPosition

        public SmartSection yPosition​(String yPosition)
        yPosition.
        Returns:
        SmartSection

      • getYPosition

        public String getYPosition()
        This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position..
        Returns:
        yPosition

      • setYPosition

        public void setYPosition​(String yPosition)
        setYPosition.

      • 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