org.camunda.bpm.engine.impl.history.producer
Interface HistoryEventProducer

All Known Implementing Classes:

CacheAwareHistoryEventProducer, DefaultHistoryEventProducer

public interface HistoryEventProducer

The producer for history events. The history event producer is responsible for extracting data from the runtime structures (Executions, Tasks, ...) and adding the data to a HistoryEvent.

Author:

Daniel Meyer, Marcel Wieczorek

Method Summary

HistoryEvent	createActivityInstanceEndEvt(DelegateExecution execution) Creates the history event fired when an activity instances is ended.
HistoryEvent	createActivityInstanceStartEvt(DelegateExecution execution) Creates the history event fired when an activity instances is started.
HistoryEvent	createActivityInstanceUpdateEvt(DelegateExecution execution, DelegateTask task) Creates the history event fired when an activity instances is updated.
HistoryEvent	createFormPropertyUpdateEvt(ExecutionEntity execution, String propertyId, String propertyValue, String taskId) Creates the history event fired when a form property is updated.
HistoryEvent	createHistoricIncidentCreateEvt(Incident incident)
HistoryEvent	createHistoricIncidentDeleteEvt(Incident incident)
HistoryEvent	createHistoricIncidentResolveEvt(Incident incident)
HistoryEvent	createHistoricJobLogCreateEvt(Job job) Creates the history event fired when a job has been created.
HistoryEvent	createHistoricJobLogDeleteEvt(Job job) Creates the history event fired when the a job has been deleted.
HistoryEvent	createHistoricJobLogFailedEvt(Job job, Throwable exception) Creates the history event fired when the execution of a job failed.
HistoryEvent	createHistoricJobLogSuccessfulEvt(Job job) Creates the history event fired when the execution of a job was successful.
HistoryEvent	createHistoricVariableCreateEvt(VariableInstanceEntity variableInstance, VariableScope sourceVariableScope) Creates the history event fired when a variable is created.
HistoryEvent	createHistoricVariableDeleteEvt(VariableInstanceEntity variableInstance, VariableScope sourceVariableScope) Creates the history event fired when a variable is deleted.
HistoryEvent	createHistoricVariableUpdateEvt(VariableInstanceEntity variableInstance, VariableScope sourceVariableScope) Creates the history event fired when a variable is updated.
HistoryEvent	createProcessInstanceEndEvt(DelegateExecution execution) Creates the history event fired when a process instances is ended.
HistoryEvent	createProcessInstanceStartEvt(DelegateExecution execution) Creates the history event fired when an process instances is created.
HistoryEvent	createTaskInstanceCompleteEvt(DelegateTask task, String deleteReason) Creates the history event fired when a task instances is completed.
HistoryEvent	createTaskInstanceCreateEvt(DelegateTask task) Creates the history event fired when a task instances is created.
HistoryEvent	createTaskInstanceUpdateEvt(DelegateTask task) Creates the history event fired when a task instances is updated.
List<HistoryEvent>	createUserOperationLogEvents(UserOperationLogContext context) Creates the history event fired whenever an operation has been performed by a user.

Method Detail

createProcessInstanceStartEvt

HistoryEvent createProcessInstanceStartEvt(DelegateExecution execution)

Creates the history event fired when an process instances is created.

Parameters:

execution - the current execution.

Returns:

the history event

createProcessInstanceEndEvt

HistoryEvent createProcessInstanceEndEvt(DelegateExecution execution)

Creates the history event fired when a process instances is ended.

Parameters:

execution - the current execution.

Returns:

the history event

createActivityInstanceStartEvt

HistoryEvent createActivityInstanceStartEvt(DelegateExecution execution)

Creates the history event fired when an activity instances is started.

Parameters:

execution - the current execution.

Returns:

the history event

createActivityInstanceUpdateEvt

HistoryEvent createActivityInstanceUpdateEvt(DelegateExecution execution,
                                             DelegateTask task)

Creates the history event fired when an activity instances is updated.

Parameters:

execution - the current execution.

task - the task association that is currently updated. (May be null in case there is not task associated.)

Returns:

the history event

createActivityInstanceEndEvt

HistoryEvent createActivityInstanceEndEvt(DelegateExecution execution)

Creates the history event fired when an activity instances is ended.

Parameters:

execution - the current execution.

Returns:

the history event

createTaskInstanceCreateEvt

HistoryEvent createTaskInstanceCreateEvt(DelegateTask task)

Creates the history event fired when a task instances is created.

Parameters:

task - the task

Returns:

the history event

createTaskInstanceUpdateEvt

HistoryEvent createTaskInstanceUpdateEvt(DelegateTask task)

Creates the history event fired when a task instances is updated.

Parameters:

task - the task

Returns:

the history event

createTaskInstanceCompleteEvt

HistoryEvent createTaskInstanceCompleteEvt(DelegateTask task,
                                           String deleteReason)

Creates the history event fired when a task instances is completed.

Parameters:

task - the task

deleteReason -

Returns:

the history event

createUserOperationLogEvents

List<HistoryEvent> createUserOperationLogEvents(UserOperationLogContext context)

Creates the history event fired whenever an operation has been performed by a user. This is used for logging actions such as creating a new Task, completing a task, canceling a a process instance, ...

Parameters:

context - the UserOperationLogContext providing the needed informations

Returns:

a List of HistoryEvents

createHistoricVariableCreateEvt

HistoryEvent createHistoricVariableCreateEvt(VariableInstanceEntity variableInstance,
                                             VariableScope sourceVariableScope)

Creates the history event fired when a variable is created.

Parameters:

variableInstance - the runtime variable instance

the - scope to which the variable is linked

Returns:

the history event

createHistoricVariableUpdateEvt

HistoryEvent createHistoricVariableUpdateEvt(VariableInstanceEntity variableInstance,
                                             VariableScope sourceVariableScope)

Creates the history event fired when a variable is updated.

Parameters:

variableInstance - the runtime variable instance

the - scope to which the variable is linked

Returns:

the history event

createHistoricVariableDeleteEvt

HistoryEvent createHistoricVariableDeleteEvt(VariableInstanceEntity variableInstance,
                                             VariableScope sourceVariableScope)

Creates the history event fired when a variable is deleted.

Parameters:

variableInstance -

variableScopeImpl -

Returns:

the history event

createFormPropertyUpdateEvt

HistoryEvent createFormPropertyUpdateEvt(ExecutionEntity execution,
                                         String propertyId,
                                         String propertyValue,
                                         String taskId)

Creates the history event fired when a form property is updated.

Parameters:

processInstance - the id for the process instance

propertyId - the id of the form property

propertyValue - the value of the form property

taskId -

Returns:

the history event

createHistoricIncidentCreateEvt

HistoryEvent createHistoricIncidentCreateEvt(Incident incident)

createHistoricIncidentResolveEvt

HistoryEvent createHistoricIncidentResolveEvt(Incident incident)

createHistoricIncidentDeleteEvt

HistoryEvent createHistoricIncidentDeleteEvt(Incident incident)

createHistoricJobLogCreateEvt

HistoryEvent createHistoricJobLogCreateEvt(Job job)

Creates the history event fired when a job has been created.

Since:

7.3

createHistoricJobLogFailedEvt

HistoryEvent createHistoricJobLogFailedEvt(Job job,
                                           Throwable exception)

Creates the history event fired when the execution of a job failed.

Since:

7.3

createHistoricJobLogSuccessfulEvt

HistoryEvent createHistoricJobLogSuccessfulEvt(Job job)

Creates the history event fired when the execution of a job was successful.

Since:

7.3

createHistoricJobLogDeleteEvt

HistoryEvent createHistoricJobLogDeleteEvt(Job job)

Creates the history event fired when the a job has been deleted.

Since:

7.3