Package com.docusign.esign.model

Class Decline

  • public class Decline
extends Object
    Decline.

    • Constructor Detail

      • Decline

        public Decline()

    • Method Detail

      • anchorCaseSensitive

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

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

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

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

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

      • getAnchorString

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

      • setAnchorString

        public void setAnchorString​(String anchorString)
        setAnchorString.

      • anchorUnits

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

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

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

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

      • bold

        public Decline bold​(String bold)
        bold.
        Returns:
        Decline

      • getBold

        public String getBold()
        When set to **true**, the information in the tab is bold..
        Returns:
        bold

      • setBold

        public void setBold​(String bold)
        setBold.

      • buttonText

        public Decline buttonText​(String buttonText)
        buttonText.
        Returns:
        Decline

      • getButtonText

        public String getButtonText()
        Specifies the decline text displayed in the tab..
        Returns:
        buttonText

      • setButtonText

        public void setButtonText​(String buttonText)
        setButtonText.

      • conditionalParentLabel

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

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

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

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

      • declineReason

        public Decline declineReason​(String declineReason)
        declineReason.
        Returns:
        Decline

      • getDeclineReason

        public String getDeclineReason()
        The reason the recipient declined the document..
        Returns:
        declineReason

      • setDeclineReason

        public void setDeclineReason​(String declineReason)
        setDeclineReason.

      • documentId

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

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

      • errorDetails

        public Decline errorDetails​(ErrorDetails errorDetails)
        errorDetails.
        Returns:
        Decline

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Get errorDetails.
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • font

        public Decline font​(String font)
        font.
        Returns:
        Decline

      • getFont

        public String getFont()
        The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default..
        Returns:
        font

      • setFont

        public void setFont​(String font)
        setFont.

      • fontColor

        public Decline fontColor​(String fontColor)
        fontColor.
        Returns:
        Decline

      • getFontColor

        public String getFontColor()
        The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White..
        Returns:
        fontColor

      • setFontColor

        public void setFontColor​(String fontColor)
        setFontColor.

      • fontSize

        public Decline fontSize​(String fontSize)
        fontSize.
        Returns:
        Decline

      • getFontSize

        public String getFontSize()
        The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72..
        Returns:
        fontSize

      • setFontSize

        public void setFontSize​(String fontSize)
        setFontSize.

      • height

        public Decline height​(Integer height)
        height.
        Returns:
        Decline

      • getHeight

        public Integer getHeight()
        Height of the tab in pixels..
        Returns:
        height

      • setHeight

        public void setHeight​(Integer height)
        setHeight.

      • italic

        public Decline italic​(String italic)
        italic.
        Returns:
        Decline

      • getItalic

        public String getItalic()
        When set to **true**, the information in the tab is italic..
        Returns:
        italic

      • setItalic

        public void setItalic​(String italic)
        setItalic.

      • mergeField

        public Decline mergeField​(MergeField mergeField)
        mergeField.
        Returns:
        Decline

      • getMergeField

        public MergeField getMergeField()
        Get mergeField.
        Returns:
        mergeField

      • setMergeField

        public void setMergeField​(MergeField mergeField)
        setMergeField.

      • pageNumber

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

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

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

      • status

        public Decline status​(String status)
        status.
        Returns:
        Decline

      • 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 Decline tabGroupLabels​(List<String> tabGroupLabels)
        tabGroupLabels.
        Returns:
        Decline

      • addTabGroupLabelsItem

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

      • getTabGroupLabels

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

      • setTabGroupLabels

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

      • tabId

        public Decline tabId​(String tabId)
        tabId.
        Returns:
        Decline

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

      • tabLabel

        public Decline tabLabel​(String tabLabel)
        tabLabel.
        Returns:
        Decline

      • getTabLabel

        public String getTabLabel()
        The label string associated with the tab..
        Returns:
        tabLabel

      • setTabLabel

        public void setTabLabel​(String tabLabel)
        setTabLabel.

      • tabOrder

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

      • getTabOrder

        public String getTabOrder()
        .
        Returns:
        tabOrder

      • setTabOrder

        public void setTabOrder​(String tabOrder)
        setTabOrder.

      • templateLocked

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

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

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

      • getTooltip

        public String getTooltip()
        .
        Returns:
        tooltip

      • setTooltip

        public void setTooltip​(String tooltip)
        setTooltip.

      • underline

        public Decline underline​(String underline)
        underline.
        Returns:
        Decline

      • getUnderline

        public String getUnderline()
        When set to **true**, the information in the tab is underlined..
        Returns:
        underline

      • setUnderline

        public void setUnderline​(String underline)
        setUnderline.

      • width

        public Decline width​(Integer width)
        width.
        Returns:
        Decline

      • getWidth

        public Integer getWidth()
        Width of the tab in pixels..
        Returns:
        width

      • setWidth

        public void setWidth​(Integer width)
        setWidth.

      • xPosition

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

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

      • 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