Package com.docusign.esign.model
Class TextCustomField
- java.lang.Object
-
- com.docusign.esign.model.TextCustomField
-
- All Implemented Interfaces:
Serializable
public class TextCustomField extends Object implements Serializable
This object represents a free text custom field where envelope creators and senders can enter custom data..- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description TextCustomField()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TextCustomFieldconfigurationType(String configurationType)configurationType.booleanequals(Object o)Compares objects.TextCustomFielderrorDetails(ErrorDetails errorDetails)errorDetails.TextCustomFieldfieldId(String fieldId)fieldId.StringgetConfigurationType()If merge field's are being used, specifies the type of the merge field.ErrorDetailsgetErrorDetails()Array or errors..StringgetFieldId()An ID used to specify a custom field..StringgetName()The name of the custom field..StringgetRequired()When set to **true**, the signer is required to fill out this tab.StringgetShow()A boolean indicating if the value should be displayed..StringgetValue()The value of the custom field..inthashCode()Returns the HashCode.TextCustomFieldname(String name)name.TextCustomFieldrequired(String required)required.voidsetConfigurationType(String configurationType)setConfigurationType.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetFieldId(String fieldId)setFieldId.voidsetName(String name)setName.voidsetRequired(String required)setRequired.voidsetShow(String show)setShow.voidsetValue(String value)setValue.TextCustomFieldshow(String show)show.StringtoString()Converts the given object to string.TextCustomFieldvalue(String value)value.
-
-
-
Method Detail
-
configurationType
public TextCustomField configurationType(String configurationType)
configurationType.- Returns:
- TextCustomField
-
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)
setConfigurationType.
-
errorDetails
public TextCustomField errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- TextCustomField
-
getErrorDetails
public ErrorDetails getErrorDetails()
Array or errors..- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
fieldId
public TextCustomField fieldId(String fieldId)
fieldId.- Returns:
- TextCustomField
-
getFieldId
public String getFieldId()
An ID used to specify a custom field..- Returns:
- fieldId
-
setFieldId
public void setFieldId(String fieldId)
setFieldId.
-
name
public TextCustomField name(String name)
name.- Returns:
- TextCustomField
-
getName
public String getName()
The name of the custom field..- Returns:
- name
-
setName
public void setName(String name)
setName.
-
required
public TextCustomField required(String required)
required.- Returns:
- TextCustomField
-
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.
-
show
public TextCustomField show(String show)
show.- Returns:
- TextCustomField
-
getShow
public String getShow()
A boolean indicating if the value should be displayed..- Returns:
- show
-
setShow
public void setShow(String show)
setShow.
-
value
public TextCustomField value(String value)
value.- Returns:
- TextCustomField
-
getValue
public String getValue()
The value of the custom field..- Returns:
- value
-
setValue
public void setValue(String value)
setValue.
-
equals
public boolean equals(Object o)
Compares objects.
-
-