eu.ehri.project.models.events

Interface SystemEvent

All Superinterfaces:

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

All Known Implementing Classes:

SystemEvent.Impl

public interface SystemEvent
extends Accessible

Frame class representing an event that happened in the graph.

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
Actioner	getActioner() Fetch the actioner who triggered this event.
Entity	getEventScope() Fetch the "scope" of this event, or the context in which a given creation/modification/deletion event is happening.
EventTypes	getEventType() Fetch the event type of this event.
Accessible	getFirstSubject() Fetch the first subject of this event.
String	getLogMessage() Fetch the log message associated with this event.
SystemEvent	getPriorEvent() Fetch the event chronologically prior to this one.
Iterable<Version>	getPriorVersions() If new versions have been created, fetch the prior versions of the subjects that were affected by this event.
Iterable<Accessible>	getSubjects() Fetch the subject items to whom this event pertains.
String	getTimestamp() Fetch the time stamp of this event.
void	setEventScope(Entity frame) Set the scope of this event.
int	subjectCount()

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

subjectCount

int subjectCount()

getTimestamp

String getTimestamp()

Fetch the time stamp of this event.

Returns:

a UTF timestamp string

getEventType

EventTypes getEventType()

Fetch the event type of this event.

Returns:

an EventTypes value

getLogMessage

String getLogMessage()

Fetch the log message associated with this event.

Returns:

A string

getActioner

Actioner getActioner()

Fetch the actioner who triggered this event.

Returns:

A user profile instance

getSubjects

Iterable<Accessible> getSubjects()

Fetch the subject items to whom this event pertains.

Returns:

an iterable of frame items

getPriorVersions

Iterable<Version> getPriorVersions()

If new versions have been created, fetch the prior versions of the subjects that were affected by this event.

Returns:

an iterable of version nodes

getFirstSubject

Accessible getFirstSubject()

Fetch the first subject of this event. This is a shortcut method to avoid having to fetch many items.

Returns:

an item frame

getPriorEvent

SystemEvent getPriorEvent()

Fetch the event chronologically prior to this one.

Returns:

an event item

getEventScope

Entity getEventScope()

Fetch the "scope" of this event, or the context in which a given creation/modification/deletion event is happening.

Returns:

the event scope

setEventScope

void setEventScope(Entity frame)

Set the scope of this event.

Parameters:

frame - a scope item