Package org.ametys.runtime.model

Interface Enumerator<T>

Type Parameters:

T - Type of the values

All Known Implementing Classes:

AbstractTraversableSourceEnumerator, AliasDerefEnumerator, AnalysisEnumerator, ArchiveFileEnumerator, AvailableContentTypesEnumerator, CalendarContentTypesEnumerator, CatalogEnumerator, CertificationLabelsEnumerator, CollectionEnumerator, ContentTypeEnumerator, ContentTypesForSearchEnumerator, EligibleMetadataForLevelEnumerator, EqTDComputationModeEnumerator, ExtractionDefinitionFilesEnumerator, ExtractionResultFilesEnumerator, FOUserPreferencesEnumerator, LanguageEnumerator, MemoryCacheEnumerator, MentionTypeEnumerator, MergePolicy.MergePolicyEnumerator, ModeEnumerator, MonthEnumerator, OrgProgramRestrictionEnumerator, OrgUnitEnumerator, OrgUnitUAICodeEnumerator, ProjectLanguagesEnumerator, ReportExtensionEnumerator, ReturnableEnumerator, ScopeEnumerator, ServiceXSLTEnumerator, SiteColorsEnumerator, SkinEnumerator, SQLDatabaseTypeEnumerator, StaticEnumerator, StepHolderEnumerator, SurveyEnumerator, UserPreferencesEnumerator, WeekStartEnumerator, WorkflowEnumerator

public interface Enumerator<T>

Enumerator for listing values.

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

Method Summary

Modifier and Type	Method	Description
default Map<String,Object>	getConfiguration()	Get the configuration of this enumerator
I18nizableText	getEntry(T value)	Retrieves a single label from a value.
Map<T,I18nizableText>	getTypedEntries()	Provides the enumerated values with their optional label.

Method Details

getEntry

I18nizableText getEntry(T value)
                 throws Exception

Retrieves a single label from a value.

Parameters:

value - the value.

Returns:

the label or null if not found.

Throws:

Exception - if an error occurs.

getTypedEntries

Map<T,I18nizableText> getTypedEntries()
                               throws Exception

Provides the enumerated values with their optional label.

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs. TODO NEWATTRIBUTEAPI: rename this method when Enumerator will be removed

getConfiguration

default Map<String,Object> getConfiguration()

Get the configuration of this enumerator

Returns:

the configuration