HistoryService (camunda BPM Javadocs 7.4.11-ee)

All Known Implementing Classes:

HistoryServiceImpl
```
public interface HistoryService
```
Service exposing information about ongoing and past process instances. This is different from the runtime information in the sense that this runtime information only contains the actual runtime state at any given moment and it is optimized for runtime process execution performance. The history information is optimized for easy querying and remains permanent in the persistent storage.

Author:

Christian Stettler, Tom Baeyens, Joram Barrez

Method Summary

Methods
Modifier and Type	Method and Description
`HistoricActivityInstanceQuery`	`createHistoricActivityInstanceQuery()` Creates a new programmatic query to search for `HistoricActivityInstance`s.
`HistoricActivityStatisticsQuery`	`createHistoricActivityStatisticsQuery(String processDefinitionId)` Query for the number of historic activity instances aggregated by activities of a single process definition.
`HistoricCaseActivityInstanceQuery`	`createHistoricCaseActivityInstanceQuery()` Creates a new programmatic query to search for `HistoricCaseActivityInstance`s.
`HistoricCaseInstanceQuery`	`createHistoricCaseInstanceQuery()` Creates a new programmatic query to search for `HistoricCaseInstance`s.
`HistoricDecisionInstanceQuery`	`createHistoricDecisionInstanceQuery()` Creates a new programmatic query to search for `HistoricDecisionInstance`s.
`HistoricDetailQuery`	`createHistoricDetailQuery()` Creates a new programmatic query to search for `HistoricDetail`s.
`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 `HistoricProcessInstance`s.
`HistoricTaskInstanceQuery`	`createHistoricTaskInstanceQuery()` Creates a new programmatic query to search for `HistoricTaskInstance`s.
`HistoricVariableInstanceQuery`	`createHistoricVariableInstanceQuery()` Creates a new programmatic query to search for `HistoricVariableInstance`s.
`NativeHistoricActivityInstanceQuery`	`createNativeHistoricActivityInstanceQuery()` creates a native query to search for `HistoricActivityInstance`s via SQL
`NativeHistoricCaseActivityInstanceQuery`	`createNativeHistoricCaseActivityInstanceQuery()` creates a native query to search for `HistoricCaseActivityInstance`s via SQL
`NativeHistoricCaseInstanceQuery`	`createNativeHistoricCaseInstanceQuery()` creates a native query to search for `HistoricCaseInstance`s via SQL
`NativeHistoricDecisionInstanceQuery`	`createNativeHistoricDecisionInstanceQuery()` creates a native query to search for `HistoricDecisionInstance`s via SQL
`NativeHistoricProcessInstanceQuery`	`createNativeHistoricProcessInstanceQuery()` creates a native query to search for `HistoricProcessInstance`s via SQL
`NativeHistoricTaskInstanceQuery`	`createNativeHistoricTaskInstanceQuery()` creates a native query to search for `HistoricTaskInstance`s via SQL
`UserOperationLogQuery`	`createUserOperationLogQuery()` Creates a new programmatic query to search for `UserOperationLogEntry` instances.
`void`	`deleteHistoricCaseInstance(String caseInstanceId)` Deletes historic case instance.
`void`	`deleteHistoricDecisionInstance(String decisionDefinitionId)` Deletes historic decision instances of a decision definition.
`void`	`deleteHistoricProcessInstance(String processInstanceId)` Deletes historic process instance.
`void`	`deleteHistoricTaskInstance(String taskId)` Deletes historic task instance.
`void`	`deleteUserOperationLogEntry(String entryId)` Deletes a user operation log entry.
`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.

- Method Detail
  - createHistoricProcessInstanceQuery
```
HistoricProcessInstanceQuery createHistoricProcessInstanceQuery()
```
    Creates a new programmatic query to search for HistoricProcessInstances.
  - createHistoricActivityInstanceQuery
```
HistoricActivityInstanceQuery createHistoricActivityInstanceQuery()
```
    Creates a new programmatic query to search for HistoricActivityInstances.
  - createHistoricActivityStatisticsQuery
```
HistoricActivityStatisticsQuery createHistoricActivityStatisticsQuery(String processDefinitionId)
```
    Query for the number of historic activity instances aggregated by activities of a single process definition.
  - createHistoricTaskInstanceQuery
```
HistoricTaskInstanceQuery createHistoricTaskInstanceQuery()
```
    Creates a new programmatic query to search for HistoricTaskInstances.
  - createHistoricDetailQuery
```
HistoricDetailQuery createHistoricDetailQuery()
```
    Creates a new programmatic query to search for HistoricDetails.
  - createHistoricVariableInstanceQuery
```
HistoricVariableInstanceQuery createHistoricVariableInstanceQuery()
```
    Creates a new programmatic query to search for HistoricVariableInstances.
  - createUserOperationLogQuery
```
UserOperationLogQuery createUserOperationLogQuery()
```
    Creates a new programmatic query to search for UserOperationLogEntry instances.
  - createHistoricIncidentQuery
```
HistoricIncidentQuery createHistoricIncidentQuery()
```
    Creates a new programmatic query to search for historic incidents.
  - createHistoricCaseInstanceQuery
```
HistoricCaseInstanceQuery createHistoricCaseInstanceQuery()
```
    Creates a new programmatic query to search for HistoricCaseInstances.
  - createHistoricCaseActivityInstanceQuery
```
HistoricCaseActivityInstanceQuery createHistoricCaseActivityInstanceQuery()
```
    Creates a new programmatic query to search for HistoricCaseActivityInstances.
  - createHistoricDecisionInstanceQuery
```
HistoricDecisionInstanceQuery createHistoricDecisionInstanceQuery()
```
    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.
  - deleteHistoricTaskInstance
```
void deleteHistoricTaskInstance(String taskId)
```
    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.
    
    Throws:
    
    AuthorizationException - If the user has no Permissions.DELETE_HISTORY permission on Resources.PROCESS_DEFINITION.
  - deleteHistoricProcessInstance
```
void deleteHistoricProcessInstance(String processInstanceId)
```
    Deletes historic process instance. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well.
    
    Throws:
    
    AuthorizationException - If the user has no Permissions.DELETE_HISTORY permission on Resources.PROCESS_DEFINITION.
  - deleteUserOperationLogEntry
```
void deleteUserOperationLogEntry(String entryId)
```
    Deletes a user operation log entry. Does not cascade to any related entities.
    
    Throws:
    
    AuthorizationException - If the user has no Permissions.DELETE_HISTORY permission on Resources.PROCESS_DEFINITION.
  - deleteHistoricCaseInstance
```
void deleteHistoricCaseInstance(String caseInstanceId)
```
    Deletes historic case instance. All historic case activities, historic task and historic details are deleted as well.
  - deleteHistoricDecisionInstance
```
void deleteHistoricDecisionInstance(String decisionDefinitionId)
```
    Deletes historic decision instances of a decision definition. All historic decision inputs and outputs are deleted as well.
    
    Parameters:
    decisionDefinitionId - the id of the decision definition
    
    Throws:
    
    AuthorizationException - If the user has no Permissions.DELETE_HISTORY permission on Resources.DECISION_DEFINITION.
  - createNativeHistoricProcessInstanceQuery
```
NativeHistoricProcessInstanceQuery createNativeHistoricProcessInstanceQuery()
```
    creates a native query to search for HistoricProcessInstances via SQL
  - createNativeHistoricTaskInstanceQuery
```
NativeHistoricTaskInstanceQuery createNativeHistoricTaskInstanceQuery()
```
    creates a native query to search for HistoricTaskInstances via SQL
  - createNativeHistoricActivityInstanceQuery
```
NativeHistoricActivityInstanceQuery createNativeHistoricActivityInstanceQuery()
```
    creates a native query to search for HistoricActivityInstances via SQL
  - createNativeHistoricCaseInstanceQuery
```
NativeHistoricCaseInstanceQuery createNativeHistoricCaseInstanceQuery()
```
    creates a native query to search for HistoricCaseInstances via SQL
  - createNativeHistoricCaseActivityInstanceQuery
```
NativeHistoricCaseActivityInstanceQuery createNativeHistoricCaseActivityInstanceQuery()
```
    creates a native query to search for HistoricCaseActivityInstances via SQL
  - createNativeHistoricDecisionInstanceQuery
```
NativeHistoricDecisionInstanceQuery createNativeHistoricDecisionInstanceQuery()
```
    creates a native query to search for HistoricDecisionInstances via SQL
  - createHistoricJobLogQuery
```
HistoricJobLogQuery createHistoricJobLogQuery()
```
    Creates a new programmatic query to search for historic job logs.
    
    Since:
    
    7.3
  - getHistoricJobLogExceptionStacktrace
```
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. Returns null when the historic job log has no exception stacktrace.
    
    Parameters:
    historicJobLogId - id of the historic job log, cannot be null.
    
    Throws:
    
    ProcessEngineException - when no historic job log exists with the given id.
    
    AuthorizationException - If the user has no Permissions.READ_HISTORY permission on Resources.PROCESS_DEFINITION.
    Since:
    
    7.3

Interface HistoryService

Method Summary

Method Detail

createHistoricProcessInstanceQuery

createHistoricActivityInstanceQuery

createHistoricActivityStatisticsQuery

createHistoricTaskInstanceQuery

createHistoricDetailQuery

createHistoricVariableInstanceQuery

createUserOperationLogQuery

createHistoricIncidentQuery

createHistoricCaseInstanceQuery

createHistoricCaseActivityInstanceQuery

createHistoricDecisionInstanceQuery

deleteHistoricTaskInstance

deleteHistoricProcessInstance

deleteUserOperationLogEntry

deleteHistoricCaseInstance

deleteHistoricDecisionInstance

createNativeHistoricProcessInstanceQuery

createNativeHistoricTaskInstanceQuery

createNativeHistoricActivityInstanceQuery

createNativeHistoricCaseInstanceQuery

createNativeHistoricCaseActivityInstanceQuery

createNativeHistoricDecisionInstanceQuery

createHistoricJobLogQuery

getHistoricJobLogExceptionStacktrace