Package com.docusign.esign.model

Class MergeField

  • public class MergeField
extends java.lang.Object
    Contains information for transfering values between Salesforce data fields and DocuSign Tabs..

    • Constructor Detail

      • MergeField

        public MergeField()

    • Method Detail

      • allowSenderToEdit

        public MergeField allowSenderToEdit​(java.lang.String allowSenderToEdit)
        allowSenderToEdit.
        Returns:
        MergeField

      • getAllowSenderToEdit

        public java.lang.String getAllowSenderToEdit()
        When set to **true**, the sender can modify the value of the custom tab during the sending process..
        Returns:
        allowSenderToEdit

      • setAllowSenderToEdit

        public void setAllowSenderToEdit​(java.lang.String allowSenderToEdit)
        setAllowSenderToEdit.

      • allowSenderToEditMetadata

        public MergeField allowSenderToEditMetadata​(PropertyMetadata allowSenderToEditMetadata)
        allowSenderToEditMetadata.
        Returns:
        MergeField

      • getAllowSenderToEditMetadata

        public PropertyMetadata getAllowSenderToEditMetadata()
        Get allowSenderToEditMetadata.
        Returns:
        allowSenderToEditMetadata

      • setAllowSenderToEditMetadata

        public void setAllowSenderToEditMetadata​(PropertyMetadata allowSenderToEditMetadata)
        setAllowSenderToEditMetadata.

      • configurationType

        public MergeField configurationType​(java.lang.String configurationType)
        configurationType.
        Returns:
        MergeField

      • getConfigurationType

        public java.lang.String getConfigurationType()
        If merge field's are being used, specifies the type of the merge field. The only supported value is **salesforce**..
        Returns:
        configurationType

      • setConfigurationType

        public void setConfigurationType​(java.lang.String configurationType)
        setConfigurationType.

      • configurationTypeMetadata

        public MergeField configurationTypeMetadata​(PropertyMetadata configurationTypeMetadata)
        configurationTypeMetadata.
        Returns:
        MergeField

      • getConfigurationTypeMetadata

        public PropertyMetadata getConfigurationTypeMetadata()
        Get configurationTypeMetadata.
        Returns:
        configurationTypeMetadata

      • setConfigurationTypeMetadata

        public void setConfigurationTypeMetadata​(PropertyMetadata configurationTypeMetadata)
        setConfigurationTypeMetadata.

      • path

        public MergeField path​(java.lang.String path)
        path.
        Returns:
        MergeField

      • getPath

        public java.lang.String getPath()
        Sets the object associated with the custom tab. Currently this is the Salesforce Object..
        Returns:
        path

      • setPath

        public void setPath​(java.lang.String path)
        setPath.

      • getPathExtended

        public java.util.List<PathExtendedElement> getPathExtended()
        .
        Returns:
        pathExtended

      • setPathExtended

        public void setPathExtended​(java.util.List<PathExtendedElement> pathExtended)
        setPathExtended.

      • pathExtendedMetadata

        public MergeField pathExtendedMetadata​(PropertyMetadata pathExtendedMetadata)
        pathExtendedMetadata.
        Returns:
        MergeField

      • getPathExtendedMetadata

        public PropertyMetadata getPathExtendedMetadata()
        Get pathExtendedMetadata.
        Returns:
        pathExtendedMetadata

      • setPathExtendedMetadata

        public void setPathExtendedMetadata​(PropertyMetadata pathExtendedMetadata)
        setPathExtendedMetadata.

      • getPathMetadata

        public PropertyMetadata getPathMetadata()
        Get pathMetadata.
        Returns:
        pathMetadata

      • setPathMetadata

        public void setPathMetadata​(PropertyMetadata pathMetadata)
        setPathMetadata.

      • row

        public MergeField row​(java.lang.String row)
        row.
        Returns:
        MergeField

      • getRow

        public java.lang.String getRow()
        Specifies the row number in a Salesforce table that the merge field value corresponds to..
        Returns:
        row

      • setRow

        public void setRow​(java.lang.String row)
        setRow.

      • getRowMetadata

        public PropertyMetadata getRowMetadata()
        Get rowMetadata.
        Returns:
        rowMetadata

      • setRowMetadata

        public void setRowMetadata​(PropertyMetadata rowMetadata)
        setRowMetadata.

      • writeBack

        public MergeField writeBack​(java.lang.String writeBack)
        writeBack.
        Returns:
        MergeField

      • getWriteBack

        public java.lang.String getWriteBack()
        When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed..
        Returns:
        writeBack

      • setWriteBack

        public void setWriteBack​(java.lang.String writeBack)
        setWriteBack.

      • writeBackMetadata

        public MergeField writeBackMetadata​(PropertyMetadata writeBackMetadata)
        writeBackMetadata.
        Returns:
        MergeField

      • getWriteBackMetadata

        public PropertyMetadata getWriteBackMetadata()
        Get writeBackMetadata.
        Returns:
        writeBackMetadata

      • setWriteBackMetadata

        public void setWriteBackMetadata​(PropertyMetadata writeBackMetadata)
        setWriteBackMetadata.

      • equals

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

      • hashCode

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

      • toString

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