eu.ehri.project.models.events

Interface Version

All Superinterfaces:

Accessible, Entity, PermissionGrantTarget, com.tinkerpop.frames.VertexFrame

All Known Implementing Classes:

Version.Impl

public interface Version
extends Accessible

Frame class representing a serialized version of some other node.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Version.Impl Implementation of complex methods.

Method Summary

Modifier and Type	Method and Description
Accessible	getEntity() Loops up through the chain of versions until the latest and fetches the item to which the events refer.
String	getEntityData() Fetch a serialized snapshot of the item's data in JSON format.
String	getEntityId() Fetch the ID of the entity that this version pertains to.
String	getEntityType() Fetch the class of the entity that this version pertains to.
SystemEvent	getTriggeringEvent() Fetch the event that triggered this version.

Methods inherited from interface eu.ehri.project.models.base.Accessible

addAccessor, getAccessors, getHistory, getLatestEvent, getPermissionScope, getPermissionScopes, hasAccessRestriction, removeAccessor, setPermissionScope

Methods inherited from interface eu.ehri.project.models.base.PermissionGrantTarget

getPermissionGrants

Methods inherited from interface eu.ehri.project.models.base.Entity

as, getId, getProperty, getProperty, getPropertyKeys, getType

Methods inherited from interface com.tinkerpop.frames.VertexFrame

asVertex

Method Detail

getEntityType

String getEntityType()

Fetch the class of the entity that this version pertains to.

Returns:

an entity class enum value

getEntityId

String getEntityId()

Fetch the ID of the entity that this version pertains to.

Returns:

an ID string

getEntityData

String getEntityData()

Fetch a serialized snapshot of the item's data in JSON format.

Returns:

JSON data representing a sub-graph

getTriggeringEvent

SystemEvent getTriggeringEvent()

Fetch the event that triggered this version.

Returns:

a system event instance

getEntity

Accessible getEntity()

Loops up through the chain of versions until the latest and fetches the item to which the events refer. If it has been

Returns:

the entity to which this version refers.