Package org.flowable.engine.impl.history

Interface HistoryManager

All Known Implementing Classes:
AbstractHistoryManager, CompositeHistoryManager, DefaultHistoryManager
public interface HistoryManager

  • Method Details

    • isHistoryLevelAtLeast

      boolean isHistoryLevelAtLeast(HistoryLevel level)
      Returns:
      true, if the configured history-level is equal to OR set to a higher value than the given level.

    • isHistoryLevelAtLeast

      boolean isHistoryLevelAtLeast(HistoryLevel level, String processDefinitionId)
      Returns:
      true, if the configured process definition history-level is equal to OR set to a higher value than the given level.

    • isHistoryEnabled

      boolean isHistoryEnabled()
      Returns:
      true, if history-level is configured to level other than "none".

    • isHistoryEnabled

      boolean isHistoryEnabled(String processDefinitionId)
      Returns:
      true, if process definition history-level is configured to level other than "none".

    • recordProcessInstanceEnd

      void recordProcessInstanceEnd(ExecutionEntity processInstance, String deleteReason, String activityId, Date endTime)
      Record a process-instance ended. Updates the historic process instance if activity history is enabled.

    • recordProcessInstanceStart

      void recordProcessInstanceStart(ExecutionEntity processInstance)
      Record a process-instance started and record start-event if activity history is enabled.

    • recordProcessInstanceNameChange

      void recordProcessInstanceNameChange(ExecutionEntity processInstanceExecution, String newName)
      Record a process-instance name change.

    • recordProcessInstanceDeleted

      void recordProcessInstanceDeleted(String processInstanceId, String processDefinitionId, String processTenantId)
      Deletes a historic process instance and all historic data included

    • recordDeleteHistoricProcessInstancesByProcessDefinitionId

      void recordDeleteHistoricProcessInstancesByProcessDefinitionId(String processDefinitionId)
      Deletes historic process instances for a provided process definition id

    • recordBulkDeleteProcessInstances

      void recordBulkDeleteProcessInstances(Collection<String> processInstanceIds)
      Bulk delete historic process instances by id

    • recordActivityStart

      void recordActivityStart(ActivityInstance activityInstance)
      Record the start of an activity, if activity history is enabled.
      Parameters:
      activityInstance - activity instance template

    • recordActivityEnd

      void recordActivityEnd(ActivityInstance activityInstance)
      Record the end of an activity, if activity history is enabled.
      Parameters:
      activityInstance - activity instance template

    • findHistoricActivityInstance

      HistoricActivityInstanceEntity findHistoricActivityInstance(ExecutionEntity execution, boolean validateEndTimeNull)
      Finds the HistoricActivityInstanceEntity that is active in the given execution.

    • recordProcessDefinitionChange

      void recordProcessDefinitionChange(String processInstanceId, String processDefinitionId)
      Record a change of the process-definition id of a process instance, if activity history is enabled.

    • recordTaskCreated

      void recordTaskCreated(TaskEntity task, ExecutionEntity execution)
      Record the creation of a task, if audit history is enabled.

    • recordTaskEnd

      void recordTaskEnd(TaskEntity task, ExecutionEntity execution, String userId, String deleteReason, Date endTime)
      Record task as ended, if audit history is enabled.

    • recordTaskInfoChange

      void recordTaskInfoChange(TaskEntity taskEntity, String activityInstanceId, Date changeTime)
      Record task name change, if audit history is enabled.

    • recordHistoricTaskDeleted

      void recordHistoricTaskDeleted(HistoricTaskInstance task)
      Record historic task deleted, if audit history is enabled.

    • recordVariableCreate

      void recordVariableCreate(VariableInstanceEntity variable, Date createTime)
      Record a variable has been created, if audit history is enabled.

    • recordHistoricDetailVariableCreate

      void recordHistoricDetailVariableCreate(VariableInstanceEntity variable, ExecutionEntity sourceActivityExecution, boolean useActivityId, String activityInstanceId, Date createTime)
      Record a variable has been created, if audit history is enabled.

    • recordVariableUpdate

      void recordVariableUpdate(VariableInstanceEntity variable, Date updateTime)
      Record a variable has been updated, if audit history is enabled.

    • recordVariableRemoved

      void recordVariableRemoved(VariableInstanceEntity variable)
      Record a variable has been deleted, if audit history is enabled.

    • createIdentityLinkComment

      void createIdentityLinkComment(TaskEntity task, String userId, String groupId, String type, boolean create)
      Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.

    • createUserIdentityLinkComment

      void createUserIdentityLinkComment(TaskEntity task, String userId, String type, boolean create)
      Creates a new comment to indicate a new user IdentityLink has been created or deleted, if history is enabled.

    • createGroupIdentityLinkComment

      void createGroupIdentityLinkComment(TaskEntity task, String groupId, String type, boolean create)
      Creates a new comment to indicate a new group IdentityLink has been created or deleted, if history is enabled.

    • createIdentityLinkComment

      void createIdentityLinkComment(TaskEntity task, String userId, String groupId, String type, boolean create, boolean forceNullUserId)
      Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.

    • createUserIdentityLinkComment

      void createUserIdentityLinkComment(TaskEntity task, String userId, String type, boolean create, boolean forceNullUserId)
      Creates a new comment to indicate a new user IdentityLink has been created or deleted, if history is enabled.

    • createProcessInstanceIdentityLinkComment

      void createProcessInstanceIdentityLinkComment(ExecutionEntity processInstance, String userId, String groupId, String type, boolean create)
      Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.

    • createProcessInstanceIdentityLinkComment

      void createProcessInstanceIdentityLinkComment(ExecutionEntity processInstance, String userId, String groupId, String type, boolean create, boolean forceNullUserId)
      Creates a new comment to indicate a new IdentityLink has been created or deleted, if history is enabled.

    • createAttachmentComment

      void createAttachmentComment(TaskEntity task, ExecutionEntity processInstance, String attachmentName, boolean create)
      Creates a new comment to indicate a new attachment has been created or deleted, if history is enabled.

    • recordFormPropertiesSubmitted

      void recordFormPropertiesSubmitted(ExecutionEntity processInstance, Map<String,String> properties, String taskId, Date createTime)
      Report form properties submitted, if audit history is enabled.

    • recordIdentityLinkCreated

      void recordIdentityLinkCreated(IdentityLinkEntity identityLink)
      Record the creation of a new IdentityLink, if audit history is enabled.

    • recordIdentityLinkDeleted

      void recordIdentityLinkDeleted(IdentityLinkEntity identityLink)
      Record the deletion of a IdentityLink, if audit history is enabled

    • recordEntityLinkCreated

      void recordEntityLinkCreated(EntityLinkEntity entityLink)
      Record the creation of a new EntityLink, if audit history is enabled.

    • recordEntityLinkDeleted

      void recordEntityLinkDeleted(EntityLinkEntity entityLink)
      Record the deletion of a EntityLink, if audit history is enabled

    • updateProcessBusinessKeyInHistory

      void updateProcessBusinessKeyInHistory(ExecutionEntity processInstance)

    • updateProcessBusinessStatusInHistory

      void updateProcessBusinessStatusInHistory(ExecutionEntity processInstance)

    • updateProcessDefinitionIdInHistory

      void updateProcessDefinitionIdInHistory(ProcessDefinitionEntity processDefinitionEntity, ExecutionEntity processInstance)
      Record the update of a process definition for historic process instance, task, and activity instance, if history is enabled.

    • updateActivity

      void updateActivity(ExecutionEntity executionEntity, String oldActivityId, FlowElement newFlowElement, TaskEntity task, Date updateTime)
      Synchronize historic data with the current user task execution
      Parameters:
      executionEntity - entity which executes user task
      oldActivityId - previous activityId
      newFlowElement - new flowElement
      task - new user task
      updateTime -

    • updateHistoricActivityInstance

      void updateHistoricActivityInstance(ActivityInstance activityInstance)
      Update historic activity instance according to changes done in the runtime activity
      Parameters:
      activityInstance -

    • createHistoricActivityInstance

      void createHistoricActivityInstance(ActivityInstance activityInstance)
      Create new historic activity instance from runtime activity instance
      Parameters:
      activityInstance - activity instance template

    • recordHistoricUserTaskLogEntry

      void recordHistoricUserTaskLogEntry(HistoricTaskLogEntryBuilder taskLogEntryBuilder)
      Record historic user task log entry
      Parameters:
      taskLogEntryBuilder - historic user task log entry description

    • deleteHistoryUserTaskLog

      void deleteHistoryUserTaskLog(long logNumber)
      Delete historic user task log entry
      Parameters:
      logNumber - log identifier