Interface HvlBpmnHistoryService
- All Known Implementing Classes:
HvlBpmnHistoryServiceImpl
@Validated
public interface HvlBpmnHistoryService
This service provides operational and retrieve methods.
-
Method Summary
Modifier and TypeMethodDescriptionorg.flowable.batch.api.BatchQueryCreate batch cleaning query batch query.org.flowable.engine.history.HistoricActivityInstanceQueryCreates a new programmatic query to search forHistoricActivityInstances.org.flowable.engine.history.HistoricDetailQueryCreates a new programmatic query to search forHistoricDetails.org.flowable.engine.history.HistoricProcessInstanceQueryCreate historic process instance cleaning query historic process instance query.org.flowable.engine.history.HistoricProcessInstanceQueryCreates a new programmatic query to search forHistoricProcessInstances.org.flowable.task.api.history.HistoricTaskInstanceQueryCreates a new programmatic query to search forHistoricTaskInstances.org.flowable.task.api.history.HistoricTaskLogEntryBuilderCreate new task log entry builder to the log task event without predefined values from the taskorg.flowable.task.api.history.HistoricTaskLogEntryBuildercreateHistoricTaskLogEntryBuilder(@NotNull org.flowable.task.api.TaskInfo task) Create new task log entry builder to the log task eventorg.flowable.task.api.history.HistoricTaskLogEntryQueryReturns a newHistoricTaskLogEntryQuerythat can be used to dynamically query task log entries.org.flowable.variable.api.history.HistoricVariableInstanceQueryCreates a new programmatic query to search forHistoricVariableInstances.org.flowable.engine.history.NativeHistoricActivityInstanceQuerycreates a native query to search forHistoricActivityInstances via SQLorg.flowable.engine.history.NativeHistoricDetailQueryReturns a newNativeQueryfor process definitions.org.flowable.engine.history.NativeHistoricProcessInstanceQuerycreates a native query to search forHistoricProcessInstances via SQLorg.flowable.task.service.history.NativeHistoricTaskInstanceQuerycreates a native query to search forHistoricTaskInstances via SQLorg.flowable.task.api.history.NativeHistoricTaskLogEntryQueryReturns a newNativeHistoricTaskLogEntryQueryforHistoricTaskLogEntrys.org.flowable.variable.api.history.NativeHistoricVariableInstanceQueryReturns a newNativeQueryfor process definitions.org.flowable.engine.history.ProcessInstanceHistoryLogQuerycreateProcessInstanceHistoryLogQuery(@NotBlank String processInstanceId) Allows to retrieve theProcessInstanceHistoryLogfor one process instance.voiddeleteHistoricProcessInstance(@NotBlank String processInstanceId) Deletes historic process instance.voiddeleteHistoricTaskInstance(@NotBlank String taskId) Deletes historic task instance.voiddeleteHistoricTaskLogEntry(long logNumber) Deletes user task log entry by its log numbervoidDeletes historic identity links, detail info, variable data and entity links for removed process instancesvoidDeletes historic task and activity data for removed process instancesList<org.flowable.identitylink.api.history.HistoricIdentityLink> getHistoricIdentityLinksForProcessInstance(@NotBlank String processInstanceId) Retrieves theHistoricIdentityLinks associated with the given process instance.List<org.flowable.identitylink.api.history.HistoricIdentityLink> getHistoricIdentityLinksForTask(@NotBlank String taskId) Retrieves theHistoricIdentityLinks associated with the given task.
-
Method Details
-
createHistoricProcessInstanceQuery
org.flowable.engine.history.HistoricProcessInstanceQuery createHistoricProcessInstanceQuery()Creates a new programmatic query to search forHistoricProcessInstances.- Returns:
- the historic process instance query
-
createHistoricActivityInstanceQuery
org.flowable.engine.history.HistoricActivityInstanceQuery createHistoricActivityInstanceQuery()Creates a new programmatic query to search forHistoricActivityInstances.- Returns:
- the historic activity instance query
-
createHistoricTaskInstanceQuery
org.flowable.task.api.history.HistoricTaskInstanceQuery createHistoricTaskInstanceQuery()Creates a new programmatic query to search forHistoricTaskInstances.- Returns:
- the historic task instance query
-
createHistoricDetailQuery
org.flowable.engine.history.HistoricDetailQuery createHistoricDetailQuery()Creates a new programmatic query to search forHistoricDetails.- Returns:
- the historic detail query
-
createNativeHistoricDetailQuery
org.flowable.engine.history.NativeHistoricDetailQuery createNativeHistoricDetailQuery()Returns a newNativeQueryfor process definitions.- Returns:
- the native historic detail query
-
createHistoricVariableInstanceQuery
org.flowable.variable.api.history.HistoricVariableInstanceQuery createHistoricVariableInstanceQuery()Creates a new programmatic query to search forHistoricVariableInstances.- Returns:
- the historic variable instance query
-
createNativeHistoricVariableInstanceQuery
org.flowable.variable.api.history.NativeHistoricVariableInstanceQuery createNativeHistoricVariableInstanceQuery()Returns a newNativeQueryfor process definitions.- Returns:
- the native historic variable instance query
-
deleteHistoricTaskInstance
Deletes historic task instance. This might be useful for tasks that aredynamically createdand thencompleted. If the historic task instance doesn't exist, no exception is thrown and the method returns normal.- Parameters:
taskId- the task id
-
deleteHistoricProcessInstance
Deletes historic process instance. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well.- Parameters:
processInstanceId- the process instance id
-
deleteTaskAndActivityDataOfRemovedHistoricProcessInstances
void deleteTaskAndActivityDataOfRemovedHistoricProcessInstances()Deletes historic task and activity data for removed process instances -
deleteRelatedDataOfRemovedHistoricProcessInstances
void deleteRelatedDataOfRemovedHistoricProcessInstances()Deletes historic identity links, detail info, variable data and entity links for removed process instances -
createNativeHistoricProcessInstanceQuery
org.flowable.engine.history.NativeHistoricProcessInstanceQuery createNativeHistoricProcessInstanceQuery()creates a native query to search forHistoricProcessInstances via SQL- Returns:
- the native historic process instance query
-
createNativeHistoricTaskInstanceQuery
org.flowable.task.service.history.NativeHistoricTaskInstanceQuery createNativeHistoricTaskInstanceQuery()creates a native query to search forHistoricTaskInstances via SQL- Returns:
- the native historic task instance query
-
createNativeHistoricActivityInstanceQuery
org.flowable.engine.history.NativeHistoricActivityInstanceQuery createNativeHistoricActivityInstanceQuery()creates a native query to search forHistoricActivityInstances via SQL- Returns:
- the native historic activity instance query
-
getHistoricIdentityLinksForTask
List<org.flowable.identitylink.api.history.HistoricIdentityLink> getHistoricIdentityLinksForTask(@NotBlank @NotBlank String taskId) Retrieves theHistoricIdentityLinks associated with the given task. Such anIdentityLinkinforms how a certain identity (eg. group or user) is associated with a certain task (eg. as candidate, assignee, etc.), even if the task is completed as opposed toIdentityLinks which only exist for active tasks.- Parameters:
taskId- the task id- Returns:
- the historic identity links for task
-
getHistoricIdentityLinksForProcessInstance
List<org.flowable.identitylink.api.history.HistoricIdentityLink> getHistoricIdentityLinksForProcessInstance(@NotBlank @NotBlank String processInstanceId) Retrieves theHistoricIdentityLinks associated with the given process instance. Such anIdentityLinkinforms how a certain identity (eg. group or user) is associated with a certain process instance, even if the instance is completed as opposed toIdentityLinks which only exist for active instances.- Parameters:
processInstanceId- the process instance id- Returns:
- the historic identity links for process instance
-
createProcessInstanceHistoryLogQuery
org.flowable.engine.history.ProcessInstanceHistoryLogQuery createProcessInstanceHistoryLogQuery(@NotBlank @NotBlank String processInstanceId) Allows to retrieve theProcessInstanceHistoryLogfor one process instance.- Parameters:
processInstanceId- the process instance id- Returns:
- the process instance history log query
-
deleteHistoricTaskLogEntry
void deleteHistoricTaskLogEntry(long logNumber) Deletes user task log entry by its log number- Parameters:
logNumber- user task log entry identifier
-
createHistoricTaskLogEntryBuilder
org.flowable.task.api.history.HistoricTaskLogEntryBuilder createHistoricTaskLogEntryBuilder(@NotNull @NotNull org.flowable.task.api.TaskInfo task) Create new task log entry builder to the log task event- Parameters:
task- to which is log related to- Returns:
- the historic task log entry builder
-
createHistoricTaskLogEntryBuilder
org.flowable.task.api.history.HistoricTaskLogEntryBuilder createHistoricTaskLogEntryBuilder()Create new task log entry builder to the log task event without predefined values from the task- Returns:
- the historic task log entry builder
-
createHistoricTaskLogEntryQuery
org.flowable.task.api.history.HistoricTaskLogEntryQuery createHistoricTaskLogEntryQuery()Returns a newHistoricTaskLogEntryQuerythat can be used to dynamically query task log entries.- Returns:
- the historic task log entry query
-
createNativeHistoricTaskLogEntryQuery
org.flowable.task.api.history.NativeHistoricTaskLogEntryQuery createNativeHistoricTaskLogEntryQuery()Returns a newNativeHistoricTaskLogEntryQueryforHistoricTaskLogEntrys.- Returns:
- the native historic task log entry query
-
createHistoricProcessInstanceCleaningQuery
org.flowable.engine.history.HistoricProcessInstanceQuery createHistoricProcessInstanceCleaningQuery()Create historic process instance cleaning query historic process instance query.- Returns:
- the historic process instance query
-
createBatchCleaningQuery
org.flowable.batch.api.BatchQuery createBatchCleaningQuery()Create batch cleaning query batch query.- Returns:
- the batch query
-