Package de.espirit.firstspirit.event

Interface EntityInfo

All Superinterfaces:
Serializable
public interface EntityInfo extends Serializable
Container definition for lightweight information on an entity.
Since:
5.2.210505

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getEntityTypeName()
    Provides the name of the entity type the entity is based on.
    Optional<UUID>
    getGid()
    Returns an optional entity gid.
    An entity gid is supported by temporal sessions and entities.
    Optional<Long>
    getId()
    Provides an optional entity native id.
    This value is supported by temporal sessions and entities only.
    Object
    getIdentifierValue(String key)
    Provides the value stored at the given key from the entity's identifier.
    Optional<Long>
    getValidFrom()
    Provides an optional timestamp of since when the entity is valid.
    This value is supported by temporal sessions and entities only.
    Optional<Long>
    getValidTo()
    Provides an optional timestamp of up to when the entity is valid.
    This value is supported by temporal sessions and entities only.
    boolean
    isTemporal()
    Identifies the entity to be temporal, implying to provide some optional values like, e.g., a GID.

  • Method Details

    • getEntityTypeName

      String getEntityTypeName()
      Provides the name of the entity type the entity is based on.
      Returns:
      The name of the entity type.
      Since:
      5.2.210505

    • isTemporal

      boolean isTemporal()
      Identifies the entity to be temporal, implying to provide some optional values like, e.g., a GID.
      Returns:
      true if the dataset is temporal.
      Since:
      5.2.210505

    • getIdentifierValue

      Object getIdentifierValue(String key) throws IllegalArgumentException
      Provides the value stored at the given key from the entity's identifier. For example, to access the definition values of a custom primary key.
      Parameters:
      key - The key to look up.
      Returns:
      The value stored at the given key.
      Throws:
      IllegalArgumentException - If the identifier has no such key.
      Since:
      5.2.210505

    • getGid

      Optional<UUID> getGid()
      Returns an optional entity gid.
      An entity gid is supported by temporal sessions and entities.
      Returns:
      An optional entity gid.
      Since:
      5.2.210505

    • getId

      Optional<Long> getId()
      Provides an optional entity native id.
      This value is supported by temporal sessions and entities only.
      Returns:
      An optional entity id.
      Since:
      5.2.210505

    • getValidFrom

      Optional<Long> getValidFrom()
      Provides an optional timestamp of since when the entity is valid.
      This value is supported by temporal sessions and entities only.
      Returns:
      An optional valid from time.
      Since:
      5.2.210505

    • getValidTo

      Optional<Long> getValidTo()
      Provides an optional timestamp of up to when the entity is valid.
      This value is supported by temporal sessions and entities only.
      Returns:
      An optional valid to time.
      Since:
      5.2.210505