org.ametys.runtime.parameter

Interface Enumerator

All Known Implementing Classes:

AliasDerefEnumerator, AvailableContentTypesEnumerator, BlogSiteEnumerator, CalendarContentTypesEnumerator, CatalogEnumerator, CollectionEnumerator, ContentTypeEnumerator, ContentTypesForSearchEnumerator, DefaultWorkflowStepEnumerator, EligibleMetadataForLevelEnumerator, ExtractionDefinitionFilesEnumerator, ExtractionXSLTFilesEnumerator, FOUserPreferencesEnumerator, LanguageEnumerator, MetadataSetEnumerator, ModeEnumerator, MonthEnumerator, OrgProgramRestrictionEnumerator, OrgUnitEnumerator, OrgUnitUAICodeEnumerator, ProjectLanguagesEnumerator, ScopeEnumerator, ServerDirectoryEnumerator, ServiceXSLTEnumerator, SiteColorsEnumerator, SiteEnumerator, SkinEnumerator, SQLDatabaseTypeEnumerator, StaticEnumerator, SubscribersListEnumerator, SurveyEnumerator, UserPreferencesEnumerator, WeekStartEnumerator, WorkflowStepsEnumerator

public interface Enumerator

Enumerator for listing values.

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

Method Summary

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

Method Detail

getEntry

I18nizableText getEntry(String 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.

getEntries

Map<Object,I18nizableText> getEntries()
                               throws Exception

Provides the enumerated values with their optional label.

Returns:

the enumerated values and their label.

Throws:

Exception - if an error occurs.

getConfiguration

default Map<String,Object> getConfiguration()

Get the configuration this enumerator

Returns:

the configuration