Package org.camunda.bpm.engine.impl

Class HistoryServiceImpl

java.lang.Object

org.camunda.bpm.engine.impl.ServiceImpl

org.camunda.bpm.engine.impl.HistoryServiceImpl

All Implemented Interfaces:

HistoryService

public class HistoryServiceImpl
extends ServiceImpl
implements HistoryService

Author:

Tom Baeyens, Bernd Ruecker (camunda), Christian Stettler

Field Summary

Fields inherited from class org.camunda.bpm.engine.impl.ServiceImpl

commandExecutor

Constructor Summary

Constructors

Constructor	Description
HistoryServiceImpl()

Method Summary

Modifier and Type	Method	Description
Job	cleanUpHistoryAsync()	Schedules history cleanup job at batch window start time.
Job	cleanUpHistoryAsync(boolean immediatelyDue)	Schedules history cleanup job at batch window start time.
void	clearAnnotationForOperationLogById(java.lang.String operationId)	Clear the annotation for user operation log entries.
CleanableHistoricBatchReport	createCleanableHistoricBatchReport()	Creates a new programmatic query to create a cleanable historic batch report.
CleanableHistoricCaseInstanceReport	createCleanableHistoricCaseInstanceReport()	Creates a new programmatic query to create a cleanable historic case instance report.
CleanableHistoricDecisionInstanceReport	createCleanableHistoricDecisionInstanceReport()	Creates a new programmatic query to create a cleanable historic decision instance report.
CleanableHistoricProcessInstanceReport	createCleanableHistoricProcessInstanceReport()	Creates a new programmatic query to create a cleanable historic process instance report.
HistoricActivityInstanceQuery	createHistoricActivityInstanceQuery()	Creates a new programmatic query to search for HistoricActivityInstances.
HistoricActivityStatisticsQuery	createHistoricActivityStatisticsQuery(java.lang.String processDefinitionId)	Query for the number of historic activity instances aggregated by activities of a single process definition.
HistoricBatchQuery	createHistoricBatchQuery()	Creates a query to search for HistoricBatch instances.
HistoricCaseActivityInstanceQuery	createHistoricCaseActivityInstanceQuery()	Creates a new programmatic query to search for HistoricCaseActivityInstances.
HistoricCaseActivityStatisticsQuery	createHistoricCaseActivityStatisticsQuery(java.lang.String caseDefinitionId)	Query for the number of historic case activity instances aggregated by case activities of a single case definition.
HistoricCaseInstanceQuery	createHistoricCaseInstanceQuery()	Creates a new programmatic query to search for HistoricCaseInstances.
HistoricDecisionInstanceQuery	createHistoricDecisionInstanceQuery()	Creates a new programmatic query to search for HistoricDecisionInstances.
HistoricDecisionInstanceStatisticsQuery	createHistoricDecisionInstanceStatisticsQuery(java.lang.String decisionRequirementsDefinitionId)	Query for the statistics of DRD evaluation.
HistoricDetailQuery	createHistoricDetailQuery()	Creates a new programmatic query to search for HistoricDetails.
HistoricExternalTaskLogQuery	createHistoricExternalTaskLogQuery()	Creates a new programmatic query to search for historic external task logs.
HistoricIdentityLinkLogQueryImpl	createHistoricIdentityLinkLogQuery()	Creates a new programmatic query to search for historic identity links.
HistoricIncidentQuery	createHistoricIncidentQuery()	Creates a new programmatic query to search for historic incidents.
HistoricJobLogQuery	createHistoricJobLogQuery()	Creates a new programmatic query to search for historic job logs.
HistoricProcessInstanceQuery	createHistoricProcessInstanceQuery()	Creates a new programmatic query to search for HistoricProcessInstances.
HistoricProcessInstanceReport	createHistoricProcessInstanceReport()	Creates a new programmatic query to create a historic process instance report.
HistoricTaskInstanceQuery	createHistoricTaskInstanceQuery()	Creates a new programmatic query to search for HistoricTaskInstances.
HistoricTaskInstanceReport	createHistoricTaskInstanceReport()	Creates a new programmatic query to create a historic task instance report.
HistoricVariableInstanceQuery	createHistoricVariableInstanceQuery()	Creates a new programmatic query to search for HistoricVariableInstances.
NativeHistoricActivityInstanceQuery	createNativeHistoricActivityInstanceQuery()	creates a native query to search for HistoricActivityInstances via SQL
NativeHistoricCaseActivityInstanceQuery	createNativeHistoricCaseActivityInstanceQuery()	creates a native query to search for HistoricCaseActivityInstances via SQL
NativeHistoricCaseInstanceQuery	createNativeHistoricCaseInstanceQuery()	creates a native query to search for HistoricCaseInstances via SQL
NativeHistoricDecisionInstanceQuery	createNativeHistoricDecisionInstanceQuery()	creates a native query to search for HistoricDecisionInstances via SQL
NativeHistoricProcessInstanceQuery	createNativeHistoricProcessInstanceQuery()	creates a native query to search for HistoricProcessInstances via SQL
NativeHistoricTaskInstanceQuery	createNativeHistoricTaskInstanceQuery()	creates a native query to search for HistoricTaskInstances via SQL
NativeHistoricVariableInstanceQuery	createNativeHistoricVariableInstanceQuery()	creates a native query to search for HistoricVariableInstances via SQL
UserOperationLogQuery	createUserOperationLogQuery()	Creates a new programmatic query to search for UserOperationLogEntry instances.
void	deleteHistoricBatch(java.lang.String batchId)	Deletes a historic batch instance.
void	deleteHistoricCaseInstance(java.lang.String caseInstanceId)	Deletes historic case instance.
void	deleteHistoricCaseInstancesBulk(java.util.List<java.lang.String> caseInstanceIds)	Deletes historic case instances and all related historic data in bulk manner.
void	deleteHistoricDecisionInstance(java.lang.String decisionDefinitionId)	Deletes historic decision instances of a decision definition.
void	deleteHistoricDecisionInstanceByDefinitionId(java.lang.String decisionDefinitionId)	Deletes historic decision instances of a decision definition.
void	deleteHistoricDecisionInstanceByInstanceId(java.lang.String historicDecisionInstanceId)	Deletes historic decision instances by its id.
Batch	deleteHistoricDecisionInstancesAsync(java.util.List<java.lang.String> decisionInstanceIds, java.lang.String deleteReason)	Deletes historic decision instances asynchronously based on a list of decision instances.
Batch	deleteHistoricDecisionInstancesAsync(java.util.List<java.lang.String> decisionInstanceIds, HistoricDecisionInstanceQuery query, java.lang.String deleteReason)	Deletes historic decision instances asynchronously based on query and a list of decision instances, whereby query result and list of ids will be merged.
Batch	deleteHistoricDecisionInstancesAsync(HistoricDecisionInstanceQuery query, java.lang.String deleteReason)	Deletes historic decision instances asynchronously based on query of decision instances.
void	deleteHistoricDecisionInstancesBulk(java.util.List<java.lang.String> decisionInstanceIds)	Deletes decision instances and all related historic data in bulk manner.
void	deleteHistoricProcessInstance(java.lang.String processInstanceId)	Deletes historic process instance.
void	deleteHistoricProcessInstanceIfExists(java.lang.String processInstanceId)	Deletes historic process instance.
void	deleteHistoricProcessInstances(java.util.List<java.lang.String> processInstanceIds)	Deletes historic process instances.
Batch	deleteHistoricProcessInstancesAsync(java.util.List<java.lang.String> processInstanceIds, java.lang.String deleteReason)	Deletes historic process instances asynchronously.
Batch	deleteHistoricProcessInstancesAsync(java.util.List<java.lang.String> processInstanceIds, HistoricProcessInstanceQuery query, java.lang.String deleteReason)	Deletes historic process instances asynchronously based on query and a list of process instances.
Batch	deleteHistoricProcessInstancesAsync(HistoricProcessInstanceQuery query, java.lang.String deleteReason)	Deletes historic process instances asynchronously based on query.
void	deleteHistoricProcessInstancesBulk(java.util.List<java.lang.String> processInstanceIds)	Deletes historic process instances and all related historic data in bulk manner.
void	deleteHistoricProcessInstancesIfExists(java.util.List<java.lang.String> processInstanceIds)	Deletes historic process instances.
void	deleteHistoricTaskInstance(java.lang.String taskId)	Deletes historic task instance.
void	deleteHistoricVariableInstance(java.lang.String variableInstanceId)	Deletes a historic variable instance by its id.
void	deleteHistoricVariableInstancesByProcessInstanceId(java.lang.String processInstanceId)	Deletes all historic variables and historic details (variable updates, form properties) of a process instance.
void	deleteUserOperationLogEntry(java.lang.String entryId)	Deletes a user operation log entry.
Job	findHistoryCleanupJob()	Finds history cleanup job, if present.
java.util.List<Job>	findHistoryCleanupJobs()	Finds history cleanup jobs if present.
java.lang.String	getHistoricExternalTaskLogErrorDetails(java.lang.String historicExternalTaskLogId)	Returns the full error details that occurs when the historic external task log with the given id was last executed.
java.lang.String	getHistoricJobLogExceptionStacktrace(java.lang.String historicJobLogId)	Returns the full stacktrace of the exception that occurs when the historic job log with the given id was last executed.
void	setAnnotationForOperationLogById(java.lang.String operationId, java.lang.String annotation)	Set an annotation to user operation log entries.
SetRemovalTimeSelectModeForHistoricBatchesBuilder	setRemovalTimeToHistoricBatches()	Set a removal time to historic batches and all associated historic entities using a fluent builder.
SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder	setRemovalTimeToHistoricDecisionInstances()	Set a removal time to historic decision instances and all associated historic entities using a fluent builder.
SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder	setRemovalTimeToHistoricProcessInstances()	Set a removal time to historic process instances and all associated historic entities using a fluent builder.

Methods inherited from class org.camunda.bpm.engine.impl.ServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HistoryServiceImpl

public HistoryServiceImpl()

Method Detail

createHistoricProcessInstanceQuery

public HistoricProcessInstanceQuery createHistoricProcessInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricProcessInstances.

The result of the query is empty in the following cases:

• The user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION OR
• The user has no HistoricProcessInstancePermissions.READ permission on Resources.HISTORIC_PROCESS_INSTANCE (enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true)

Specified by:

createHistoricProcessInstanceQuery in interface HistoryService

createHistoricActivityInstanceQuery

public HistoricActivityInstanceQuery createHistoricActivityInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricActivityInstances.

The result of the query is empty in the following cases:

• The user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION OR
• The user has no HistoricProcessInstancePermissions.READ permission on Resources.HISTORIC_PROCESS_INSTANCE (enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true)

Specified by:

createHistoricActivityInstanceQuery in interface HistoryService

createHistoricActivityStatisticsQuery

public HistoricActivityStatisticsQuery createHistoricActivityStatisticsQuery(java.lang.String processDefinitionId)

Description copied from interface: HistoryService

Query for the number of historic activity instances aggregated by activities of a single process definition.

The result of the query is empty when the user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION

Specified by:

createHistoricActivityStatisticsQuery in interface HistoryService

createHistoricCaseActivityStatisticsQuery

public HistoricCaseActivityStatisticsQuery createHistoricCaseActivityStatisticsQuery(java.lang.String caseDefinitionId)

Description copied from interface: HistoryService

Query for the number of historic case activity instances aggregated by case activities of a single case definition.

Specified by:

createHistoricCaseActivityStatisticsQuery in interface HistoryService

createHistoricTaskInstanceQuery

public HistoricTaskInstanceQuery createHistoricTaskInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricTaskInstances.

The result of the query is empty in the following cases:

• The user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION OR
• The user has no HistoricProcessInstancePermissions.READ permission on Resources.HISTORIC_PROCESS_INSTANCE (enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true) OR
• The user has no HistoricTaskPermissions.READ permission on Resources.HISTORIC_TASK (enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true)

Specified by:

createHistoricTaskInstanceQuery in interface HistoryService

createHistoricDetailQuery

public HistoricDetailQuery createHistoricDetailQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricDetails.

The result of the query is empty in the following cases:

• The user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION OR
• The user has no HistoricTaskPermissions.READ permission on Resources.HISTORIC_TASK (enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true) OR
• The user has no HistoricProcessInstancePermissions.READ permission on Resources.HISTORIC_PROCESS_INSTANCE (enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true) OR
• The user has no ProcessDefinitionPermissions.READ_HISTORY_VARIABLE permission on Resources.PROCESS_DEFINITION (ProcessEngineConfiguration.enforceSpecificVariablePermission must be set to true) OR
• The user has no HistoricTaskPermissions.READ_VARIABLE permission on Resources.HISTORIC_TASK (enforceSpecificVariablePermission and enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true)

Specified by:

createHistoricDetailQuery in interface HistoryService

createUserOperationLogQuery

public UserOperationLogQuery createUserOperationLogQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for UserOperationLogEntry instances.

The result of the query is empty in the following cases:

• The user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION OR
• The user has no HistoricProcessInstancePermissions.READ permission on Resources.HISTORIC_PROCESS_INSTANCE (enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true) OR
• The user has no HistoricTaskPermissions.READ permission on Resources.HISTORIC_TASK (enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true)

Specified by:

createUserOperationLogQuery in interface HistoryService

createHistoricVariableInstanceQuery

public HistoricVariableInstanceQuery createHistoricVariableInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricVariableInstances.

The result of the query is empty in the following cases:

• The user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION OR
• The user has no HistoricTaskPermissions.READ permission on Resources.HISTORIC_TASK (enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true) OR
• The user has no HistoricProcessInstancePermissions.READ permission on Resources.HISTORIC_PROCESS_INSTANCE (enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true) OR
• The user has no ProcessDefinitionPermissions.READ_HISTORY_VARIABLE permission on Resources.PROCESS_DEFINITION (ProcessEngineConfiguration.enforceSpecificVariablePermission must be set to true) OR
• The user has no HistoricTaskPermissions.READ_VARIABLE permission on Resources.HISTORIC_TASK (enforceSpecificVariablePermission and enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true)

Specified by:

createHistoricVariableInstanceQuery in interface HistoryService

createHistoricIncidentQuery

public HistoricIncidentQuery createHistoricIncidentQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for historic incidents.

The result of the query is empty in the following cases:

• The user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION OR
• The user has no HistoricProcessInstancePermissions.READ permission on Resources.HISTORIC_PROCESS_INSTANCE (enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true)

Specified by:

createHistoricIncidentQuery in interface HistoryService

createHistoricIdentityLinkLogQuery

public HistoricIdentityLinkLogQueryImpl createHistoricIdentityLinkLogQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for historic identity links.

The result of the query is empty in the following cases:

• The user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION OR
• The user has no HistoricTaskPermissions.READ permission on Resources.HISTORIC_TASK (enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true)

Specified by:

createHistoricIdentityLinkLogQuery in interface HistoryService

createHistoricCaseInstanceQuery

public HistoricCaseInstanceQuery createHistoricCaseInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricCaseInstances.

Specified by:

createHistoricCaseInstanceQuery in interface HistoryService

createHistoricCaseActivityInstanceQuery

public HistoricCaseActivityInstanceQuery createHistoricCaseActivityInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricCaseActivityInstances.

Specified by:

createHistoricCaseActivityInstanceQuery in interface HistoryService

createHistoricDecisionInstanceQuery

public HistoricDecisionInstanceQuery createHistoricDecisionInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricDecisionInstances. If the user has no Permissions.READ_HISTORY permission on Resources.DECISION_DEFINITION then the result of the query is empty.

Specified by:

createHistoricDecisionInstanceQuery in interface HistoryService

deleteHistoricTaskInstance

public void deleteHistoricTaskInstance(java.lang.String taskId)

Description copied from interface: HistoryService

Deletes historic task instance. This might be useful for tasks that are dynamically created and then completed. If the historic task instance doesn't exist, no exception is thrown and the method returns normal.

Specified by:

deleteHistoricTaskInstance in interface HistoryService

deleteHistoricProcessInstance

public void deleteHistoricProcessInstance(java.lang.String processInstanceId)

Description copied from interface: HistoryService

Deletes historic process instance. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well.

Specified by:

deleteHistoricProcessInstance in interface HistoryService

deleteHistoricProcessInstanceIfExists

public void deleteHistoricProcessInstanceIfExists(java.lang.String processInstanceId)

Description copied from interface: HistoryService

Deletes historic process instance. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well. Does not fail if a process instance was not found.

Specified by:

deleteHistoricProcessInstanceIfExists in interface HistoryService

deleteHistoricProcessInstances

public void deleteHistoricProcessInstances(java.util.List<java.lang.String> processInstanceIds)

Description copied from interface: HistoryService

Deletes historic process instances. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well.

Specified by:

deleteHistoricProcessInstances in interface HistoryService

deleteHistoricProcessInstancesIfExists

public void deleteHistoricProcessInstancesIfExists(java.util.List<java.lang.String> processInstanceIds)

Description copied from interface: HistoryService

Deletes historic process instances. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well. Does not fail if a process instance was not found.

Specified by:

deleteHistoricProcessInstancesIfExists in interface HistoryService

deleteHistoricProcessInstancesBulk

public void deleteHistoricProcessInstancesBulk(java.util.List<java.lang.String> processInstanceIds)

Description copied from interface: HistoryService

Deletes historic process instances and all related historic data in bulk manner. DELETE SQL statement will be created for each entity type. They will have list of given process instance ids in IN clause. Therefore, DB limitation for number of values in IN clause must be taken into account.

Specified by:

deleteHistoricProcessInstancesBulk in interface HistoryService

Parameters:

processInstanceIds - list of process instance ids for removal

cleanUpHistoryAsync

public Job cleanUpHistoryAsync()

Description copied from interface: HistoryService

Schedules history cleanup job at batch window start time. The job will delete historic data for finished process, decision and case instances, and batch operations taking into account ResourceDefinition.getHistoryTimeToLive(), DecisionDefinition#getHistoryTimeToLive(), CaseDefinition#getHistoryTimeToLive(), ProcessEngineConfigurationImpl.getBatchOperationHistoryTimeToLive() and ProcessEngineConfigurationImpl.getBatchOperationsForHistoryCleanup() values.

Specified by:

cleanUpHistoryAsync in interface HistoryService

Returns:

history cleanup job. NB! As of v. 7.9.0, method does not guarantee to return a job. Use HistoryService.findHistoryCleanupJobs() instead.

cleanUpHistoryAsync

public Job cleanUpHistoryAsync(boolean immediatelyDue)

Description copied from interface: HistoryService

Schedules history cleanup job at batch window start time. The job will delete historic data for finished process, decision and case instances, and batch operations taking into account ResourceDefinition.getHistoryTimeToLive(), DecisionDefinition#getHistoryTimeToLive(), CaseDefinition#getHistoryTimeToLive(), ProcessEngineConfigurationImpl.getBatchOperationHistoryTimeToLive() and ProcessEngineConfigurationImpl.getBatchOperationsForHistoryCleanup() values.

Specified by:

cleanUpHistoryAsync in interface HistoryService

Parameters:

immediatelyDue - must be true if cleanup must be scheduled at once, otherwise is will be scheduled according to configured batch window

Returns:

history cleanup job. Job id can be used to check job logs, incident etc.

findHistoryCleanupJob

public Job findHistoryCleanupJob()

Description copied from interface: HistoryService

Finds history cleanup job, if present.

Specified by:

findHistoryCleanupJob in interface HistoryService

Returns:

history cleanup job entity

findHistoryCleanupJobs

public java.util.List<Job> findHistoryCleanupJobs()

Description copied from interface: HistoryService

Finds history cleanup jobs if present.

Specified by:

findHistoryCleanupJobs in interface HistoryService

Returns:

history cleanup job entities

deleteHistoricProcessInstancesAsync

public Batch deleteHistoricProcessInstancesAsync(java.util.List<java.lang.String> processInstanceIds,
                                                 java.lang.String deleteReason)

Description copied from interface: HistoryService

Deletes historic process instances asynchronously. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well.

Specified by:

deleteHistoricProcessInstancesAsync in interface HistoryService

deleteHistoricProcessInstancesAsync

public Batch deleteHistoricProcessInstancesAsync(HistoricProcessInstanceQuery query,
                                                 java.lang.String deleteReason)

Description copied from interface: HistoryService

Deletes historic process instances asynchronously based on query. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well.

Specified by:

deleteHistoricProcessInstancesAsync in interface HistoryService

deleteHistoricProcessInstancesAsync

public Batch deleteHistoricProcessInstancesAsync(java.util.List<java.lang.String> processInstanceIds,
                                                 HistoricProcessInstanceQuery query,
                                                 java.lang.String deleteReason)

Description copied from interface: HistoryService

Deletes historic process instances asynchronously based on query and a list of process instances. Query result and list of ids will be merged. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well.

Specified by:

deleteHistoricProcessInstancesAsync in interface HistoryService

deleteUserOperationLogEntry

public void deleteUserOperationLogEntry(java.lang.String entryId)

Description copied from interface: HistoryService

Deletes a user operation log entry. Does not cascade to any related entities.

Specified by:

deleteUserOperationLogEntry in interface HistoryService

deleteHistoricCaseInstance

public void deleteHistoricCaseInstance(java.lang.String caseInstanceId)

Description copied from interface: HistoryService

Deletes historic case instance. All historic case activities, historic task and historic details are deleted as well.

Specified by:

deleteHistoricCaseInstance in interface HistoryService

deleteHistoricCaseInstancesBulk

public void deleteHistoricCaseInstancesBulk(java.util.List<java.lang.String> caseInstanceIds)

Description copied from interface: HistoryService

Deletes historic case instances and all related historic data in bulk manner. DELETE SQL statement will be created for each entity type. They will have list of given case instance ids in IN clause. Therefore, DB limitation for number of values in IN clause must be taken into account.

Specified by:

deleteHistoricCaseInstancesBulk in interface HistoryService

Parameters:

caseInstanceIds - list of case instance ids for removal

deleteHistoricDecisionInstance

public void deleteHistoricDecisionInstance(java.lang.String decisionDefinitionId)

Description copied from interface: HistoryService

Deletes historic decision instances of a decision definition. All historic decision inputs and outputs are deleted as well.

Specified by:

deleteHistoricDecisionInstance in interface HistoryService

Parameters:

decisionDefinitionId - the id of the decision definition

deleteHistoricDecisionInstancesBulk

public void deleteHistoricDecisionInstancesBulk(java.util.List<java.lang.String> decisionInstanceIds)

Description copied from interface: HistoryService

Deletes decision instances and all related historic data in bulk manner. DELETE SQL statement will be created for each entity type. They will have list of given decision instance ids in IN clause. Therefore, DB limitation for number of values in IN clause must be taken into account.

Specified by:

deleteHistoricDecisionInstancesBulk in interface HistoryService

Parameters:

decisionInstanceIds - list of decision instance ids for removal.

deleteHistoricDecisionInstanceByDefinitionId

public void deleteHistoricDecisionInstanceByDefinitionId(java.lang.String decisionDefinitionId)

Description copied from interface: HistoryService

Deletes historic decision instances of a decision definition. All historic decision inputs and outputs are deleted as well.

Specified by:

deleteHistoricDecisionInstanceByDefinitionId in interface HistoryService

Parameters:

decisionDefinitionId - the id of the decision definition

deleteHistoricDecisionInstanceByInstanceId

public void deleteHistoricDecisionInstanceByInstanceId(java.lang.String historicDecisionInstanceId)

Description copied from interface: HistoryService

Deletes historic decision instances by its id. All historic decision inputs and outputs are deleted as well.

Specified by:

deleteHistoricDecisionInstanceByInstanceId in interface HistoryService

Parameters:

historicDecisionInstanceId - the id of the historic decision instance

deleteHistoricDecisionInstancesAsync

public Batch deleteHistoricDecisionInstancesAsync(java.util.List<java.lang.String> decisionInstanceIds,
                                                  java.lang.String deleteReason)

Description copied from interface: HistoryService

Deletes historic decision instances asynchronously based on a list of decision instances.

Specified by:

deleteHistoricDecisionInstancesAsync in interface HistoryService

deleteHistoricDecisionInstancesAsync

public Batch deleteHistoricDecisionInstancesAsync(HistoricDecisionInstanceQuery query,
                                                  java.lang.String deleteReason)

Description copied from interface: HistoryService

Deletes historic decision instances asynchronously based on query of decision instances.

Specified by:

deleteHistoricDecisionInstancesAsync in interface HistoryService

deleteHistoricDecisionInstancesAsync

public Batch deleteHistoricDecisionInstancesAsync(java.util.List<java.lang.String> decisionInstanceIds,
                                                  HistoricDecisionInstanceQuery query,
                                                  java.lang.String deleteReason)

Description copied from interface: HistoryService

Deletes historic decision instances asynchronously based on query and a list of decision instances, whereby query result and list of ids will be merged.

Specified by:

deleteHistoricDecisionInstancesAsync in interface HistoryService

deleteHistoricVariableInstance

public void deleteHistoricVariableInstance(java.lang.String variableInstanceId)

Description copied from interface: HistoryService

Deletes a historic variable instance by its id. All related historic details (variable updates, form properties) are deleted as well.

Specified by:

deleteHistoricVariableInstance in interface HistoryService

Parameters:

variableInstanceId - the id of the variable instance

deleteHistoricVariableInstancesByProcessInstanceId

public void deleteHistoricVariableInstancesByProcessInstanceId(java.lang.String processInstanceId)

Description copied from interface: HistoryService

Deletes all historic variables and historic details (variable updates, form properties) of a process instance.

Specified by:

deleteHistoricVariableInstancesByProcessInstanceId in interface HistoryService

Parameters:

processInstanceId - the id of the process instance

createNativeHistoricProcessInstanceQuery

public NativeHistoricProcessInstanceQuery createNativeHistoricProcessInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricProcessInstances via SQL

Specified by:

createNativeHistoricProcessInstanceQuery in interface HistoryService

createNativeHistoricTaskInstanceQuery

public NativeHistoricTaskInstanceQuery createNativeHistoricTaskInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricTaskInstances via SQL

Specified by:

createNativeHistoricTaskInstanceQuery in interface HistoryService

createNativeHistoricActivityInstanceQuery

public NativeHistoricActivityInstanceQuery createNativeHistoricActivityInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricActivityInstances via SQL

Specified by:

createNativeHistoricActivityInstanceQuery in interface HistoryService

createNativeHistoricCaseInstanceQuery

public NativeHistoricCaseInstanceQuery createNativeHistoricCaseInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricCaseInstances via SQL

Specified by:

createNativeHistoricCaseInstanceQuery in interface HistoryService

createNativeHistoricCaseActivityInstanceQuery

public NativeHistoricCaseActivityInstanceQuery createNativeHistoricCaseActivityInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricCaseActivityInstances via SQL

Specified by:

createNativeHistoricCaseActivityInstanceQuery in interface HistoryService

createNativeHistoricDecisionInstanceQuery

public NativeHistoricDecisionInstanceQuery createNativeHistoricDecisionInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricDecisionInstances via SQL

Specified by:

createNativeHistoricDecisionInstanceQuery in interface HistoryService

createNativeHistoricVariableInstanceQuery

public NativeHistoricVariableInstanceQuery createNativeHistoricVariableInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricVariableInstances via SQL

Specified by:

createNativeHistoricVariableInstanceQuery in interface HistoryService

createHistoricJobLogQuery

public HistoricJobLogQuery createHistoricJobLogQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for historic job logs.

The result of the query is empty in the following cases:

• The user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION OR
• The user has no HistoricProcessInstancePermissions.READ permission on Resources.HISTORIC_PROCESS_INSTANCE (enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true)

Specified by:

createHistoricJobLogQuery in interface HistoryService

getHistoricJobLogExceptionStacktrace

public java.lang.String getHistoricJobLogExceptionStacktrace(java.lang.String historicJobLogId)

Description copied from interface: HistoryService

Returns the full stacktrace of the exception that occurs when the historic job log with the given id was last executed. Returns null when the historic job log has no exception stacktrace.

Specified by:

getHistoricJobLogExceptionStacktrace in interface HistoryService

Parameters:

historicJobLogId - id of the historic job log, cannot be null.

createHistoricProcessInstanceReport

public HistoricProcessInstanceReport createHistoricProcessInstanceReport()

Description copied from interface: HistoryService

Creates a new programmatic query to create a historic process instance report.

Specified by:

createHistoricProcessInstanceReport in interface HistoryService

createHistoricTaskInstanceReport

public HistoricTaskInstanceReport createHistoricTaskInstanceReport()

Description copied from interface: HistoryService

Creates a new programmatic query to create a historic task instance report.

Subsequent builder methods throw AuthorizationException when the user has no Permissions.READ_HISTORY permission on any Resources.PROCESS_DEFINITION.

Specified by:

createHistoricTaskInstanceReport in interface HistoryService

createCleanableHistoricProcessInstanceReport

public CleanableHistoricProcessInstanceReport createCleanableHistoricProcessInstanceReport()

Description copied from interface: HistoryService

Creates a new programmatic query to create a cleanable historic process instance report.

Specified by:

createCleanableHistoricProcessInstanceReport in interface HistoryService

createCleanableHistoricDecisionInstanceReport

public CleanableHistoricDecisionInstanceReport createCleanableHistoricDecisionInstanceReport()

Description copied from interface: HistoryService

Creates a new programmatic query to create a cleanable historic decision instance report.

Specified by:

createCleanableHistoricDecisionInstanceReport in interface HistoryService

createCleanableHistoricCaseInstanceReport

public CleanableHistoricCaseInstanceReport createCleanableHistoricCaseInstanceReport()

Description copied from interface: HistoryService

Creates a new programmatic query to create a cleanable historic case instance report.

Specified by:

createCleanableHistoricCaseInstanceReport in interface HistoryService

createCleanableHistoricBatchReport

public CleanableHistoricBatchReport createCleanableHistoricBatchReport()

Description copied from interface: HistoryService

Creates a new programmatic query to create a cleanable historic batch report.

Specified by:

createCleanableHistoricBatchReport in interface HistoryService

createHistoricBatchQuery

public HistoricBatchQuery createHistoricBatchQuery()

Description copied from interface: HistoryService

Creates a query to search for HistoricBatch instances.

Specified by:

createHistoricBatchQuery in interface HistoryService

deleteHistoricBatch

public void deleteHistoricBatch(java.lang.String batchId)

Description copied from interface: HistoryService

Deletes a historic batch instance. All corresponding historic job logs are deleted as well;

Specified by:

deleteHistoricBatch in interface HistoryService

createHistoricDecisionInstanceStatisticsQuery

public HistoricDecisionInstanceStatisticsQuery createHistoricDecisionInstanceStatisticsQuery(java.lang.String decisionRequirementsDefinitionId)

Description copied from interface: HistoryService

Query for the statistics of DRD evaluation.

Specified by:

createHistoricDecisionInstanceStatisticsQuery in interface HistoryService

Parameters:

decisionRequirementsDefinitionId - - id of decision requirement definition

createHistoricExternalTaskLogQuery

public HistoricExternalTaskLogQuery createHistoricExternalTaskLogQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for historic external task logs.

The result of the query is empty in the following cases:

• The user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION OR
• The user has no HistoricProcessInstancePermissions.READ permission on Resources.HISTORIC_PROCESS_INSTANCE (enableHistoricInstancePermissions in ProcessEngineConfigurationImpl must be set to true)

Specified by:

createHistoricExternalTaskLogQuery in interface HistoryService

getHistoricExternalTaskLogErrorDetails

public java.lang.String getHistoricExternalTaskLogErrorDetails(java.lang.String historicExternalTaskLogId)

Description copied from interface: HistoryService

Returns the full error details that occurs when the historic external task log with the given id was last executed. Returns null when the historic external task log contains no error details.

Specified by:

getHistoricExternalTaskLogErrorDetails in interface HistoryService

Parameters:

historicExternalTaskLogId - id of the historic external task log, cannot be null.

setRemovalTimeToHistoricProcessInstances

public SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder setRemovalTimeToHistoricProcessInstances()

Description copied from interface: HistoryService

Set a removal time to historic process instances and all associated historic entities using a fluent builder.

Historic process instances can be specified by passing a query to SetRemovalTimeToHistoricProcessInstancesBuilder.byQuery(HistoricProcessInstanceQuery).

An absolute time can be specified via SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder.absoluteRemovalTime(Date). Pass null to clear the removal time.

As an alternative, the removal time can also be calculated via SetRemovalTimeSelectModeForHistoricProcessInstancesBuilder.calculatedRemovalTime() based on the configured time to live values.

To additionally take those historic process instances into account that are part of a hierarchy, enable the flag SetRemovalTimeToHistoricProcessInstancesBuilder.hierarchical()

To create the batch and complete the configuration chain, call SetRemovalTimeToHistoricProcessInstancesBuilder.executeAsync().

Specified by:

setRemovalTimeToHistoricProcessInstances in interface HistoryService

setRemovalTimeToHistoricDecisionInstances

public SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder setRemovalTimeToHistoricDecisionInstances()

Description copied from interface: HistoryService

Set a removal time to historic decision instances and all associated historic entities using a fluent builder.

Historic decision instances can be specified by passing a query to SetRemovalTimeToHistoricDecisionInstancesBuilder.byQuery(HistoricDecisionInstanceQuery).

An absolute time can be specified via SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder.absoluteRemovalTime(Date). Pass null to clear the removal time.

As an alternative, the removal time can also be calculated via SetRemovalTimeSelectModeForHistoricDecisionInstancesBuilder.calculatedRemovalTime() based on the configured time to live values.

To additionally take those historic decision instances into account that are part of a hierarchy, enable the flag SetRemovalTimeToHistoricProcessInstancesBuilder.hierarchical()

To create the batch and complete the configuration chain, call SetRemovalTimeToHistoricDecisionInstancesBuilder.executeAsync().

Specified by:

setRemovalTimeToHistoricDecisionInstances in interface HistoryService

setRemovalTimeToHistoricBatches

public SetRemovalTimeSelectModeForHistoricBatchesBuilder setRemovalTimeToHistoricBatches()

Description copied from interface: HistoryService

Set a removal time to historic batches and all associated historic entities using a fluent builder.

Historic batches can be specified by passing a query to SetRemovalTimeToHistoricBatchesBuilder.byQuery(HistoricBatchQuery).

An absolute time can be specified via SetRemovalTimeSelectModeForHistoricBatchesBuilder.absoluteRemovalTime(Date). Pass null to clear the removal time.

As an alternative, the removal time can also be calculated via SetRemovalTimeSelectModeForHistoricBatchesBuilder.calculatedRemovalTime() based on the configured time to live values.

To create the batch and complete the configuration chain, call SetRemovalTimeToHistoricBatchesBuilder.executeAsync().

Specified by:

setRemovalTimeToHistoricBatches in interface HistoryService

setAnnotationForOperationLogById

public void setAnnotationForOperationLogById(java.lang.String operationId,
                                             java.lang.String annotation)

Description copied from interface: HistoryService

Set an annotation to user operation log entries.

Specified by:

setAnnotationForOperationLogById in interface HistoryService

Parameters:

operationId - of the user operation log entries that are updated

annotation - that is set to the user operation log entries

clearAnnotationForOperationLogById

public void clearAnnotationForOperationLogById(java.lang.String operationId)

Description copied from interface: HistoryService

Clear the annotation for user operation log entries.

Specified by:

clearAnnotationForOperationLogById in interface HistoryService

Parameters:

operationId - of the user operation log entries that are updated