Package org.ametys.runtime.model

Interface Enumerator<T>

Type Parameters:

T - Type of the values

All Known Subinterfaces:

RestrictedEnumerator<T>

All Known Implementing Classes:

AbstractTraversableSourceEnumerator, AliasDerefEnumerator, AnalysisEnumerator, ArchiveFileEnumerator, AvailableContentTypesEnumerator, ByEducationalPathAttributesEnumerator, ByEducationalPathAttributesEnumerator, CalendarContentTypesEnumerator, CaptchaEnumerator, CatalogEnumerator, CertificationLabelsEnumerator, CollectionEnumerator, ContentQueryEnumerator, ContentTypeEnumerator, ContentTypesForSearchEnumerator, DefaultWorkflowStepEnumerator, DisplayCodeProviderEnumerator, EligibleMetadataForLevelEnumerator, EqTDComputationModeEnumerator, ExtractionDefinitionFilesEnumerator, ExtractionResultFilesEnumerator, FOUserPreferencesEnumerator, GDPRComponentEnumerator, LanguageEnumerator, MemoryCacheEnumerator, MentionTypeEnumerator, MergePolicy.MergePolicyEnumerator, ModeEnumerator, MonthEnumerator, NbSessionsEnumerator, OrgProgramRestrictionEnumerator, PopulationEnumerator, ProfilesEnumerator, ProjectLanguagesEnumerator, ProjectPopulationEnumerator, ReportExtensionEnumerator, RestrictedWrappedEnumerator, ReturnableEnumerator, SchedulerWeekdayOfMonthEnumerator, ScopeEnumerator, ServiceXSLTEnumerator, SiteColorsEnumerator, SiteEnumerator, SiteGDPRComponentEnumerator, SiteWebAnalyticsProviderEnumerator, SkinEnumerator, SQLDatabaseTypeEnumerator, StaticEnumerator, StepHolderEnumerator, SurveyEnumerator, SynchronizeModeEnumerator, TimeZoneEnumerator, TrashElementTypeEnumerator, UniqueCodeGeneratorEnumerator, UserLanguageEnumerator, UserPreferencesEnumerator, WebAnalyticsProviderEnumerator, WeekDaysEnumerator, WeekStartEnumerator, WorkflowEnumerator, WorkflowNameEnumerator

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
Map<T,I18nizableText>	getEntries()	Provides the enumerated values with their optional label.
default I18nizableText	getEntry(T value)	Retrieves a single label from a value.

Method Details

getEntry

default 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.

getEntries

Map<T,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 of this enumerator

Returns:

the configuration