org.bonitasoft.engine.core.process.instance.api.event

Interface EventInstanceService

All Superinterfaces:

FlowNodeInstanceService

All Known Implementing Classes:

EventInstanceServiceImpl

public interface EventInstanceService
extends FlowNodeInstanceService

Author:

Elias Ricken de Medeiros, Matthieu Chaffotte, Celine Souchet

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EVENT_INSTANCE
static java.lang.String	EVENT_TRIGGER_INSTANCE
static java.lang.String	MESSAGE_INSTANCE

Fields inherited from interface org.bonitasoft.engine.core.process.instance.api.FlowNodeInstanceService

ACTIVITY_INSTANCE_TOKEN_COUNT, ACTIVITYINSTANCE_DISPLAY_DESCRIPTION, ACTIVITYINSTANCE_DISPLAY_NAME, ACTIVITYINSTANCE_STATE, EXECUTED_BY_MODIFIED, EXECUTED_BY_SUBSTITUTE_MODIFIED, EXPECTED_END_DATE_MODIFIED, FLOWNODE_INSTANCE, LOOPINSTANCE_LOOPMAX_MODIFIED, MULTIINSTANCE_LOOPCARDINALITY_MODIFIED, MULTIINSTANCE_NUMBEROFINSTANCE_MODIFIED, STATE_CATEGORY

Method Summary

Modifier and Type	Method and Description
void	createEventInstance(SEventInstance eventInstance)
void	createMessageInstance(SMessageInstance messageInstance)
void	createTimerEventTriggerInstance(STimerEventTriggerInstance sEventTriggerInstance) STimerEventTriggerInstance is used to keep track of currently running timers using ProcessRuntimeAPI.searchTimerEventTriggerInstances(long, SearchOptions)
void	createWaitingEvent(SWaitingEvent waitingEvent)
void	deleteEventTriggerInstance(STimerEventTriggerInstance eventTriggerInstance)
void	deleteMessageInstance(SMessageInstance messageInstance)
void	deleteWaitingEvent(SWaitingEvent waitingEvent)
void	deleteWaitingEvents(SFlowNodeInstance flowNodeInstance)
java.util.List<SBoundaryEventInstance>	getActivityBoundaryEventInstances(long activityInstanceId, int fromIndex, int maxResults)
SWaitingErrorEvent	getBoundaryWaitingErrorEvent(long relatedActivityInstanceId, java.lang.String errorCode)
java.util.List<SEventInstance>	getEventInstances(long rootContainerId, int fromIndex, int maxResults, java.lang.String fieldName, OrderByType orderByType)
<T extends STimerEventTriggerInstance> T	getEventTriggerInstance(java.lang.Class<T> entityClass, long eventTriggerInstanceId)
java.util.List<SMessageEventCouple>	getMessageEventCouples(int fromIndex, int maxResults)
SMessageInstance	getMessageInstance(long messageInstanceId)
long	getNumberOfTimerEventTriggerInstances(long processInstanceId, QueryOptions queryOptions) Get the number of STimerEventTriggerInstance on the specific process instance & corresponding to the criteria
long	getNumberOfWaitingEvents(java.lang.Class<? extends SWaitingEvent> entityClass, QueryOptions countOptions)
java.util.Optional<STimerEventTriggerInstance>	getTimerEventTriggerInstanceOfFlowNode(long flowNodeInstanceId)
SWaitingMessageEvent	getWaitingMessage(long waitingMessageId)
SWaitingSignalEvent	getWaitingSignalEvent(long id)
java.util.List<SWaitingSignalEvent>	getWaitingSignalEvents(java.lang.String signalName, int fromIndex, int maxResults)
int	resetInProgressWaitingEvents() Resets all Waiting Message Events marked as 'in progress", so that they are eligible to match Message Instances again.
int	resetProgressMessageInstances() Resets all Message Instances marked as handled, so that they are eligible to match Waiting Events again.
java.util.List<SWaitingEvent>	searchStartWaitingEvents(long processDefinitionId, QueryOptions queryOptions)
java.util.List<STimerEventTriggerInstance>	searchTimerEventTriggerInstances(long processInstanceId, QueryOptions queryOptions) Search the list of STimerEventTriggerInstance on the specific process instance & corresponding to the criteria
<T extends SWaitingEvent> java.util.List<T>	searchWaitingEvents(java.lang.Class<T> entityClass, QueryOptions searchOptions)
void	updateEventTriggerInstance(STimerEventTriggerInstance sTimerEventTriggerInstance, EntityUpdateDescriptor descriptor) Update an event trigger instance.
void	updateMessageInstance(SMessageInstance messageInstance, EntityUpdateDescriptor descriptor)
void	updateWaitingMessage(SWaitingMessageEvent waitingMessageEvent, EntityUpdateDescriptor descriptor)

Methods inherited from interface org.bonitasoft.engine.core.process.instance.api.FlowNodeInstanceService

deleteArchivedFlowNodeInstances, deleteFlowNodeInstance, getArchivedFlowNodeInstance, getArchivedFlowNodeInstances, getFlowNodeInstance, getFlowNodeInstanceIdsToRestart, getFlowNodeInstancesOfActivity, getFlowNodeInstancesOfProcess, getLastArchivedFlowNodeInstance, getNumberOfArchivedFlowNodeInstances, getNumberOfArchivedFlowNodeInstancesSupervisedBy, getNumberOfArchivedFlownodesInAllStates, getNumberOfFlowNodeInstances, getNumberOfFlowNodeInstancesSupervisedBy, getNumberOfFlowNodes, getNumberOfFlownodesInAllStates, getSourceObjectIdsOfArchivedFlowNodeInstances, searchArchivedFlowNodeInstances, searchArchivedFlowNodeInstancesSupervisedBy, searchFlowNodeInstances, searchFlowNodeInstancesSupervisedBy, setExecutedBy, setExecutedBySubstitute, setExecuting, setExpectedEndDate, setState, setStateCategory, setTaskPriority, updateDisplayDescription, updateDisplayName

Field Detail

EVENT_INSTANCE

static final java.lang.String EVENT_INSTANCE

See Also:

Constant Field Values

EVENT_TRIGGER_INSTANCE

static final java.lang.String EVENT_TRIGGER_INSTANCE

See Also:

Constant Field Values

MESSAGE_INSTANCE

static final java.lang.String MESSAGE_INSTANCE

See Also:

Constant Field Values

Method Detail

createEventInstance

void createEventInstance(SEventInstance eventInstance)
                  throws SEventInstanceCreationException

Throws:

SEventInstanceCreationException

createTimerEventTriggerInstance

void createTimerEventTriggerInstance(STimerEventTriggerInstance sEventTriggerInstance)
                              throws SEventTriggerInstanceCreationException

STimerEventTriggerInstance is used to keep track of currently running timers using ProcessRuntimeAPI.searchTimerEventTriggerInstances(long, SearchOptions)

Throws:

SEventTriggerInstanceCreationException

createMessageInstance

void createMessageInstance(SMessageInstance messageInstance)
                    throws SMessageInstanceCreationException

Throws:

SMessageInstanceCreationException

createWaitingEvent

void createWaitingEvent(SWaitingEvent waitingEvent)
                 throws SWaitingEventCreationException

Throws:

SWaitingEventCreationException

getBoundaryWaitingErrorEvent

SWaitingErrorEvent getBoundaryWaitingErrorEvent(long relatedActivityInstanceId,
                                                java.lang.String errorCode)
                                         throws SWaitingEventReadException

Throws:

SWaitingEventReadException

getEventInstances

java.util.List<SEventInstance> getEventInstances(long rootContainerId,
                                                 int fromIndex,
                                                 int maxResults,
                                                 java.lang.String fieldName,
                                                 OrderByType orderByType)
                                          throws SEventInstanceReadException

Throws:

SEventInstanceReadException

getActivityBoundaryEventInstances

java.util.List<SBoundaryEventInstance> getActivityBoundaryEventInstances(long activityInstanceId,
                                                                         int fromIndex,
                                                                         int maxResults)
                                                                  throws SEventInstanceReadException

Parameters:

activityInstanceId -

fromIndex -

maxResults -

Returns:

List of SBoundaryEventInstance, ordered by identifier ascending

Throws:

SEventInstanceReadException

Since:

6.2

getEventTriggerInstance

<T extends STimerEventTriggerInstance> T getEventTriggerInstance(java.lang.Class<T> entityClass,
                                                                 long eventTriggerInstanceId)
                                                          throws SEventTriggerInstanceReadException

Parameters:

entityClass -

eventTriggerInstanceId -

Returns:

Throws:

SEventTriggerInstanceReadException

Since:

6.4.0

deleteMessageInstance

void deleteMessageInstance(SMessageInstance messageInstance)
                    throws SMessageModificationException

Throws:

SMessageModificationException

deleteWaitingEvent

void deleteWaitingEvent(SWaitingEvent waitingEvent)
                 throws SWaitingEventModificationException

Throws:

SWaitingEventModificationException

getWaitingSignalEvents

java.util.List<SWaitingSignalEvent> getWaitingSignalEvents(java.lang.String signalName,
                                                           int fromIndex,
                                                           int maxResults)
                                                    throws SEventTriggerInstanceReadException

Parameters:

signalName -

fromIndex -

maxResults -

Returns:

Throws:

SEventTriggerInstanceReadException

Since:

6.3

searchStartWaitingEvents

java.util.List<SWaitingEvent> searchStartWaitingEvents(long processDefinitionId,
                                                       QueryOptions queryOptions)
                                                throws SBonitaReadException

Parameters:

processDefinitionId -

searchOptions -

Returns:

Throws:

SBonitaReadException

Since:

6.3

getMessageEventCouples

java.util.List<SMessageEventCouple> getMessageEventCouples(int fromIndex,
                                                           int maxResults)
                                                    throws SEventTriggerInstanceReadException

Throws:

SEventTriggerInstanceReadException

getWaitingMessage

SWaitingMessageEvent getWaitingMessage(long waitingMessageId)
                                throws SWaitingEventReadException

Throws:

SWaitingEventReadException

getMessageInstance

SMessageInstance getMessageInstance(long messageInstanceId)
                             throws SMessageInstanceReadException

Throws:

SMessageInstanceReadException

updateWaitingMessage

void updateWaitingMessage(SWaitingMessageEvent waitingMessageEvent,
                          EntityUpdateDescriptor descriptor)
                   throws SWaitingEventModificationException

Throws:

SWaitingEventModificationException

updateMessageInstance

void updateMessageInstance(SMessageInstance messageInstance,
                           EntityUpdateDescriptor descriptor)
                    throws SMessageModificationException

Throws:

SMessageModificationException

searchWaitingEvents

<T extends SWaitingEvent> java.util.List<T> searchWaitingEvents(java.lang.Class<T> entityClass,
                                                                QueryOptions searchOptions)
                                                         throws SBonitaReadException

Throws:

SBonitaReadException

getNumberOfWaitingEvents

long getNumberOfWaitingEvents(java.lang.Class<? extends SWaitingEvent> entityClass,
                              QueryOptions countOptions)
                       throws SBonitaReadException

Throws:

SBonitaReadException

getTimerEventTriggerInstanceOfFlowNode

java.util.Optional<STimerEventTriggerInstance> getTimerEventTriggerInstanceOfFlowNode(long flowNodeInstanceId)
                                                                               throws SBonitaReadException

Parameters:

flowNodeInstanceId - the flow node instance id

Returns:

the timer event trigger instance of this flow node if there is one

Throws:

SBonitaReadException

getWaitingSignalEvent

SWaitingSignalEvent getWaitingSignalEvent(long id)
                                   throws SEventTriggerInstanceReadException,
                                          SEventTriggerInstanceNotFoundException

Throws:

SEventTriggerInstanceReadException

SEventTriggerInstanceNotFoundException

deleteEventTriggerInstance

void deleteEventTriggerInstance(STimerEventTriggerInstance eventTriggerInstance)
                         throws SEventTriggerInstanceDeletionException

Parameters:

eventTriggerInstance -

Throws:

SEventTriggerInstanceDeletionException

Since:

6.1

deleteWaitingEvents

void deleteWaitingEvents(SFlowNodeInstance flowNodeInstance)
                  throws SWaitingEventModificationException,
                         SBonitaReadException

Parameters:

flowNodeInstance -

Throws:

SWaitingEventModificationException

SFlowNodeReadException

SBonitaReadException

Since:

6.1

resetProgressMessageInstances

int resetProgressMessageInstances()
                           throws SMessageModificationException

Resets all Message Instances marked as handled, so that they are eligible to match Waiting Events again.

Throws:

SMessageModificationException - if an error occurs when resetting the 'handled' flag.

resetInProgressWaitingEvents

int resetInProgressWaitingEvents()
                          throws SWaitingEventModificationException

Resets all Waiting Message Events marked as 'in progress", so that they are eligible to match Message Instances again.

Returns:

the number of waiting events reset.

Throws:

SWaitingEventModificationException - if an error occurs when resetting the 'progress' flag.

getNumberOfTimerEventTriggerInstances

long getNumberOfTimerEventTriggerInstances(long processInstanceId,
                                           QueryOptions queryOptions)
                                    throws SBonitaReadException

Get the number of STimerEventTriggerInstance on the specific process instance & corresponding to the criteria

Parameters:

processInstanceId - The identifier of the process instance

searchOptions - Criteria of the search

Returns:

The number of STimerEventTriggerInstance on the specific process instance & corresponding to the criteria

Throws:

SBonitaReadException

Since:

6.4.0

searchTimerEventTriggerInstances

java.util.List<STimerEventTriggerInstance> searchTimerEventTriggerInstances(long processInstanceId,
                                                                            QueryOptions queryOptions)
                                                                     throws SBonitaReadException

Search the list of STimerEventTriggerInstance on the specific process instance & corresponding to the criteria

Parameters:

processInstanceId - The identifier of the process instance

searchOptions - Criteria of the search

Returns:

The list of STimerEventTriggerInstance on the specific process instance & corresponding to the criteria

Throws:

SBonitaReadException

Since:

6.4.0

updateEventTriggerInstance

void updateEventTriggerInstance(STimerEventTriggerInstance sTimerEventTriggerInstance,
                                EntityUpdateDescriptor descriptor)
                         throws SEventTriggerInstanceModificationException

Update an event trigger instance.

Parameters:

sTimerEventTriggerInstance - The event trigger instance to update

descriptor - The fields to update

Throws:

SEventTriggerModificationException

SEventTriggerInstanceModificationException

Since:

6.4.0