uk.ac.ed.epcc.webapp.forms.inputs

Interface ListInput<V,T>

Type Parameters:

V - type of value object

T - type of Item object

All Superinterfaces:

Input<V>, ItemInput<V,T>, SuggestedItemInput<V,T>

All Known Subinterfaces:

OptionalListInput<V,T>, PreSelectInput<V,T>

All Known Implementing Classes:

BasicTypeInput, CalendarFieldInput, CalendarMonthInput, ClassificationFactory.ClassificationCodeListInput, ClassInput, CodeListInput, ConstructedObjectInput, DataObjectFactory.AbstractDataObjectInput, DataObjectFactory.DataObjectInput, DataObjectFactory.SortingDataObjectInput, EnumInput, EnumIntegerInput, IntegerRangeInput, IntegerSetInput, ListInputWrapper, NullListInput, OnOffInput, OptionalFieldInput, OptionalIndexInput, OptionalListInputWrapper, RadioButtonInput, RepositoryFieldInput, RepositoryForeignKeyInput, RepositoryIndexInput, SetInput, StringListInput, TableInput, TypeProducerInput

public interface ListInput<V,T>
extends SuggestedItemInput<V,T>

Input that selects values from a List. For consistency the parse method should parse tag values. That is tags are String representations of the Input values. Each possible choice has 4 representations

• The Value corresponding to the value stored in the Input
• The Item is the target object e.g. the DataObject being selected. We sometimes need to call methods on these. For a simple list the Value and Item may be the same.
• The tag which is a simple string used to identify the selection this can be used internally e.g. for HTML forms.
• The text actually presented to the user.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getTagByItem(T item) get an identifying tag string from the domain object
java.lang.String	getTagByValue(V value) get the tag string from the actual value of the input
java.lang.String	getText(T item) get the user presented text from the domain object may return null if not selected
boolean	isValid(T item) Test if an object of the Item type is one of the possible items.

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.inputs.SuggestedItemInput

getCount, getItems

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.inputs.ItemInput

getItem, getItembyValue, setItem

Methods inherited from interface uk.ac.ed.epcc.webapp.forms.inputs.Input

accept, addValidator, convert, getKey, getPrettyString, getString, getValue, isEmpty, removeValidator, setKey, setValue, validate

Method Detail

getTagByItem

java.lang.String getTagByItem(T item)

get an identifying tag string from the domain object

Parameters:

item -

Returns:

String tag

isValid

boolean isValid(T item)

Test if an object of the Item type is one of the possible items.

Parameters:

item -

Returns:

boolean

getTagByValue

java.lang.String getTagByValue(V value)

get the tag string from the actual value of the input

Parameters:

value -

Returns:

String tag

getText

java.lang.String getText(T item)

get the user presented text from the domain object may return null if not selected

Parameters:

item -

Returns:

String user text