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, AIEmbeddingModelEnumerator, AIImageModelEnumerator, AIProviderEnumerator, AITextModelEnumerator, AliasDerefEnumerator, AnalysisEnumerator, ArchiveFileEnumerator, AvailableContentTypesEnumerator, ByEducationalPathAttributesEnumerator, ByEducationalPathAttributesEnumerator, CalendarContentTypesEnumerator, CaptchaEnumerator, CatalogEnumerator, CertificationLabelsEnumerator, CollectionEnumerator, ContentEnumerator, ContentQueryEnumerator, ContentTypeEnumerator, ContentTypesForSearchEnumerator, DefaultWorkflowStepEnumerator, DisplayCodeProviderEnumerator, EligibleMetadataForLevelEnumerator, EqTDComputationModeEnumerator, ExtractionDefinitionFilesEnumerator, ExtractionResultFilesEnumerator, FOUserPreferencesEnumerator, GDPRComponentEnumerator, LanguageEnumerator, MemoryCacheEnumerator, MentionTypeEnumerator, MergePolicy.MergePolicyEnumerator, ModeEnumerator, MonthEnumerator, NbSessionsEnumerator, OrgProgramRestrictionEnumerator, ParentProgramsEnumerator, 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, WorkspacesModuleEnumerator, YearsEnumerator
public interface Enumerator<T>
Enumerator for listing values.

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

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

    • getEntry

      default I18nizableText getEntry(T value, Map<String,Object> contextualParameters) throws Exception
      Retrieves a single label from a value.
      Parameters:
      value - the value.
      contextualParameters - Contextual parameters that may change enumeration. See enumerator implementation to see available parameters.
      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.

    • getEntries

      default Map<T,I18nizableText> getEntries(Map<String,Object> contextualParameters) throws Exception
      Provides the enumerated values with their optional label.
      Parameters:
      contextualParameters - Contextual parameters that may change enumeration. See enumerator implementation to see available parameters.
      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