ChoiceListInterface

ChoiceListInterface

interface ChoiceListInterface

A list of choices that can be selected in a choice field.

A choice list assigns unique string values to each of a list of choices. These string values are displayed in the "value" attributes in HTML and submitted back to the server.

The acceptable data types for the choices depend on the implementation. Values must always be strings and (within the list) free of duplicates.

Methods

array getChoices()

Returns all selectable choices.

string[] getValues()

Returns the values for the choices.

string[] getStructuredValues()

Returns the values in the structure originally passed to the list.