Interface HistoryService

  • 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 Detail

      • createHistoricTaskInstanceQuery

        org.flowable.task.api.history.HistoricTaskInstanceQuery createHistoricTaskInstanceQuery()
        Creates a new programmatic query to search for HistoricTaskInstances.
      • createNativeHistoricDetailQuery

        NativeHistoricDetailQuery createNativeHistoricDetailQuery()
        Returns a new NativeQuery for process definitions.
      • createHistoricVariableInstanceQuery

        org.flowable.variable.api.history.HistoricVariableInstanceQuery createHistoricVariableInstanceQuery()
        Creates a new programmatic query to search for HistoricVariableInstances.
      • createNativeHistoricVariableInstanceQuery

        org.flowable.variable.api.history.NativeHistoricVariableInstanceQuery createNativeHistoricVariableInstanceQuery()
        Returns a new NativeQuery for process definitions.
      • 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.
      • 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.
      • 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
      • createNativeHistoricTaskInstanceQuery

        org.flowable.task.service.history.NativeHistoricTaskInstanceQuery createNativeHistoricTaskInstanceQuery()
        creates a native query to search for HistoricTaskInstances via SQL
      • getHistoricIdentityLinksForTask

        List<org.flowable.identitylink.api.history.HistoricIdentityLink> getHistoricIdentityLinksForTask​(String taskId)
        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.
      • getHistoricIdentityLinksForProcessInstance

        List<org.flowable.identitylink.api.history.HistoricIdentityLink> getHistoricIdentityLinksForProcessInstance​(String processInstanceId)
        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.
      • getHistoricEntityLinkChildrenForProcessInstance

        List<org.flowable.entitylink.api.history.HistoricEntityLink> getHistoricEntityLinkChildrenForProcessInstance​(String processInstanceId)
        Retrieves the HistoricEntityLinks associated with the given process instance.
      • getHistoricEntityLinkChildrenWithSameRootAsProcessInstance

        List<org.flowable.entitylink.api.history.HistoricEntityLink> getHistoricEntityLinkChildrenWithSameRootAsProcessInstance​(String processInstanceId)
        Retrieves all the HistoricEntityLinks associated with same root as the given process instance.
      • getHistoricEntityLinkChildrenForTask

        List<org.flowable.entitylink.api.history.HistoricEntityLink> getHistoricEntityLinkChildrenForTask​(String taskId)
        Retrieves the HistoricEntityLinks associated with the given task.
      • getHistoricEntityLinkParentsForProcessInstance

        List<org.flowable.entitylink.api.history.HistoricEntityLink> getHistoricEntityLinkParentsForProcessInstance​(String processInstanceId)
        Retrieves the HistoricEntityLinks where the given process instance is referenced.
      • getHistoricEntityLinkParentsForTask

        List<org.flowable.entitylink.api.history.HistoricEntityLink> getHistoricEntityLinkParentsForTask​(String taskId)
        Retrieves the HistoricEntityLinks where the given task is referenced.
      • 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​(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
      • 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
      • createHistoricTaskLogEntryQuery

        org.flowable.task.api.history.HistoricTaskLogEntryQuery createHistoricTaskLogEntryQuery()
        Returns a new HistoricTaskLogEntryQuery that can be used to dynamically query task log entries.
      • createNativeHistoricTaskLogEntryQuery

        org.flowable.task.api.history.NativeHistoricTaskLogEntryQuery createNativeHistoricTaskLogEntryQuery()
        Returns a new NativeHistoricTaskLogEntryQuery for HistoricTaskLogEntrys.