Package de.espirit.firstspirit.access.store.contentstore

Interface DatasetProvider

All Known Subinterfaces:
Content2, TableTemplate
public interface DatasetProvider
Interface for elements providing current and historic access to Datasets.
Since:
4.2.440

  • Method Summary

    Modifier and Type
    Method
    Description
    @NotNull Dataset
    createDataset()
    Creates a new entity with the entity type of this dataset provider and returns a new dataset for this entity.
    @NotNull Dataset
    getDataset(@NotNull Entity entity)
    Get a dataset for the given entity.
    @Nullable Dataset
    getDataset(@NotNull Entity entity, @NotNull Revision revision)
    Get a dataset for the given entity in a defined revision.
    @NotNull EntityType
    getEntityType()
    Get the entity type supported by this dataset provider.
    @NotNull Schema
    getSchema()
    Get the schema the provider refers to.

  • Method Details

    • getDataset

      @NotNull @NotNull Dataset getDataset(@NotNull @NotNull Entity entity)
      Get a dataset for the given entity.
      Parameters:
      entity - The entity to get as Dataset.
      Returns:
      A dataset on the given entity.
      Since:
      4.2.440

    • createDataset

      @NotNull @NotNull Dataset createDataset()
      Creates a new entity with the entity type of this dataset provider and returns a new dataset for this entity.
      Returns:
      a dataset on a new entity
      Since:
      5.2.2000, 5.2.1909

    • getDataset

      @Nullable @Nullable Dataset getDataset(@NotNull @NotNull Entity entity, @NotNull @NotNull Revision revision)
      Get a dataset for the given entity in a defined revision.
      Parameters:
      entity - The entity to get as Dataset.
      revision - The revision to get the Dataset in.
      Returns:
      The dataset, if available in the requested revision, else null.
      Since:
      4.2.440

    • getEntityType

      @NotNull @NotNull EntityType getEntityType() throws de.espirit.firstspirit.access.database.EntityTypeNotFoundException
      Get the entity type supported by this dataset provider.
      Returns:
      the belonging EntityType or throws EntityTypeNotFoundException
      Throws:
      de.espirit.firstspirit.access.database.EntityTypeNotFoundException - when a referenced entity type (database table) does not exist.
      Since:
      4.2.440

    • getSchema

      @NotNull @NotNull Schema getSchema()
      Get the schema the provider refers to.
      Returns:
      The schema.
      Since:
      4.2.440