Package org.ametys.web.frontoffice.search.metamodel

Interface EnumeratedValues

public interface EnumeratedValues

Represents some enumerated values returned by SearchCriterionDefinition.getEnumeratedValues(java.util.Map<java.lang.String, java.lang.Object>)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EnumeratedValues.RestrictedValues	Represents a subset of values (some 'restricted' values) of a given EnumeratedValues.

Method Summary

Modifier and Type	Method	Description
Map<Object,I18nizableText>	getAllValues()	Gets all the values (with their label)
EnumeratedValues.RestrictedValues	getRestrictedValuesFor(List<Object> objs)	Gets the EnumeratedValues.RestrictedValues object The implementation must decide whether or not the given objs must be validated among all values, if they must be converted, etc.
default Optional<Map.Entry<Object,I18nizableText>>	getValue(Object value)	Gets the enumerated value (with its label) from the given value

Method Details

getAllValues

Map<Object,I18nizableText> getAllValues()

Gets all the values (with their label)

Returns:

all the values (with their label)

getValue

default Optional<Map.Entry<Object,I18nizableText>> getValue(Object value)

Gets the enumerated value (with its label) from the given value

Parameters:

value - the value

Returns:

the enumerated value (with its label)

getRestrictedValuesFor

EnumeratedValues.RestrictedValues getRestrictedValuesFor(List<Object> objs)

Gets the EnumeratedValues.RestrictedValues object
The implementation must decide whether or not the given objs must be validated among all values, if they must be converted, etc.

Parameters:

objs - The desired objects

Returns:

the EnumeratedValues.RestrictedValues