Package com.docusign.esign.model

Class Company

  • public class Company
extends Object
    Company.

    • Constructor Detail

      • Company

        public Company()

    • Method Detail

      • anchorCaseSensitive

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

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

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

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

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

      • getAnchorString

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

      • setAnchorString

        public void setAnchorString​(String anchorString)
        setAnchorString.

      • anchorUnits

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

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

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

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

      • getBold

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

      • setBold

        public void setBold​(String bold)
        setBold.

      • concealValueOnDocument

        public Company concealValueOnDocument​(String concealValueOnDocument)
        concealValueOnDocument.
        Returns:
        Company

      • getConcealValueOnDocument

        public String getConcealValueOnDocument()
        When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes..
        Returns:
        concealValueOnDocument

      • setConcealValueOnDocument

        public void setConcealValueOnDocument​(String concealValueOnDocument)
        setConcealValueOnDocument.

      • conditionalParentLabel

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

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

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

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

      • disableAutoSize

        public Company disableAutoSize​(String disableAutoSize)
        disableAutoSize.
        Returns:
        Company

      • getDisableAutoSize

        public String getDisableAutoSize()
        When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes..
        Returns:
        disableAutoSize

      • setDisableAutoSize

        public void setDisableAutoSize​(String disableAutoSize)
        setDisableAutoSize.

      • documentId

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

      • 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 Company errorDetails​(ErrorDetails errorDetails)
        errorDetails.
        Returns:
        Company

      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Get errorDetails.
        Returns:
        errorDetails

      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.

      • font

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

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

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

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

      • italic

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

      • getItalic

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

      • setItalic

        public void setItalic​(String italic)
        setItalic.

      • locked

        public Company locked​(String locked)
        locked.
        Returns:
        Company

      • getLocked

        public String getLocked()
        When set to **true**, the signer cannot change the data of the custom tab..
        Returns:
        locked

      • setLocked

        public void setLocked​(String locked)
        setLocked.

      • maxLength

        public Company maxLength​(Integer maxLength)
        maxLength.
        Returns:
        Company

      • getMaxLength

        public Integer getMaxLength()
        An optional value that describes the maximum length of the property when the property is a string..
        Returns:
        maxLength

      • setMaxLength

        public void setMaxLength​(Integer maxLength)
        setMaxLength.

      • mergeField

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

      • getMergeField

        public MergeField getMergeField()
        Get mergeField.
        Returns:
        mergeField

      • setMergeField

        public void setMergeField​(MergeField mergeField)
        setMergeField.

      • name

        public Company name​(String name)
        name.
        Returns:
        Company

      • getName

        public String getName()
        Specifies the tool tip text for the tab..
        Returns:
        name

      • setName

        public void setName​(String name)
        setName.

      • originalValue

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

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

      • pageNumber

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

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

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

      • required

        public Company required​(String required)
        required.
        Returns:
        Company

      • getRequired

        public String getRequired()
        When set to **true**, the signer is required to fill out this tab.
        Returns:
        required

      • setRequired

        public void setRequired​(String required)
        setRequired.

      • status

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

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

      • addTabGroupLabelsItem

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

      • getTabGroupLabels

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

      • setTabGroupLabels

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

      • tabId

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

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

      • getTabLabel

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

      • setTabLabel

        public void setTabLabel​(String tabLabel)
        setTabLabel.

      • tabOrder

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

      • getTabOrder

        public String getTabOrder()
        .
        Returns:
        tabOrder

      • setTabOrder

        public void setTabOrder​(String tabOrder)
        setTabOrder.

      • templateLocked

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

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

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

      • getTooltip

        public String getTooltip()
        .
        Returns:
        tooltip

      • setTooltip

        public void setTooltip​(String tooltip)
        setTooltip.

      • underline

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

      • getUnderline

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

      • setUnderline

        public void setUnderline​(String underline)
        setUnderline.

      • value

        public Company value​(String value)
        value.
        Returns:
        Company

      • getValue

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

      • setValue

        public void setValue​(String value)
        setValue.

      • width

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

      • getWidth

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

      • setWidth

        public void setWidth​(Integer width)
        setWidth.

      • xPosition

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

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

      • 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