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.BatchQuery
Create batch cleaning query batch query.org.flowable.engine.history.HistoricActivityInstanceQuery
Creates a new programmatic query to search forHistoricActivityInstance
s.org.flowable.engine.history.HistoricDetailQuery
Creates a new programmatic query to search forHistoricDetail
s.org.flowable.engine.history.HistoricProcessInstanceQuery
Create historic process instance cleaning query historic process instance query.org.flowable.engine.history.HistoricProcessInstanceQuery
Creates a new programmatic query to search forHistoricProcessInstance
s.org.flowable.task.api.history.HistoricTaskInstanceQuery
Creates a new programmatic query to search forHistoricTaskInstance
s.org.flowable.task.api.history.HistoricTaskLogEntryBuilder
Create new task log entry builder to the log task event without predefined values from the taskorg.flowable.task.api.history.HistoricTaskLogEntryBuilder
createHistoricTaskLogEntryBuilder
(@NotNull org.flowable.task.api.TaskInfo task) Create new task log entry builder to the log task eventorg.flowable.task.api.history.HistoricTaskLogEntryQuery
Returns a newHistoricTaskLogEntryQuery
that can be used to dynamically query task log entries.org.flowable.variable.api.history.HistoricVariableInstanceQuery
Creates a new programmatic query to search forHistoricVariableInstance
s.org.flowable.engine.history.NativeHistoricActivityInstanceQuery
creates a native query to search forHistoricActivityInstance
s via SQLorg.flowable.engine.history.NativeHistoricDetailQuery
Returns a newNativeQuery
for process definitions.org.flowable.engine.history.NativeHistoricProcessInstanceQuery
creates a native query to search forHistoricProcessInstance
s via SQLorg.flowable.task.service.history.NativeHistoricTaskInstanceQuery
creates a native query to search forHistoricTaskInstance
s via SQLorg.flowable.task.api.history.NativeHistoricTaskLogEntryQuery
Returns a newNativeHistoricTaskLogEntryQuery
forHistoricTaskLogEntry
s.org.flowable.variable.api.history.NativeHistoricVariableInstanceQuery
Returns a newNativeQuery
for process definitions.org.flowable.engine.history.ProcessInstanceHistoryLogQuery
createProcessInstanceHistoryLogQuery
(@NotBlank String processInstanceId) Allows to retrieve theProcessInstanceHistoryLog
for one process instance.void
deleteHistoricProcessInstance
(@NotBlank String processInstanceId) Deletes historic process instance.void
deleteHistoricTaskInstance
(@NotBlank String taskId) Deletes historic task instance.void
deleteHistoricTaskLogEntry
(long logNumber) Deletes user task log entry by its log numbervoid
Deletes historic identity links, detail info, variable data and entity links for removed process instancesvoid
Deletes historic task and activity data for removed process instancesList
<org.flowable.identitylink.api.history.HistoricIdentityLink> getHistoricIdentityLinksForProcessInstance
(@NotBlank String processInstanceId) Retrieves theHistoricIdentityLink
s associated with the given process instance.List
<org.flowable.identitylink.api.history.HistoricIdentityLink> getHistoricIdentityLinksForTask
(@NotBlank String taskId) Retrieves theHistoricIdentityLink
s associated with the given task.
-
Method Details
-
createHistoricProcessInstanceQuery
org.flowable.engine.history.HistoricProcessInstanceQuery createHistoricProcessInstanceQuery()Creates a new programmatic query to search forHistoricProcessInstance
s.- Returns:
- the historic process instance query
-
createHistoricActivityInstanceQuery
org.flowable.engine.history.HistoricActivityInstanceQuery createHistoricActivityInstanceQuery()Creates a new programmatic query to search forHistoricActivityInstance
s.- Returns:
- the historic activity instance query
-
createHistoricTaskInstanceQuery
org.flowable.task.api.history.HistoricTaskInstanceQuery createHistoricTaskInstanceQuery()Creates a new programmatic query to search forHistoricTaskInstance
s.- Returns:
- the historic task instance query
-
createHistoricDetailQuery
org.flowable.engine.history.HistoricDetailQuery createHistoricDetailQuery()Creates a new programmatic query to search forHistoricDetail
s.- Returns:
- the historic detail query
-
createNativeHistoricDetailQuery
org.flowable.engine.history.NativeHistoricDetailQuery createNativeHistoricDetailQuery()Returns a newNativeQuery
for process definitions.- Returns:
- the native historic detail query
-
createHistoricVariableInstanceQuery
org.flowable.variable.api.history.HistoricVariableInstanceQuery createHistoricVariableInstanceQuery()Creates a new programmatic query to search forHistoricVariableInstance
s.- Returns:
- the historic variable instance query
-
createNativeHistoricVariableInstanceQuery
org.flowable.variable.api.history.NativeHistoricVariableInstanceQuery createNativeHistoricVariableInstanceQuery()Returns a newNativeQuery
for process definitions.- Returns:
- the native historic variable instance query
-
deleteHistoricTaskInstance
Deletes historic task instance. This might be useful for tasks that aredynamically created
and 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 forHistoricProcessInstance
s via SQL- Returns:
- the native historic process instance query
-
createNativeHistoricTaskInstanceQuery
org.flowable.task.service.history.NativeHistoricTaskInstanceQuery createNativeHistoricTaskInstanceQuery()creates a native query to search forHistoricTaskInstance
s via SQL- Returns:
- the native historic task instance query
-
createNativeHistoricActivityInstanceQuery
org.flowable.engine.history.NativeHistoricActivityInstanceQuery createNativeHistoricActivityInstanceQuery()creates a native query to search forHistoricActivityInstance
s via SQL- Returns:
- the native historic activity instance query
-
getHistoricIdentityLinksForTask
List<org.flowable.identitylink.api.history.HistoricIdentityLink> getHistoricIdentityLinksForTask(@NotBlank @NotBlank String taskId) Retrieves theHistoricIdentityLink
s associated with the given task. Such anIdentityLink
informs 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 toIdentityLink
s 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 theHistoricIdentityLink
s associated with the given process instance. Such anIdentityLink
informs how a certain identity (eg. group or user) is associated with a certain process instance, even if the instance is completed as opposed toIdentityLink
s 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 theProcessInstanceHistoryLog
for 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 newHistoricTaskLogEntryQuery
that 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 newNativeHistoricTaskLogEntryQuery
forHistoricTaskLogEntry
s.- 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
-