com.docusign.esign.model

Class MergeField

java.lang.Object

com.docusign.esign.model.MergeField

public class MergeField
extends Object

Contains information for transfering values between Salesforce data fields and DocuSign Tabs.

Constructor Summary

Constructors

Constructor and Description
MergeField()

Method Summary

Modifier and Type	Method and Description
MergeField	addPathExtendedItem(PathExtendedElement pathExtendedItem)
MergeField	allowSenderToEdit(String allowSenderToEdit)
MergeField	allowSenderToEditMetadata(PropertyMetadata allowSenderToEditMetadata)
MergeField	configurationType(String configurationType)
MergeField	configurationTypeMetadata(PropertyMetadata configurationTypeMetadata)
boolean	equals(Object o)
String	getAllowSenderToEdit() When set to **true**, the sender can modify the value of the custom tab during the sending process.
PropertyMetadata	getAllowSenderToEditMetadata() Get allowSenderToEditMetadata
String	getConfigurationType() If merge field's are being used, specifies the type of the merge field.
PropertyMetadata	getConfigurationTypeMetadata() Get configurationTypeMetadata
String	getPath() Sets the object associated with the custom tab.
List<PathExtendedElement>	getPathExtended()
PropertyMetadata	getPathExtendedMetadata() Get pathExtendedMetadata
PropertyMetadata	getPathMetadata() Get pathMetadata
String	getRow() Specifies the row number in a Salesforce table that the merge field value corresponds to.
PropertyMetadata	getRowMetadata() Get rowMetadata
String	getWriteBack() When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed.
PropertyMetadata	getWriteBackMetadata() Get writeBackMetadata
int	hashCode()
MergeField	path(String path)
MergeField	pathExtended(List<PathExtendedElement> pathExtended)
MergeField	pathExtendedMetadata(PropertyMetadata pathExtendedMetadata)
MergeField	pathMetadata(PropertyMetadata pathMetadata)
MergeField	row(String row)
MergeField	rowMetadata(PropertyMetadata rowMetadata)
void	setAllowSenderToEdit(String allowSenderToEdit)
void	setAllowSenderToEditMetadata(PropertyMetadata allowSenderToEditMetadata)
void	setConfigurationType(String configurationType)
void	setConfigurationTypeMetadata(PropertyMetadata configurationTypeMetadata)
void	setPath(String path)
void	setPathExtended(List<PathExtendedElement> pathExtended)
void	setPathExtendedMetadata(PropertyMetadata pathExtendedMetadata)
void	setPathMetadata(PropertyMetadata pathMetadata)
void	setRow(String row)
void	setRowMetadata(PropertyMetadata rowMetadata)
void	setWriteBack(String writeBack)
void	setWriteBackMetadata(PropertyMetadata writeBackMetadata)
String	toString()
MergeField	writeBack(String writeBack)
MergeField	writeBackMetadata(PropertyMetadata writeBackMetadata)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MergeField

public MergeField()

Method Detail

allowSenderToEdit

public MergeField allowSenderToEdit(String allowSenderToEdit)

getAllowSenderToEdit

public 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(String allowSenderToEdit)

allowSenderToEditMetadata

public MergeField allowSenderToEditMetadata(PropertyMetadata allowSenderToEditMetadata)

getAllowSenderToEditMetadata

public PropertyMetadata getAllowSenderToEditMetadata()

Get allowSenderToEditMetadata

Returns:

allowSenderToEditMetadata

setAllowSenderToEditMetadata

public void setAllowSenderToEditMetadata(PropertyMetadata allowSenderToEditMetadata)

configurationType

public MergeField configurationType(String configurationType)

getConfigurationType

public 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(String configurationType)

configurationTypeMetadata

public MergeField configurationTypeMetadata(PropertyMetadata configurationTypeMetadata)

getConfigurationTypeMetadata

public PropertyMetadata getConfigurationTypeMetadata()

Get configurationTypeMetadata

Returns:

configurationTypeMetadata

setConfigurationTypeMetadata

public void setConfigurationTypeMetadata(PropertyMetadata configurationTypeMetadata)

path

public MergeField path(String path)

getPath

public String getPath()

Sets the object associated with the custom tab. Currently this is the Salesforce Object.

Returns:

path

setPath

public void setPath(String path)

pathExtended

public MergeField pathExtended(List<PathExtendedElement> pathExtended)

addPathExtendedItem

public MergeField addPathExtendedItem(PathExtendedElement pathExtendedItem)

getPathExtended

public List<PathExtendedElement> getPathExtended()

Returns:

pathExtended

setPathExtended

public void setPathExtended(List<PathExtendedElement> pathExtended)

pathExtendedMetadata

public MergeField pathExtendedMetadata(PropertyMetadata pathExtendedMetadata)

getPathExtendedMetadata

public PropertyMetadata getPathExtendedMetadata()

Get pathExtendedMetadata

Returns:

pathExtendedMetadata

setPathExtendedMetadata

public void setPathExtendedMetadata(PropertyMetadata pathExtendedMetadata)

pathMetadata

public MergeField pathMetadata(PropertyMetadata pathMetadata)

getPathMetadata

public PropertyMetadata getPathMetadata()

Get pathMetadata

Returns:

pathMetadata

setPathMetadata

public void setPathMetadata(PropertyMetadata pathMetadata)

row

public MergeField row(String row)

getRow

public String getRow()

Specifies the row number in a Salesforce table that the merge field value corresponds to.

Returns:

row

setRow

public void setRow(String row)

rowMetadata

public MergeField rowMetadata(PropertyMetadata rowMetadata)

getRowMetadata

public PropertyMetadata getRowMetadata()

Get rowMetadata

Returns:

rowMetadata

setRowMetadata

public void setRowMetadata(PropertyMetadata rowMetadata)

writeBack

public MergeField writeBack(String writeBack)

getWriteBack

public 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(String writeBack)

writeBackMetadata

public MergeField writeBackMetadata(PropertyMetadata writeBackMetadata)

getWriteBackMetadata

public PropertyMetadata getWriteBackMetadata()

Get writeBackMetadata

Returns:

writeBackMetadata

setWriteBackMetadata

public void setWriteBackMetadata(PropertyMetadata writeBackMetadata)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object