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 and Description
HistoryServiceImpl()

Method Summary

Modifier and Type	Method and 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.
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(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(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(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(String batchId) Deletes a historic batch instance.
void	deleteHistoricCaseInstance(String caseInstanceId) Deletes historic case instance.
void	deleteHistoricCaseInstancesBulk(List<String> caseInstanceIds) Deletes historic case instances and all related historic data in bulk manner.
void	deleteHistoricDecisionInstance(String decisionDefinitionId) Deletes historic decision instances of a decision definition.
void	deleteHistoricDecisionInstanceByDefinitionId(String decisionDefinitionId) Deletes historic decision instances of a decision definition.
void	deleteHistoricDecisionInstanceByInstanceId(String historicDecisionInstanceId) Deletes historic decision instances by its id.
Batch	deleteHistoricDecisionInstancesAsync(HistoricDecisionInstanceQuery query, String deleteReason) Deletes historic decision instances asynchronously based on query of decision instances.
Batch	deleteHistoricDecisionInstancesAsync(List<String> decisionInstanceIds, HistoricDecisionInstanceQuery query, 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(List<String> decisionInstanceIds, String deleteReason) Deletes historic decision instances asynchronously based on a list of decision instances.
void	deleteHistoricDecisionInstancesBulk(List<String> decisionInstanceIds) Deletes decision instances and all related historic data in bulk manner.
void	deleteHistoricProcessInstance(String processInstanceId) Deletes historic process instance.
void	deleteHistoricProcessInstanceIfExists(String processInstanceId) Deletes historic process instance.
void	deleteHistoricProcessInstances(List<String> processInstanceIds) Deletes historic process instances.
Batch	deleteHistoricProcessInstancesAsync(HistoricProcessInstanceQuery query, String deleteReason) Deletes historic process instances asynchronously based on query.
Batch	deleteHistoricProcessInstancesAsync(List<String> processInstanceIds, HistoricProcessInstanceQuery query, String deleteReason) Deletes historic process instances asynchronously based on query and a list of process instances.
Batch	deleteHistoricProcessInstancesAsync(List<String> processInstanceIds, String deleteReason) Deletes historic process instances asynchronously.
void	deleteHistoricProcessInstancesBulk(List<String> processInstanceIds) Deletes historic process instances and all related historic data in bulk manner.
void	deleteHistoricProcessInstancesIfExists(List<String> processInstanceIds) Deletes historic process instances.
void	deleteHistoricTaskInstance(String taskId) Deletes historic task instance.
void	deleteHistoricVariableInstance(String variableInstanceId) Deletes a historic variable instance by its id.
void	deleteHistoricVariableInstancesByProcessInstanceId(String processInstanceId) Deletes all historic variables and historic details (variable updates, form properties) of a process instance.
void	deleteUserOperationLogEntry(String entryId) Deletes a user operation log entry.
Job	findHistoryCleanupJob() Finds history cleanup job, if present.
List<Job>	findHistoryCleanupJobs() Finds history cleanup job if present.
String	getHistoricExternalTaskLogErrorDetails(String historicExternalTaskLogId) Returns the full error details that occurs when the historic external task log with the given id was last executed.
String	getHistoricJobLogExceptionStacktrace(String historicJobLogId) Returns the full stacktrace of the exception that occurs when the historic job log with the given id was last executed.
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.

Specified by:

createHistoricProcessInstanceQuery in interface HistoryService

createHistoricActivityInstanceQuery

public HistoricActivityInstanceQuery createHistoricActivityInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricActivityInstances.

Specified by:

createHistoricActivityInstanceQuery in interface HistoryService

createHistoricActivityStatisticsQuery

public HistoricActivityStatisticsQuery createHistoricActivityStatisticsQuery(String processDefinitionId)

Description copied from interface: HistoryService

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

Specified by:

createHistoricActivityStatisticsQuery in interface HistoryService

createHistoricCaseActivityStatisticsQuery

public HistoricCaseActivityStatisticsQuery createHistoricCaseActivityStatisticsQuery(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.

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:

if the user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION or the user has no ProcessDefinitionPermissions.READ_HISTORY_VARIABLE permission on Resources.PROCESS_DEFINITION in case ProcessEngineConfiguration.enforceSpecificVariablePermission is enabled.

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.

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:

if the user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION or the user has no ProcessDefinitionPermissions.READ_HISTORY_VARIABLE permission on Resources.PROCESS_DEFINITION in case ProcessEngineConfiguration.enforceSpecificVariablePermission is enabled.