public interface HistoryService
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
HistoricActivityInstance s. |
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
HistoricCaseActivityInstance s. |
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
HistoricCaseInstance s. |
HistoricDecisionInstanceQuery |
createHistoricDecisionInstanceQuery()
Creates a new programmatic query to search for
HistoricDecisionInstance s. |
HistoricDecisionInstanceStatisticsQuery |
createHistoricDecisionInstanceStatisticsQuery(String decisionRequirementsDefinitionId)
Query for the statistics of DRD evaluation.
|
HistoricDetailQuery |
createHistoricDetailQuery()
Creates a new programmatic query to search for
HistoricDetail s. |
HistoricExternalTaskLogQuery |
createHistoricExternalTaskLogQuery()
Creates a new programmatic query to search for
historic external task logs . |
HistoricIdentityLinkLogQuery |
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
HistoricProcessInstance s. |
HistoricProcessInstanceReport |
createHistoricProcessInstanceReport()
Creates a new programmatic query to create a historic process instance report.
|
HistoricTaskInstanceQuery |
createHistoricTaskInstanceQuery()
Creates a new programmatic query to search for
HistoricTaskInstance s. |
HistoricTaskInstanceReport |
createHistoricTaskInstanceReport()
Creates a new programmatic query to create a historic task instance report.
|
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 |
NativeHistoricVariableInstanceQuery |
createNativeHistoricVariableInstanceQuery()
creates a native query to search for
HistoricVariableInstance s via SQL |
UserOperationLogQuery |
createUserOperationLogQuery()
Creates a new programmatic query to search for
UserOperationLogEntry instances. |
void |
deleteHistoricBatch(String id)
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)
Deprecated.
Note that this method name is not expressive enough, because it is also possible to delete the historic
decision instance by the instance id. Therefore use
deleteHistoricDecisionInstanceByDefinitionId(java.lang.String) instead
to delete the historic decision instance by the definition id. |
void |
deleteHistoricDecisionInstanceByDefinitionId(String decisionDefinitionId)
Deletes historic decision instances of a decision definition.
|
void |
deleteHistoricDecisionInstanceByInstanceId(String historicDecisionInstanceId)
Deletes historic decision instances by its id.
|
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 |
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 |
deleteHistoricTaskInstance(String taskId)
Deletes historic task instance.
|
void |
deleteUserOperationLogEntry(String entryId)
Deletes a user operation log entry.
|
Job |
findHistoryCleanupJob()
Deprecated.
As of v. 7.9.0, because there can be more than one history cleanup job at once, use
findHistoryCleanupJobs() instead. |
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.
|
HistoricProcessInstanceQuery createHistoricProcessInstanceQuery()
HistoricProcessInstance
s.HistoricActivityInstanceQuery createHistoricActivityInstanceQuery()
HistoricActivityInstance
s.HistoricActivityStatisticsQuery createHistoricActivityStatisticsQuery(String processDefinitionId)
HistoricCaseActivityStatisticsQuery createHistoricCaseActivityStatisticsQuery(String caseDefinitionId)
HistoricTaskInstanceQuery createHistoricTaskInstanceQuery()
HistoricTaskInstance
s.HistoricDetailQuery createHistoricDetailQuery()
HistoricDetail
s.HistoricVariableInstanceQuery createHistoricVariableInstanceQuery()
HistoricVariableInstance
s.UserOperationLogQuery createUserOperationLogQuery()
UserOperationLogEntry
instances.HistoricIncidentQuery createHistoricIncidentQuery()
historic incidents
.HistoricIdentityLinkLogQuery createHistoricIdentityLinkLogQuery()
historic identity links
.HistoricCaseInstanceQuery createHistoricCaseInstanceQuery()
HistoricCaseInstance
s.HistoricCaseActivityInstanceQuery createHistoricCaseActivityInstanceQuery()
HistoricCaseActivityInstance
s.HistoricDecisionInstanceQuery createHistoricDecisionInstanceQuery()
HistoricDecisionInstance
s.
If the user has no Permissions.READ_HISTORY
permission on Resources.DECISION_DEFINITION
then the result of the query is empty.void deleteHistoricTaskInstance(String taskId)
dynamically created
and then completed
.
If the historic task instance doesn't exist, no exception is thrown and the
method returns normal.AuthorizationException
- If the user has no Permissions.DELETE_HISTORY
permission on Resources.PROCESS_DEFINITION
.void deleteHistoricProcessInstance(String processInstanceId)
AuthorizationException
- If the user has no Permissions.DELETE_HISTORY
permission on Resources.PROCESS_DEFINITION
.void deleteHistoricProcessInstances(List<String> processInstanceIds)
BadUserRequestException
- when no process instances are found with the given ids or ids are null.AuthorizationException
- If the user has no Permissions.DELETE_HISTORY
permission on Resources.PROCESS_DEFINITION
.void deleteHistoricProcessInstancesBulk(List<String> processInstanceIds)
processInstanceIds
- list of process instance ids for removalBadUserRequestException
- when no process instances are found with the given ids or ids are null or when some of the process instances are not finished yetAuthorizationException
- If the user has no Permissions.DELETE_HISTORY
permission on Resources.PROCESS_DEFINITION
.Job cleanUpHistoryAsync()
ResourceDefinition.getHistoryTimeToLive()
,
DecisionDefinition#getHistoryTimeToLive()
, CaseDefinition#getHistoryTimeToLive()
, ProcessEngineConfigurationImpl#getBatchOperationHistoryTimeToLive()
and ProcessEngineConfigurationImpl#getBatchOperationsForHistoryCleanup()
values.findHistoryCleanupJobs()
instead.AuthorizationException
- If the user has no Permissions.DELETE_HISTORY
permission on Resources.PROCESS_DEFINITION
Job cleanUpHistoryAsync(boolean immediatelyDue)
ResourceDefinition.getHistoryTimeToLive()
,
DecisionDefinition#getHistoryTimeToLive()
, CaseDefinition#getHistoryTimeToLive()
, ProcessEngineConfigurationImpl#getBatchOperationHistoryTimeToLive()
and ProcessEngineConfigurationImpl#getBatchOperationsForHistoryCleanup()
values.immediatelyDue
- must be true if cleanup must be scheduled at once, otherwise is will be scheduled according to configured batch windowAuthorizationException
- If the user has no Permissions.DELETE_HISTORY
permission on Resources.PROCESS_DEFINITION
@Deprecated Job findHistoryCleanupJob()
findHistoryCleanupJobs()
instead.List<Job> findHistoryCleanupJobs()
Batch deleteHistoricProcessInstancesAsync(List<String> processInstanceIds, String deleteReason)
BadUserRequestException
- when no process instances is found with the given ids or ids are null.AuthorizationException
- If the user has no Permissions.CREATE
permission on Resources.BATCH
.Batch deleteHistoricProcessInstancesAsync(HistoricProcessInstanceQuery query, String deleteReason)
BadUserRequestException
- when no process instances is found with the given ids or ids are null.AuthorizationException
- If the user has no Permissions.CREATE
permission on Resources.BATCH
.Batch deleteHistoricProcessInstancesAsync(List<String> processInstanceIds, HistoricProcessInstanceQuery query, String deleteReason)
BadUserRequestException
- when no process instances is found with the given ids or ids are null.AuthorizationException
- If the user has no Permissions.CREATE
permission on Resources.BATCH
.void deleteUserOperationLogEntry(String entryId)
AuthorizationException
- If the user has no Permissions.DELETE_HISTORY
permission on Resources.PROCESS_DEFINITION
.void deleteHistoricCaseInstance(String caseInstanceId)
void deleteHistoricCaseInstancesBulk(List<String> caseInstanceIds)
caseInstanceIds
- list of case instance ids for removal@Deprecated void deleteHistoricDecisionInstance(String decisionDefinitionId)
deleteHistoricDecisionInstanceByDefinitionId(java.lang.String)
instead
to delete the historic decision instance by the definition id.decisionDefinitionId
- the id of the decision definitionAuthorizationException
- If the user has no Permissions.DELETE_HISTORY
permission on Resources.DECISION_DEFINITION
.void deleteHistoricDecisionInstancesBulk(List<String> decisionInstanceIds)
decisionInstanceIds
- list of decision instance ids for removal.AuthorizationException
- If the user has no Permissions.DELETE_HISTORY
permission on Resources.DECISION_DEFINITION
.void deleteHistoricDecisionInstanceByDefinitionId(String decisionDefinitionId)
decisionDefinitionId
- the id of the decision definitionAuthorizationException
- If the user has no Permissions.DELETE_HISTORY
permission on Resources.DECISION_DEFINITION
.void deleteHistoricDecisionInstanceByInstanceId(String historicDecisionInstanceId)
historicDecisionInstanceId
- the id of the historic decision instanceAuthorizationException
- If the user has no Permissions.DELETE_HISTORY
permission on Resources.DECISION_DEFINITION
.NativeHistoricProcessInstanceQuery createNativeHistoricProcessInstanceQuery()
HistoricProcessInstance
s via SQLNativeHistoricTaskInstanceQuery createNativeHistoricTaskInstanceQuery()
HistoricTaskInstance
s via SQLNativeHistoricActivityInstanceQuery createNativeHistoricActivityInstanceQuery()
HistoricActivityInstance
s via SQLNativeHistoricCaseInstanceQuery createNativeHistoricCaseInstanceQuery()
HistoricCaseInstance
s via SQLNativeHistoricCaseActivityInstanceQuery createNativeHistoricCaseActivityInstanceQuery()
HistoricCaseActivityInstance
s via SQLNativeHistoricDecisionInstanceQuery createNativeHistoricDecisionInstanceQuery()
HistoricDecisionInstance
s via SQLNativeHistoricVariableInstanceQuery createNativeHistoricVariableInstanceQuery()
HistoricVariableInstance
s via SQLHistoricJobLogQuery createHistoricJobLogQuery()
historic job logs
.String getHistoricJobLogExceptionStacktrace(String historicJobLogId)
historicJobLogId
- id of the historic job log, cannot be null.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
.HistoricProcessInstanceReport createHistoricProcessInstanceReport()
HistoricTaskInstanceReport createHistoricTaskInstanceReport()
CleanableHistoricProcessInstanceReport createCleanableHistoricProcessInstanceReport()
CleanableHistoricDecisionInstanceReport createCleanableHistoricDecisionInstanceReport()
CleanableHistoricCaseInstanceReport createCleanableHistoricCaseInstanceReport()
CleanableHistoricBatchReport createCleanableHistoricBatchReport()
HistoricBatchQuery createHistoricBatchQuery()
HistoricBatch
instances.void deleteHistoricBatch(String id)
AuthorizationException
- If the user has no Permissions.DELETE
permission on Resources.BATCH
HistoricDecisionInstanceStatisticsQuery createHistoricDecisionInstanceStatisticsQuery(String decisionRequirementsDefinitionId)
decisionRequirementsDefinitionId
- - id of decision requirement definitionHistoricExternalTaskLogQuery createHistoricExternalTaskLogQuery()
historic external task logs
.String getHistoricExternalTaskLogErrorDetails(String historicExternalTaskLogId)
historicExternalTaskLogId
- id of the historic external task log, cannot be null.ProcessEngineException
- when no historic external task log exists with the given id.AuthorizationException
- If the user has no Permissions.READ_HISTORY
permission on Resources.PROCESS_DEFINITION
.Copyright © 2019. All rights reserved.