Interface EventInstanceRepository
-
- All Known Implementing Classes:
EventInstanceRepositoryImpl
public interface EventInstanceRepository
- Author:
- Pascal GARCIA
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
EVENT_INSTANCE
static java.lang.String
EVENT_TRIGGER_INSTANCE
static int
IN_REQUEST_SIZE
static java.lang.String
MESSAGE_INSTANCE
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
createEventInstance(SEventInstance eventInstance)
void
createMessageInstance(SMessageInstance messageInstance)
void
createTimerEventTriggerInstance(STimerEventTriggerInstance sEventTriggerInstance)
STimerEventTriggerInstance is used to keep track of currently running timers usingProcessRuntimeAPI.searchTimerEventTriggerInstances(long, SearchOptions)
void
createWaitingEvent(SWaitingEvent waitingEvent)
void
deleteEventTriggerInstance(STimerEventTriggerInstance eventTriggerInstance)
void
deleteMessageInstance(SMessageInstance messageInstance)
void
deleteMessageInstanceByIds(java.util.List<java.lang.Long> ids)
void
deleteWaitingEvent(SWaitingEvent waitingEvent)
java.util.List<SBoundaryEventInstance>
getActivityBoundaryEventInstances(long activityInstanceId, int fromIndex, int maxResults)
java.util.List<SWaitingEvent>
getAllWaitingEventsForProcessInstance(long processInstanceId, int fromIndex, int maxResults)
Return waiting events related to the process instance passed as parameter, including the ones at flow node level.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>
TgetEventTriggerInstance(java.lang.Class<T> entityClass, long eventTriggerInstanceId)
java.util.List<SMessageEventCouple>
getMessageEventCouples(int fromIndex, int maxResults)
SMessageInstance
getMessageInstance(long messageInstanceId)
java.util.List<java.lang.Long>
getMessageInstanceIdOlderThanCreationDate(long creationDate, QueryOptions queryOptions)
long
getNumberOfTimerEventTriggerInstances(long processInstanceId, QueryOptions queryOptions)
Get the number of STimerEventTriggerInstance on the specific process instance & corresponding to the criterialong
getNumberOfWaitingEvents(java.lang.Class<? extends SWaitingEvent> entityClass, QueryOptions countOptions)
java.util.List<SWaitingEvent>
getStartWaitingEventsOfProcessDefinition(long processDefinitionId)
search start waiting events related to a process definition (not its event sub processes)java.util.Optional<STimerEventTriggerInstance>
getTimerEventTriggerInstanceOfFlowNode(long flowNodeInstanceId)
java.util.List<SWaitingEvent>
getWaitingEventsForFlowNodeId(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<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)
-
-
-
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
-
IN_REQUEST_SIZE
static final int IN_REQUEST_SIZE
- 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 usingProcessRuntimeAPI.searchTimerEventTriggerInstances(long, SearchOptions)
-
createMessageInstance
void createMessageInstance(SMessageInstance messageInstance) 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
-
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
-
getStartWaitingEventsOfProcessDefinition
java.util.List<SWaitingEvent> getStartWaitingEventsOfProcessDefinition(long processDefinitionId) throws SBonitaReadException
search start waiting events related to a process definition (not its event sub processes)- Parameters:
processDefinitionId
-- Returns:
- Throws:
SBonitaReadException
- Since:
- 6.3
-
getMessageEventCouples
java.util.List<SMessageEventCouple> getMessageEventCouples(int fromIndex, int maxResults) throws SEventTriggerInstanceReadException
-
getWaitingMessage
SWaitingMessageEvent getWaitingMessage(long waitingMessageId) throws SWaitingEventReadException
- Throws:
SWaitingEventReadException
-
getMessageInstance
SMessageInstance getMessageInstance(long messageInstanceId) throws SMessageInstanceReadException
- Throws:
SMessageInstanceReadException
-
deleteMessageInstanceByIds
void deleteMessageInstanceByIds(java.util.List<java.lang.Long> ids) throws SMessageModificationException
- Throws:
SMessageModificationException
-
getMessageInstanceIdOlderThanCreationDate
java.util.List<java.lang.Long> getMessageInstanceIdOlderThanCreationDate(long creationDate, QueryOptions queryOptions) throws SEventTriggerInstanceReadException, SMessageInstanceReadException
-
updateWaitingMessage
void updateWaitingMessage(SWaitingMessageEvent waitingMessageEvent, EntityUpdateDescriptor descriptor) 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
-
deleteEventTriggerInstance
void deleteEventTriggerInstance(STimerEventTriggerInstance eventTriggerInstance) throws SEventTriggerInstanceDeletionException
- Parameters:
eventTriggerInstance
-- Throws:
SEventTriggerInstanceDeletionException
- 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 instancequeryOptions
- 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 instancequeryOptions
- 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 updatedescriptor
- The fields to update- Throws:
SEventTriggerInstanceModificationException
- Since:
- 6.4.0
-
getWaitingEventsForFlowNodeId
java.util.List<SWaitingEvent> getWaitingEventsForFlowNodeId(long flowNodeInstanceId) throws SEventTriggerInstanceReadException
-
getAllWaitingEventsForProcessInstance
java.util.List<SWaitingEvent> getAllWaitingEventsForProcessInstance(long processInstanceId, int fromIndex, int maxResults) throws SEventTriggerInstanceReadException
Return waiting events related to the process instance passed as parameter, including the ones at flow node level.
-
-