org.activiti.engine.impl.history

Interface HistoryManager

All Superinterfaces:

Session

All Known Implementing Classes:

DefaultHistoryManager

public interface HistoryManager
extends Session

Method Summary

Methods

Modifier and Type	Method and Description
void	createAttachmentComment(String taskId, String processInstanceId, String attachmentName, boolean create) Creates a new comment to indicate a new attachment has been created or deleted, if history is enabled.
void	createIdentityLinkComment(String taskId, String userId, String groupId, String type, boolean create) Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.
void	createIdentityLinkComment(String taskId, String userId, String groupId, String type, boolean create, boolean forceNullUserId) Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.
void	deleteHistoricIdentityLink(String id)
HistoricActivityInstanceEntity	findActivityInstance(ExecutionEntity execution) Finds the HistoricActivityInstanceEntity that is active in the given execution.
boolean	isHistoryEnabled()
boolean	isHistoryLevelAtLeast(HistoryLevel level)
void	recordActivityEnd(ExecutionEntity executionEntity) Record the end of an activitiy, if activity history is enabled.
void	recordActivityStart(ExecutionEntity executionEntity) Record the start of an activitiy, if activity history is enabled.
void	recordExecutionReplacedBy(ExecutionEntity execution, InterpretableExecution replacedBy) Replaces any open historic activityInstances' execution-id's to the id of the replaced execution, if activity history is enabled.
void	recordHistoricDetailVariableCreate(VariableInstanceEntity variable, ExecutionEntity sourceActivityExecution, boolean useActivityId) Record a variable has been created, if audit history is enabled.
void	recordIdentityLinkCreated(IdentityLinkEntity identityLink) Record the creation of a new IdentityLink, if audit history is enabled.
void	recordProcessDefinitionChange(String processInstanceId, String processDefinitionId) Record a change of the process-definition id of a process instance, if activity history is enabled.
void	recordProcessInstanceEnd(String processInstanceId, String deleteReason, String activityId) Record a process-instance ended.
void	recordProcessInstanceStart(ExecutionEntity processInstance) Record a process-instance started and record start-event if activity history is enabled.
void	recordStartEventEnded(String executionId, String activityId) Record the end of a start-task, if activity history is enabled.
void	recordSubProcessInstanceStart(ExecutionEntity parentExecution, ExecutionEntity subProcessInstance) Record a sub-process-instance started and alters the calledProcessinstanceId on the current active activity's historic counterpart.
void	recordTaskAssigneeChange(String taskId, String assignee) Record task assignee change, if audit history is enabled.
void	recordTaskAssignment(TaskEntity task) Record the assignment of task, if activity history is enabled.
void	recordTaskCategoryChange(String taskId, String category) Record task category change, if audit history is enabled.
void	recordTaskClaim(String taskId) record task instance claim time, if audit history is enabled
void	recordTaskCreated(TaskEntity task, ExecutionEntity execution) Record the creation of a task, if audit history is enabled.
void	recordTaskDefinitionKeyChange(TaskEntity task, String taskDefinitionKey) Record task definition key change, if audit history is enabled.
void	recordTaskDescriptionChange(String taskId, String description) Record task description change, if audit history is enabled.
void	recordTaskDueDateChange(String taskId, Date dueDate) Record task due date change, if audit history is enabled.
void	recordTaskEnd(String taskId, String deleteReason) Record task as ended, if audit history is enabled.
void	recordTaskExecutionIdChange(String taskId, String executionId) Record task execution id change, if audit history is enabled.
void	recordTaskId(TaskEntity task) Record the id of a the task associated with a historic activity, if activity history is enabled.
void	recordTaskNameChange(String taskId, String taskName) Record task name change, if audit history is enabled.
void	recordTaskOwnerChange(String taskId, String owner) Record task owner change, if audit history is enabled.
void	recordTaskParentTaskIdChange(String taskId, String parentTaskId) Record task parent task id change, if audit history is enabled.
void	recordTaskPriorityChange(String taskId, int priority) Record task priority change, if audit history is enabled.
void	recordVariableCreate(VariableInstanceEntity variable) Record a variable has been created, if audit history is enabled.
void	recordVariableUpdate(VariableInstanceEntity variable) Record a variable has been updated, if audit history is enabled.
void	reportFormPropertiesSubmitted(ExecutionEntity processInstance, Map<String,String> properties, String taskId) Report form properties submitted, if audit history is enabled.
void	updateProcessBusinessKeyInHistory(ExecutionEntity processInstance)

Methods inherited from interface org.activiti.engine.impl.interceptor.Session

close, flush

Method Detail

isHistoryLevelAtLeast

boolean isHistoryLevelAtLeast(HistoryLevel level)

Returns:

true, if the configured history-level is equal to OR set to a higher value than the given level.

isHistoryEnabled

boolean isHistoryEnabled()

Returns:

true, if history-level is configured to level other than "none".

recordProcessInstanceEnd

void recordProcessInstanceEnd(String processInstanceId,
                            String deleteReason,
                            String activityId)

Record a process-instance ended. Updates the historic process instance if activity history is enabled.

recordProcessInstanceStart

void recordProcessInstanceStart(ExecutionEntity processInstance)

Record a process-instance started and record start-event if activity history is enabled.

recordSubProcessInstanceStart

void recordSubProcessInstanceStart(ExecutionEntity parentExecution,
                                 ExecutionEntity subProcessInstance)

Record a sub-process-instance started and alters the calledProcessinstanceId on the current active activity's historic counterpart. Only effective when activity history is enabled.

recordActivityStart

void recordActivityStart(ExecutionEntity executionEntity)

Record the start of an activitiy, if activity history is enabled.

recordActivityEnd

void recordActivityEnd(ExecutionEntity executionEntity)

Record the end of an activitiy, if activity history is enabled.

recordStartEventEnded

void recordStartEventEnded(String executionId,
                         String activityId)

Record the end of a start-task, if activity history is enabled.

findActivityInstance

HistoricActivityInstanceEntity findActivityInstance(ExecutionEntity execution)

Finds the HistoricActivityInstanceEntity that is active in the given execution. Uses the DbSqlSession cache to make sure the right instance is returned, regardless of whether or not entities have already been flushed to DB.

recordExecutionReplacedBy

void recordExecutionReplacedBy(ExecutionEntity execution,
                             InterpretableExecution replacedBy)

Replaces any open historic activityInstances' execution-id's to the id of the replaced execution, if activity history is enabled.

recordProcessDefinitionChange

void recordProcessDefinitionChange(String processInstanceId,
                                 String processDefinitionId)

Record a change of the process-definition id of a process instance, if activity history is enabled.

recordTaskCreated

void recordTaskCreated(TaskEntity task,
                     ExecutionEntity execution)

Record the creation of a task, if audit history is enabled.

recordTaskAssignment

void recordTaskAssignment(TaskEntity task)

Record the assignment of task, if activity history is enabled.

recordTaskClaim

void recordTaskClaim(String taskId)

record task instance claim time, if audit history is enabled

Parameters:

taskId -

recordTaskId

void recordTaskId(TaskEntity task)

Record the id of a the task associated with a historic activity, if activity history is enabled.

recordTaskEnd

void recordTaskEnd(String taskId,
                 String deleteReason)

Record task as ended, if audit history is enabled.

recordTaskAssigneeChange

void recordTaskAssigneeChange(String taskId,
                            String assignee)

Record task assignee change, if audit history is enabled.

recordTaskOwnerChange

void recordTaskOwnerChange(String taskId,
                         String owner)

Record task owner change, if audit history is enabled.

recordTaskNameChange

void recordTaskNameChange(String taskId,
                        String taskName)

Record task name change, if audit history is enabled.

recordTaskDescriptionChange

void recordTaskDescriptionChange(String taskId,
                               String description)

Record task description change, if audit history is enabled.

recordTaskDueDateChange

void recordTaskDueDateChange(String taskId,
                           Date dueDate)

Record task due date change, if audit history is enabled.

recordTaskPriorityChange

void recordTaskPriorityChange(String taskId,
                            int priority)

Record task priority change, if audit history is enabled.

recordTaskCategoryChange

void recordTaskCategoryChange(String taskId,
                            String category)

Record task category change, if audit history is enabled.

recordTaskParentTaskIdChange

void recordTaskParentTaskIdChange(String taskId,
                                String parentTaskId)

Record task parent task id change, if audit history is enabled.

recordTaskExecutionIdChange

void recordTaskExecutionIdChange(String taskId,
                               String executionId)

Record task execution id change, if audit history is enabled.

recordTaskDefinitionKeyChange

void recordTaskDefinitionKeyChange(TaskEntity task,
                                 String taskDefinitionKey)

Record task definition key change, if audit history is enabled.

recordVariableCreate

void recordVariableCreate(VariableInstanceEntity variable)

Record a variable has been created, if audit history is enabled.

recordHistoricDetailVariableCreate

void recordHistoricDetailVariableCreate(VariableInstanceEntity variable,
                                      ExecutionEntity sourceActivityExecution,
                                      boolean useActivityId)

Record a variable has been created, if audit history is enabled.

recordVariableUpdate

void recordVariableUpdate(VariableInstanceEntity variable)

Record a variable has been updated, if audit history is enabled.

createIdentityLinkComment

void createIdentityLinkComment(String taskId,
                             String userId,
                             String groupId,
                             String type,
                             boolean create)

Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.

createIdentityLinkComment

void createIdentityLinkComment(String taskId,
                             String userId,
                             String groupId,
                             String type,
                             boolean create,
                             boolean forceNullUserId)

Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.

createAttachmentComment

void createAttachmentComment(String taskId,
                           String processInstanceId,
                           String attachmentName,
                           boolean create)

Creates a new comment to indicate a new attachment has been created or deleted, if history is enabled.

reportFormPropertiesSubmitted

void reportFormPropertiesSubmitted(ExecutionEntity processInstance,
                                 Map<String,String> properties,
                                 String taskId)

Report form properties submitted, if audit history is enabled.

recordIdentityLinkCreated

void recordIdentityLinkCreated(IdentityLinkEntity identityLink)

Record the creation of a new IdentityLink, if audit history is enabled.

deleteHistoricIdentityLink

void deleteHistoricIdentityLink(String id)

updateProcessBusinessKeyInHistory

void updateProcessBusinessKeyInHistory(ExecutionEntity processInstance)