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

Class RestrictedWrappedEnumerator<T>

java.lang.Object

org.ametys.web.frontoffice.search.metamodel.impl.RestrictedWrappedEnumerator<T>

Type Parameters:

T - Type of the values

All Implemented Interfaces:

Enumerator<T>, RestrictedEnumerator<T>

public class RestrictedWrappedEnumerator<T>
extends Object
implements RestrictedEnumerator<T>

Represents a RestrictedEnumerator wrapping a classic Enumerator

Nested Class Summary

Nested classes/interfaces inherited from interface org.ametys.web.frontoffice.search.metamodel.RestrictedEnumerator

RestrictedEnumerator.RestrictedValues<T>

Constructor Summary

Constructors

Constructor	Description
RestrictedWrappedEnumerator(Enumerator<T> enumerator, String criterionDefinitionName)	Constructor used to create RestrictedEnumerator wrapping a classic Enumerator

Method Summary

Modifier and Type	Method	Description
Map<T,I18nizableText>	getEntries()	Provides the enumerated values with their optional label.
RestrictedEnumerator.RestrictedValues<T>	getRestrictedEntriesFor(List<T> objs)	Gets the RestrictedEnumerator.RestrictedValues object The implementation must decide whether or not the given objects must be validated among all values, if they must be converted, etc.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.ametys.runtime.model.Enumerator

getConfiguration, getEntry

Constructor Details

RestrictedWrappedEnumerator

public RestrictedWrappedEnumerator(Enumerator<T> enumerator,
 String criterionDefinitionName)

Constructor used to create RestrictedEnumerator wrapping a classic Enumerator

Parameters:

enumerator - the wrapped classic Enumerator

criterionDefinitionName - the name of the criterion definition

Method Details

getEntries

public Map<T,I18nizableText> getEntries()
                                 throws Exception

Description copied from interface: Enumerator

Provides the enumerated values with their optional label.

Specified by:

getEntries in interface Enumerator<T>

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs.

getRestrictedEntriesFor

public RestrictedEnumerator.RestrictedValues<T> getRestrictedEntriesFor(List<T> objs)

Description copied from interface: RestrictedEnumerator

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

Specified by:

getRestrictedEntriesFor in interface RestrictedEnumerator<T>

Parameters:

objs - The desired objects

Returns:

the RestrictedEnumerator.RestrictedValues