Package de.espirit.firstspirit.event

Interface EventInfo

All Superinterfaces:
BasicElementInfo, BasicInfo, Serializable
@NonExtendable public interface EventInfo extends BasicElementInfo
Lightweight project and revision based event metadata.
Since:
5.2.210505

  • Method Details

    • isRelease

      boolean isRelease()
      Indicates whether the event originated from the release state.
      Returns:
      true, if originating from release.
      Since:
      5.2.210505

    • getEventType

      @NotNull @NotNull EventInfo.EventType getEventType()
      The change type which caused this event.
      Returns:
      The change type.
      Since:
      5.2.210505

    • getParentId

      long getParentId()
      Depending on the operation, provides the id of the parent element. If unsupported, will return -1.
      Returns:
      Parent element id, if supported, -1 else.
      Since:
      5.2.210505

    • getOldParentId

      long getOldParentId()
      Provides the old parent id, if this is a EventInfo.EventType.ELEMENT_MOVED operation. Otherwise will return -1.
      Returns:
      The old parent id, if supported, -1 else.
      Since:
      5.2.210505

    • getSchemaId

      long getSchemaId()
      Provides the id of the schema causing this event, if it entity related. Will return -1 otherwise.
      Returns:
      The schema's id or -1, if this is not an entity related event.
      Since:
      5.2.210505

    • getGid

      @NotNull @NotNull UUID getGid()
      Provides the element's gid. If the event is entity related, the gid will target the Schema. If a gid does not yet exist, a new one will be created.
      Returns:
      The element's/entity's gid.
      Since:
      5.2.210505

    • getEntities

      @NotNull @NotNull Collection<EntityInfo> getEntities()
      If this event is entity related, information on the entities in question will be provided as a list of lightweight info objects. Otherwise, the list will be empty.
      Returns:
      Information of changed entities. Will be empty, if the event is not entity related.
      Since:
      5.2.210505

    • getRevision

      @Deprecated(forRemoval=true) @NotNull de.espirit.storage.Revision getRevision()
      Deprecated, for removal: This API element is subject to removal in a future version.
      since 5.2.240501 - use getEventRevision() instead
      Get the Revision of this event. If only the revision id is of interest, consider using the faster BasicElementInfo.getRevisionId() method. Loading the revision metadata and creating the revision object has a small overhead.
      Returns:
      The revision.
      Since:
      5.2.210902
      See Also:

    • getEventRevision

      @NotNull @NotNull Revision getEventRevision()
      Get the Revision of this event. If only the revision id is of interest, consider using the faster BasicElementInfo.getRevisionId() method. Loading the revision metadata and creating the revision object has a small overhead.
      Returns:
      The revision.
      Throws:
      UncheckedIOException - if it was not possible to open the repository.
      Since:
      5.2.240501
      See Also: