Package org.flowable.engine.impl

Class HistoryServiceImpl

java.lang.Object

org.flowable.common.engine.impl.service.CommonServiceImpl<C>

org.flowable.common.engine.impl.service.CommonEngineServiceImpl<ProcessEngineConfigurationImpl>

org.flowable.engine.impl.HistoryServiceImpl

All Implemented Interfaces:

HistoryService

public class HistoryServiceImpl
extends CommonEngineServiceImpl<ProcessEngineConfigurationImpl>
implements HistoryService

Author:

Tom Baeyens, Bernd Ruecker (camunda), Christian Stettler

Field Summary

Fields inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

commandExecutor

Fields inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

configuration

Constructor Summary

Constructors

Constructor	Description
HistoryServiceImpl(ProcessEngineConfigurationImpl processEngineConfiguration)

Method Summary

Modifier and Type	Method	Description
void	bulkDeleteHistoricProcessInstances(Collection<String> instanceIds)	Performs a bulk delete with the provided process instance ids.
HistoricActivityInstanceQuery	createHistoricActivityInstanceQuery()	Creates a new programmatic query to search for HistoricActivityInstances.
HistoricDetailQuery	createHistoricDetailQuery()	Creates a new programmatic query to search for HistoricDetails.
HistoricProcessInstanceQuery	createHistoricProcessInstanceQuery()	Creates a new programmatic query to search for HistoricProcessInstances.
org.flowable.task.api.history.HistoricTaskInstanceQuery	createHistoricTaskInstanceQuery()	Creates a new programmatic query to search for HistoricTaskInstances.
org.flowable.task.api.history.HistoricTaskLogEntryBuilder	createHistoricTaskLogEntryBuilder()	Create new task log entry builder to the log task event without predefined values from the task
org.flowable.task.api.history.HistoricTaskLogEntryBuilder	createHistoricTaskLogEntryBuilder(org.flowable.task.api.TaskInfo task)	Create new task log entry builder to the log task event
org.flowable.task.api.history.HistoricTaskLogEntryQuery	createHistoricTaskLogEntryQuery()	Returns a new HistoricTaskLogEntryQuery that can be used to dynamically query task log entries.
org.flowable.variable.api.history.HistoricVariableInstanceQuery	createHistoricVariableInstanceQuery()	Creates a new programmatic query to search for HistoricVariableInstances.
NativeHistoricActivityInstanceQuery	createNativeHistoricActivityInstanceQuery()	creates a native query to search for HistoricActivityInstances via SQL
NativeHistoricDetailQuery	createNativeHistoricDetailQuery()	Returns a new NativeQuery for process definitions.
NativeHistoricProcessInstanceQuery	createNativeHistoricProcessInstanceQuery()	creates a native query to search for HistoricProcessInstances via SQL
NativeHistoricTaskInstanceQuery	createNativeHistoricTaskInstanceQuery()	creates a native query to search for HistoricTaskInstances via SQL
org.flowable.task.api.history.NativeHistoricTaskLogEntryQuery	createNativeHistoricTaskLogEntryQuery()	Returns a new NativeHistoricTaskLogEntryQuery for HistoricTaskLogEntrys.
org.flowable.variable.api.history.NativeHistoricVariableInstanceQuery	createNativeHistoricVariableInstanceQuery()	Returns a new NativeQuery for process definitions.
ProcessInstanceHistoryLogQuery	createProcessInstanceHistoryLogQuery(String processInstanceId)	Allows to retrieve the ProcessInstanceHistoryLog for one process instance.
void	deleteHistoricProcessInstance(String processInstanceId)	Deletes historic process instance.
void	deleteHistoricTaskInstance(String taskId)	Deletes historic task instance.
void	deleteHistoricTaskLogEntry(long logNumber)	Deletes user task log entry by its log number
void	deleteRelatedDataOfRemovedHistoricProcessInstances()	Deletes historic identity links, detail info, variable data and entity links for removed process instances
void	deleteTaskAndActivityDataOfRemovedHistoricProcessInstances()	Deletes historic task and activity data for removed process instances
List<org.flowable.entitylink.api.history.HistoricEntityLink>	getHistoricEntityLinkChildrenForProcessInstance(String processInstanceId)	Retrieves the HistoricEntityLinks associated with the given process instance.
List<org.flowable.entitylink.api.history.HistoricEntityLink>	getHistoricEntityLinkChildrenForTask(String taskId)	Retrieves the HistoricEntityLinks associated with the given task.
List<org.flowable.entitylink.api.history.HistoricEntityLink>	getHistoricEntityLinkChildrenWithSameRootAsProcessInstance(String processInstanceId)	Retrieves all the HistoricEntityLinks associated with same root as the given process instance.
List<org.flowable.entitylink.api.history.HistoricEntityLink>	getHistoricEntityLinkParentsForProcessInstance(String processInstanceId)	Retrieves the HistoricEntityLinks where the given process instance is referenced.
List<org.flowable.entitylink.api.history.HistoricEntityLink>	getHistoricEntityLinkParentsForTask(String taskId)	Retrieves the HistoricEntityLinks where the given task is referenced.
List<org.flowable.identitylink.api.history.HistoricIdentityLink>	getHistoricIdentityLinksForProcessInstance(String processInstanceId)	Retrieves the HistoricIdentityLinks associated with the given process instance.
List<org.flowable.identitylink.api.history.HistoricIdentityLink>	getHistoricIdentityLinksForTask(String taskId)	Retrieves the HistoricIdentityLinks associated with the given task.

Methods inherited from class org.flowable.common.engine.impl.service.CommonEngineServiceImpl

getCommandExecutor, setCommandExecutor

Methods inherited from class org.flowable.common.engine.impl.service.CommonServiceImpl

getConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HistoryServiceImpl

public HistoryServiceImpl(ProcessEngineConfigurationImpl processEngineConfiguration)

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

createHistoricTaskInstanceQuery

public org.flowable.task.api.history.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.

Specified by:

createHistoricDetailQuery in interface HistoryService

createNativeHistoricDetailQuery

public NativeHistoricDetailQuery createNativeHistoricDetailQuery()

Description copied from interface: HistoryService

Returns a new NativeQuery for process definitions.

Specified by:

createNativeHistoricDetailQuery in interface HistoryService

createHistoricVariableInstanceQuery

public org.flowable.variable.api.history.HistoricVariableInstanceQuery createHistoricVariableInstanceQuery()

Description copied from interface: HistoryService

Creates a new programmatic query to search for HistoricVariableInstances.

Specified by:

createHistoricVariableInstanceQuery in interface HistoryService

createNativeHistoricVariableInstanceQuery

public org.flowable.variable.api.history.NativeHistoricVariableInstanceQuery createNativeHistoricVariableInstanceQuery()

Description copied from interface: HistoryService

Returns a new NativeQuery for process definitions.

Specified by:

createNativeHistoricVariableInstanceQuery in interface HistoryService

deleteHistoricTaskInstance

public void deleteHistoricTaskInstance(String taskId)

Description copied from interface: HistoryService

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.

Specified by:

deleteHistoricTaskInstance in interface HistoryService

deleteHistoricProcessInstance

public void deleteHistoricProcessInstance(String processInstanceId)

Description copied from interface: HistoryService

Deletes historic process instance. All historic activities, historic task and historic details (variable updates, form properties) are deleted as well.

Specified by:

deleteHistoricProcessInstance in interface HistoryService

bulkDeleteHistoricProcessInstances

public void bulkDeleteHistoricProcessInstances(Collection<String> instanceIds)

Description copied from interface: HistoryService

Performs a bulk delete with the provided process instance ids. All historic activities, historic tasks and historic details (variable updates, form properties) are deleted as well.

Specified by:

bulkDeleteHistoricProcessInstances in interface HistoryService

deleteTaskAndActivityDataOfRemovedHistoricProcessInstances

public void deleteTaskAndActivityDataOfRemovedHistoricProcessInstances()

Description copied from interface: HistoryService

Deletes historic task and activity data for removed process instances

Specified by:

deleteTaskAndActivityDataOfRemovedHistoricProcessInstances in interface HistoryService

deleteRelatedDataOfRemovedHistoricProcessInstances

public void deleteRelatedDataOfRemovedHistoricProcessInstances()

Description copied from interface: HistoryService

Deletes historic identity links, detail info, variable data and entity links for removed process instances

Specified by:

deleteRelatedDataOfRemovedHistoricProcessInstances in interface HistoryService

createNativeHistoricProcessInstanceQuery

public NativeHistoricProcessInstanceQuery createNativeHistoricProcessInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricProcessInstances via SQL

Specified by:

createNativeHistoricProcessInstanceQuery in interface HistoryService

createNativeHistoricTaskInstanceQuery

public NativeHistoricTaskInstanceQuery createNativeHistoricTaskInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricTaskInstances via SQL

Specified by:

createNativeHistoricTaskInstanceQuery in interface HistoryService

createNativeHistoricActivityInstanceQuery

public NativeHistoricActivityInstanceQuery createNativeHistoricActivityInstanceQuery()

Description copied from interface: HistoryService

creates a native query to search for HistoricActivityInstances via SQL

Specified by:

createNativeHistoricActivityInstanceQuery in interface HistoryService

getHistoricIdentityLinksForProcessInstance

public List<org.flowable.identitylink.api.history.HistoricIdentityLink> getHistoricIdentityLinksForProcessInstance(String processInstanceId)

Description copied from interface: HistoryService

Retrieves the HistoricIdentityLinks associated with the given process instance. Such an IdentityLink informs how a certain identity (eg. group or user) is associated with a certain process instance, even if the instance is completed as opposed to IdentityLinks which only exist for active instances.

Specified by:

getHistoricIdentityLinksForProcessInstance in interface HistoryService

getHistoricIdentityLinksForTask

public List<org.flowable.identitylink.api.history.HistoricIdentityLink> getHistoricIdentityLinksForTask(String taskId)

Description copied from interface: HistoryService

Retrieves the HistoricIdentityLinks associated with the given task. Such an IdentityLink 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 to IdentityLinks which only exist for active tasks.

Specified by:

getHistoricIdentityLinksForTask in interface HistoryService

getHistoricEntityLinkChildrenForProcessInstance

public List<org.flowable.entitylink.api.history.HistoricEntityLink> getHistoricEntityLinkChildrenForProcessInstance(String processInstanceId)

Description copied from interface: HistoryService

Retrieves the HistoricEntityLinks associated with the given process instance.

Specified by:

getHistoricEntityLinkChildrenForProcessInstance in interface HistoryService

getHistoricEntityLinkChildrenWithSameRootAsProcessInstance

public List<org.flowable.entitylink.api.history.HistoricEntityLink> getHistoricEntityLinkChildrenWithSameRootAsProcessInstance(String processInstanceId)

Description copied from interface: HistoryService

Retrieves all the HistoricEntityLinks associated with same root as the given process instance.

Specified by:

getHistoricEntityLinkChildrenWithSameRootAsProcessInstance in interface HistoryService

getHistoricEntityLinkChildrenForTask

public List<org.flowable.entitylink.api.history.HistoricEntityLink> getHistoricEntityLinkChildrenForTask(String taskId)

Description copied from interface: HistoryService

Retrieves the HistoricEntityLinks associated with the given task.

Specified by:

getHistoricEntityLinkChildrenForTask in interface HistoryService

getHistoricEntityLinkParentsForProcessInstance

public List<org.flowable.entitylink.api.history.HistoricEntityLink> getHistoricEntityLinkParentsForProcessInstance(String processInstanceId)

Description copied from interface: HistoryService

Retrieves the HistoricEntityLinks where the given process instance is referenced.

Specified by:

getHistoricEntityLinkParentsForProcessInstance in interface HistoryService

getHistoricEntityLinkParentsForTask

public List<org.flowable.entitylink.api.history.HistoricEntityLink> getHistoricEntityLinkParentsForTask(String taskId)

Description copied from interface: HistoryService

Retrieves the HistoricEntityLinks where the given task is referenced.

Specified by:

getHistoricEntityLinkParentsForTask in interface HistoryService

createProcessInstanceHistoryLogQuery

public ProcessInstanceHistoryLogQuery createProcessInstanceHistoryLogQuery(String processInstanceId)

Description copied from interface: HistoryService

Allows to retrieve the ProcessInstanceHistoryLog for one process instance.

Specified by:

createProcessInstanceHistoryLogQuery in interface HistoryService

deleteHistoricTaskLogEntry

public void deleteHistoricTaskLogEntry(long logNumber)

Description copied from interface: HistoryService

Deletes user task log entry by its log number

Specified by:

deleteHistoricTaskLogEntry in interface HistoryService

Parameters:

logNumber - user task log entry identifier

createHistoricTaskLogEntryBuilder

public org.flowable.task.api.history.HistoricTaskLogEntryBuilder createHistoricTaskLogEntryBuilder(org.flowable.task.api.TaskInfo task)

Description copied from interface: HistoryService

Create new task log entry builder to the log task event

Specified by:

createHistoricTaskLogEntryBuilder in interface HistoryService

Parameters:

task - to which is log related to

createHistoricTaskLogEntryBuilder

public org.flowable.task.api.history.HistoricTaskLogEntryBuilder createHistoricTaskLogEntryBuilder()

Description copied from interface: HistoryService

Create new task log entry builder to the log task event without predefined values from the task

Specified by:

createHistoricTaskLogEntryBuilder in interface HistoryService

createHistoricTaskLogEntryQuery

public org.flowable.task.api.history.HistoricTaskLogEntryQuery createHistoricTaskLogEntryQuery()

Description copied from interface: HistoryService

Returns a new HistoricTaskLogEntryQuery that can be used to dynamically query task log entries.

Specified by:

createHistoricTaskLogEntryQuery in interface HistoryService

createNativeHistoricTaskLogEntryQuery

public org.flowable.task.api.history.NativeHistoricTaskLogEntryQuery createNativeHistoricTaskLogEntryQuery()

Description copied from interface: HistoryService

Returns a new NativeHistoricTaskLogEntryQuery for HistoricTaskLogEntrys.

Specified by:

createNativeHistoricTaskLogEntryQuery in interface HistoryService