Package org.ametys.runtime.model
Interface Enumerator<T>
- Type Parameters:
T
- Type of the values
- All Known Implementing Classes:
AbstractTraversableSourceEnumerator
,AliasDerefEnumerator
,AnalysisEnumerator
,ArchiveFileEnumerator
,AvailableContentTypesEnumerator
,BlogSiteEnumerator
,CalendarContentTypesEnumerator
,CaptchaEnumerator
,CatalogEnumerator
,CertificationLabelsEnumerator
,CollectionEnumerator
,ContentTypeEnumerator
,ContentTypesForSearchEnumerator
,ContentViewEnumerator
,DefaultWorkflowStepEnumerator
,EligibleMetadataForLevelEnumerator
,EqTDComputationModeEnumerator
,ExtractionDefinitionFilesEnumerator
,ExtractionResultFilesEnumerator
,FOUserPreferencesEnumerator
,LanguageEnumerator
,MemoryCacheEnumerator
,MentionTypeEnumerator
,MergePolicy.MergePolicyEnumerator
,ModeEnumerator
,MonthEnumerator
,OrgProgramRestrictionEnumerator
,OrgUnitEnumerator
,OrgUnitUAICodeEnumerator
,ProjectLanguagesEnumerator
,ProjectPopulationEnumerator
,ReportExtensionEnumerator
,ReturnableEnumerator
,ScopeEnumerator
,ServiceXSLTEnumerator
,SiteColorsEnumerator
,SiteEnumerator
,SkinEnumerator
,SQLDatabaseTypeEnumerator
,StaticEnumerator
,StepHolderEnumerator
,SurveyEnumerator
,SynchronizeModeEnumerator
,UserPreferencesEnumerator
,WeekDaysEnumerator
,WeekStartEnumerator
,WorkflowEnumerator
,WorkflowStepsEnumerator
public interface Enumerator<T>
Enumerator for listing values.
Such values usually depends on environment (directory listing, DB table, ...).
-
Method Summary
Modifier and TypeMethodDescriptionGet the configuration of this enumeratorRetrieves a single label from a value.Provides the enumerated values with their optional label.
-
Method Details
-
getEntry
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
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 whenEnumerator
will be removed
-
getConfiguration
Get the configuration of this enumerator- Returns:
- the configuration
-