eu.ehri.project.persistence

Class ActionManager.EventContext

java.lang.Object

eu.ehri.project.persistence.ActionManager.EventContext

Enclosing class:

ActionManager

public class ActionManager.EventContext
extends Object

EventContext is a handle to a particular action to which additional subjects can be added.

Method Summary

Modifier and Type	Method and Description
ActionManager.EventContext	addSubjects(Accessible... entities) Add subjects to an event.
SystemEvent	commit() Flush this event log to the graph.
ActionManager.EventContext	createVersion(Entity frame) Create a snapshot of the given node's data.
ActionManager.EventContext	createVersion(Entity frame, Bundle bundle) Create a snapshot of the given node using the provided data.
Actioner	getActioner() Get the event actioner.
EventTypes	getEventType() Get the type of this event context.
Optional<String>	getLogMessage() Get the event context log message.
Set<Accessible>	getSubjects() Return the subjects of this event.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getActioner

public Actioner getActioner()

Get the event actioner.

Returns:

The actioner

getLogMessage

public Optional<String> getLogMessage()

Get the event context log message.

Returns:

The optional log message

getSubjects

public Set<Accessible> getSubjects()

Return the subjects of this event.

Returns:

a set of subjects

createVersion

public ActionManager.EventContext createVersion(Entity frame)

Create a snapshot of the given node's data.

Parameters:

frame - The subject node

Returns:

This event context

createVersion

public ActionManager.EventContext createVersion(Entity frame,
                                                Bundle bundle)

Create a snapshot of the given node using the provided data. This is useful when the node has already been changed at this point the snapshot is taken.

Parameters:

frame - The subject node

bundle - A bundle of the node's data

Returns:

This event context

addSubjects

public ActionManager.EventContext addSubjects(Accessible... entities)

Add subjects to an event.

Parameters:

entities - A set of event subjects

Returns:

This event context

getEventType

public EventTypes getEventType()

Get the type of this event context.

Returns:

The event context type

commit

public SystemEvent commit()

Flush this event log to the graph.