Package com.docusign.esign.model
Class ListItem
- java.lang.Object
-
- com.docusign.esign.model.ListItem
-
public class ListItem extends Object
One of the selectable items in the `listItems` property of a [`list`](/docs/esign-rest-api/reference/envelopes/enveloperecipienttabs/create/) tab..
-
-
Constructor Summary
Constructors Constructor Description ListItem()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description booleanequals(Object o)Compares objects.StringgetSelected()When set to **true**, indicates that this item is the default selection shown to a signer.PropertyMetadatagetSelectedMetadata()Metadata that indicates whether the `selected` property is editable..StringgetText()Specifies the text that is shown in the dropdown list.PropertyMetadatagetTextMetadata().StringgetValue()Specifies the value that is used when the list item is selected..PropertyMetadatagetValueMetadata()Metadata that indicates whether the `value` property is editable..inthashCode()Returns the HashCode.ListItemselected(String selected)selected.ListItemselectedMetadata(PropertyMetadata selectedMetadata)selectedMetadata.voidsetSelected(String selected)setSelected.voidsetSelectedMetadata(PropertyMetadata selectedMetadata)setSelectedMetadata.voidsetText(String text)setText.voidsetTextMetadata(PropertyMetadata textMetadata)setTextMetadata.voidsetValue(String value)setValue.voidsetValueMetadata(PropertyMetadata valueMetadata)setValueMetadata.ListItemtext(String text)text.ListItemtextMetadata(PropertyMetadata textMetadata)textMetadata.StringtoString()Converts the given object to string.ListItemvalue(String value)value.ListItemvalueMetadata(PropertyMetadata valueMetadata)valueMetadata.
-
-
-
Method Detail
-
getSelected
public String getSelected()
When set to **true**, indicates that this item is the default selection shown to a signer. Only one selection can be set as the default..- Returns:
- selected
-
setSelected
public void setSelected(String selected)
setSelected.
-
selectedMetadata
public ListItem selectedMetadata(PropertyMetadata selectedMetadata)
selectedMetadata.- Returns:
- ListItem
-
getSelectedMetadata
public PropertyMetadata getSelectedMetadata()
Metadata that indicates whether the `selected` property is editable..- Returns:
- selectedMetadata
-
setSelectedMetadata
public void setSelectedMetadata(PropertyMetadata selectedMetadata)
setSelectedMetadata.
-
getText
public String getText()
Specifies the text that is shown in the dropdown list. .- Returns:
- text
-
setText
public void setText(String text)
setText.
-
textMetadata
public ListItem textMetadata(PropertyMetadata textMetadata)
textMetadata.- Returns:
- ListItem
-
getTextMetadata
public PropertyMetadata getTextMetadata()
.- Returns:
- textMetadata
-
setTextMetadata
public void setTextMetadata(PropertyMetadata textMetadata)
setTextMetadata.
-
getValue
public String getValue()
Specifies the value that is used when the list item is selected..- Returns:
- value
-
setValue
public void setValue(String value)
setValue.
-
valueMetadata
public ListItem valueMetadata(PropertyMetadata valueMetadata)
valueMetadata.- Returns:
- ListItem
-
getValueMetadata
public PropertyMetadata getValueMetadata()
Metadata that indicates whether the `value` property is editable..- Returns:
- valueMetadata
-
setValueMetadata
public void setValueMetadata(PropertyMetadata valueMetadata)
setValueMetadata.
-
equals
public boolean equals(Object o)
Compares objects.
-
-