Package de.espirit.firstspirit.access.store.pagestore

Interface LanguageDataProvider

All Superinterfaces:
Comparable<StoreElement>, DataProvider, HistoryProvider, IDProvider, StoreElement, Workflowable
public interface LanguageDataProvider extends DataProvider
Provides language- and (release) revision-dependent access to a store element's form data.

This interface is used by elements that participate in language dependent release revisions: depending on the requested Language, the underlying data may differ.

For elements originating from the current store (i.e. not a release context), the returned data is language-independent and therefore equivalent to calling the corresponding methods on DataProvider (e.g. DataProvider.getFormData()).

Implementations may return different data snapshots per language. Callers should not assume that instances returned for different languages are identical or share state.

Since:
5.2.260301

  • Method Details

    • getFormData

      @NotNull @NotNull FormData getFormData(@NotNull @NotNull Language language)
      Returns a FormData instance for the given Language.

      For partial language dependent releases, the returned form data may vary by language. To ensure you get the correct data, only the form fields for the specific language and the language-independent form fields should be fetched.

      If the element is accessed from the current store (no release context), the returned form data is language-independent and equivalent to DataProvider.getFormData().

      Parameters:
      language - the requested language, must not be null
      Returns:
      the form data container for the requested language
      Since:
      5.2.260301