Package de.espirit.firstspirit.agency

Interface LanguageAgent

public interface LanguageAgent
Definition for an agent offering information about project persistency languages. These are the languages defined within a project to be used by editors creating content. This agent is focused on a specific project.

Examples:
SpecialistsBroker.requireSpecialist(LanguageAgent.TYPE).getLanguages()
SpecialistsBroker.requireSpecialist(LanguageAgent.TYPE).getMasterLanguage()

Since:
4.2.405

  • Field Details

  • Method Details

    • getMasterLanguage

      Language getMasterLanguage()
      Provides the persistency language used as master.
      Returns:
      The master language.
      Since:
      4.2.405

    • getMetaLanguage

      @NotNull @NotNull Language getMetaLanguage()
      Provide the language being used for meta data representation.
      Returns:
      The meta data language.
      Since:
      5.1.28

    • getFallbackLanguage

      Language getFallbackLanguage()
      Provide the language being used to define fallback values in form defaults.
      Returns:
      The fallback language
      Since:
      5.2.24
      See Also:

    • getLanguages

      List<Language> getLanguages()
      Provide access to available persistency languages.
      Returns:
      An (unmodifiable) list of languages.
      Since:
      4.2.405

    • getVisibleLanguages

      List<Language> getVisibleLanguages()
      Provides access to languages defined to be visible for the current user.
      Returns:
      An (unmodifiable) list of languages.
      Since:
      5.0.601, 5.1.4

    • getEditorialLanguages

      List<Language> getEditorialLanguages()
      Provides access to the languages marked as editorial languages, i.e, those languages used to edit the element's display names.
      Returns:
      An (unmodifiable) list of languages.
      Since:
      5.1.8

    • getProjectLanguages

      Map<String,Language> getProjectLanguages(boolean includeFallback)
      Provide access to available persistency languages, mapping abbreviations to the respective language definition.
      Parameters:
      includeFallback - If true, the Fallback-Language is included in the resulting map.
      Returns:
      An (unmodifiable) map, where each value is a language and the key is the respective abbreviation.
      Since:
      4.2.405