Package org.ametys.plugins.forms.enumerators

Interface LazyEnumerator<T>

Type Parameters:

T - Type of the values

All Known Subinterfaces:

ChoiceSourceType

All Known Implementing Classes:

AbstractSourceType, ManualSourceType, ManualWithCostsSourceType, ManualWithEmailSourceType, TableRefSourceType, UsersSourceType

public interface LazyEnumerator<T>

Enumerator for listing values with lazy loading.

Such values usually depends on environment (directory listing, DB table, ...).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	LANG_PARAMETER_KEY	The lang parameter key for search
static final String	PATTERN_PARAMETER_KEY	The pattern parameter key for search
static final String	SORT_PARAMETER_KEY	The sort parameter key for search

Method Summary

Modifier and Type	Method	Description
I18nizableText	getEntry(T value, Map<String,Object> contextParams)	Retrieves a single label from a value.
Map<T,I18nizableText>	getTypedEntries(Map<String,Object> contextParams)	Provides the enumerated values with their optional label.
Map<T,I18nizableText>	searchEntries(Map<String,Object> contextParams, int limit, Object paginationData)	Provides the enumerated values with their optional label.

Field Details

PATTERN_PARAMETER_KEY

static final String PATTERN_PARAMETER_KEY

The pattern parameter key for search

See Also:

• Constant Field Values

SORT_PARAMETER_KEY

static final String SORT_PARAMETER_KEY

The sort parameter key for search

See Also:

• Constant Field Values

LANG_PARAMETER_KEY

static final String LANG_PARAMETER_KEY

The lang parameter key for search

See Also:

• Constant Field Values

Method Details

getEntry

I18nizableText getEntry(T value,
 Map<String,Object> contextParams)
                 throws Exception

Retrieves a single label from a value.

Parameters:

value - the value.

contextParams - the search contextual parameters

Returns:

the label or null if not found.

Throws:

Exception - if an error occurs.

getTypedEntries

Map<T,I18nizableText> getTypedEntries(Map<String,Object> contextParams)
                               throws Exception

Provides the enumerated values with their optional label.

Parameters:

contextParams - the search contextual parameters

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs.

searchEntries

Map<T,I18nizableText> searchEntries(Map<String,Object> contextParams,
 int limit,
 Object paginationData)
                             throws Exception

Provides the enumerated values with their optional label.

Parameters:

contextParams - the search contextual parameters

limit - the limit of entries

paginationData - the data to process pagination

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs.