Interface MutableEventScopeInstanceState
-
- All Superinterfaces:
EventScopeInstanceState
- All Known Implementing Classes:
DbEventScopeInstanceState
public interface MutableEventScopeInstanceState extends EventScopeInstanceState
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
createIfNotExists(long eventScopeKey, Collection<org.agrona.DirectBuffer> interruptingIds)
Creates a new event scope instance in the statevoid
createInstance(long eventScopeKey, Collection<org.agrona.DirectBuffer> interruptingIds)
Creates a new event scope instance in the statevoid
deleteInstance(long eventScopeKey)
Delete an event scope from the state.void
deleteTrigger(long eventScopeKey, long eventKey)
Deletes an event trigger by key and scope key.EventTrigger
pollEventTrigger(long eventScopeKey)
Returns the next event trigger for the event scope or null if none exists.void
shutdownInstance(long eventScopeKey)
If the scope exists, sets its accepting property to false.boolean
triggerEvent(long eventScopeKey, long eventKey, org.agrona.DirectBuffer elementId, org.agrona.DirectBuffer variables)
void
triggerStartEvent(long processDefinitionKey, long eventKey, org.agrona.DirectBuffer elementId, org.agrona.DirectBuffer variables)
Creates an event trigger for a process start event.-
Methods inherited from interface io.camunda.zeebe.engine.state.immutable.EventScopeInstanceState
getInstance, isAcceptingEvent, peekEventTrigger
-
-
-
-
Method Detail
-
shutdownInstance
void shutdownInstance(long eventScopeKey)
If the scope exists, sets its accepting property to false.- Parameters:
eventScopeKey
- the event scope key
-
createIfNotExists
boolean createIfNotExists(long eventScopeKey, Collection<org.agrona.DirectBuffer> interruptingIds)
Creates a new event scope instance in the state- Parameters:
eventScopeKey
- the event scope keyinterruptingIds
- list of element IDs which should set accepting to false- Returns:
- whether the scope was created or not
-
createInstance
void createInstance(long eventScopeKey, Collection<org.agrona.DirectBuffer> interruptingIds)
Creates a new event scope instance in the state- Parameters:
eventScopeKey
- the event scope keyinterruptingIds
- list of element IDs which should set accepting to false
-
deleteInstance
void deleteInstance(long eventScopeKey)
Delete an event scope from the state. Does not fail in case the scope does not exist.- Parameters:
eventScopeKey
- the key of the event scope to delete
-
pollEventTrigger
EventTrigger pollEventTrigger(long eventScopeKey)
Returns the next event trigger for the event scope or null if none exists. This will remove the polled event trigger from the state if it exists.- Parameters:
eventScopeKey
- the key of the event scope- Returns:
- the next event trigger or null if none exist
-
triggerEvent
boolean triggerEvent(long eventScopeKey, long eventKey, org.agrona.DirectBuffer elementId, org.agrona.DirectBuffer variables)
- Parameters:
eventScopeKey
- the key of the event scope the event is triggered ineventKey
- the key of the event record (used for ordering)elementId
- the id of the element which should be triggered, e.g. boundary eventvariables
- the variables of the occurred event, i.e. message variables- Returns:
- true if the event was accepted by the event scope, false otherwise
-
triggerStartEvent
void triggerStartEvent(long processDefinitionKey, long eventKey, org.agrona.DirectBuffer elementId, org.agrona.DirectBuffer variables)
Creates an event trigger for a process start event. Uses the process definition key as the scope key of the trigger.- Parameters:
processDefinitionKey
- the key of the process definition a new instance should be created ofeventKey
- the key of the event record (used for ordering)elementId
- the id of the start event which should be triggeredvariables
- the variables of the occurred event, i.e. message variables
-
deleteTrigger
void deleteTrigger(long eventScopeKey, long eventKey)
Deletes an event trigger by key and scope key. Does not fail if the trigger does not exist.- Parameters:
eventScopeKey
- the key of the event scopeeventKey
- the key of the event trigger
-
-