Package com.docusign.esign.model
Class ListCustomField
- java.lang.Object
-
- com.docusign.esign.model.ListCustomField
-
- All Implemented Interfaces:
Serializable
public class ListCustomField extends Object implements Serializable
This object represents a list custom field from which envelope creators and senders can select custom data..- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description ListCustomField()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ListCustomFieldaddListItemsItem(String listItemsItem)addListItemsItem.ListCustomFieldconfigurationType(String configurationType)configurationType.booleanequals(Object o)Compares objects.ListCustomFielderrorDetails(ErrorDetails errorDetails)errorDetails.ListCustomFieldfieldId(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..List<String>getListItems().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.ListCustomFieldlistItems(List<String> listItems)listItems.ListCustomFieldname(String name)name.ListCustomFieldrequired(String required)required.voidsetConfigurationType(String configurationType)setConfigurationType.voidsetErrorDetails(ErrorDetails errorDetails)setErrorDetails.voidsetFieldId(String fieldId)setFieldId.voidsetListItems(List<String> listItems)setListItems.voidsetName(String name)setName.voidsetRequired(String required)setRequired.voidsetShow(String show)setShow.voidsetValue(String value)setValue.ListCustomFieldshow(String show)show.StringtoString()Converts the given object to string.ListCustomFieldvalue(String value)value.
-
-
-
Method Detail
-
configurationType
public ListCustomField configurationType(String configurationType)
configurationType.- Returns:
- ListCustomField
-
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 ListCustomField errorDetails(ErrorDetails errorDetails)
errorDetails.- Returns:
- ListCustomField
-
getErrorDetails
public ErrorDetails getErrorDetails()
Array or errors..- Returns:
- errorDetails
-
setErrorDetails
public void setErrorDetails(ErrorDetails errorDetails)
setErrorDetails.
-
fieldId
public ListCustomField fieldId(String fieldId)
fieldId.- Returns:
- ListCustomField
-
getFieldId
public String getFieldId()
An ID used to specify a custom field..- Returns:
- fieldId
-
setFieldId
public void setFieldId(String fieldId)
setFieldId.
-
listItems
public ListCustomField listItems(List<String> listItems)
listItems.- Returns:
- ListCustomField
-
addListItemsItem
public ListCustomField addListItemsItem(String listItemsItem)
addListItemsItem.- Returns:
- ListCustomField
-
name
public ListCustomField name(String name)
name.- Returns:
- ListCustomField
-
getName
public String getName()
The name of the custom field..- Returns:
- name
-
setName
public void setName(String name)
setName.
-
required
public ListCustomField required(String required)
required.- Returns:
- ListCustomField
-
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 ListCustomField show(String show)
show.- Returns:
- ListCustomField
-
getShow
public String getShow()
A boolean indicating if the value should be displayed..- Returns:
- show
-
setShow
public void setShow(String show)
setShow.
-
value
public ListCustomField value(String value)
value.- Returns:
- ListCustomField
-
getValue
public String getValue()
The value of the custom field. Maximum Length: 100 characters..- Returns:
- value
-
setValue
public void setValue(String value)
setValue.
-
equals
public boolean equals(Object o)
Compares objects.
-
-