Interface HistoryConfigurationSettings

All Known Implementing Classes:
DefaultHistoryConfigurationSettings

public interface HistoryConfigurationSettings
Author:
Joram Barrez
  • Method Details

    • isHistoryEnabled

      boolean isHistoryEnabled()
      Returns whether history is enabled on the process engine configuration.
    • isHistoryEnabled

      boolean isHistoryEnabled(String processDefinitionId)
      Returns whether any history should be stored for the given process definition (i.e. the history level is different from HistoryLevel.NONE.
    • isHistoryLevelAtLeast

      boolean isHistoryLevelAtLeast(HistoryLevel level, String processDefinitionId)
      Returns whether the history level is at least the given level. If process definitions have more specific settings the level will be checked against that before checking the engine configuration.
    • isHistoryEnabledForProcessInstance

      boolean isHistoryEnabledForProcessInstance(ExecutionEntity processInstanceExecution)
      Returns whether history is enabled for the provided process instance.
    • isHistoryEnabledForActivity

      boolean isHistoryEnabledForActivity(ActivityInstance activityInstance)
      Returns whether history is enabled for the provided activity.
    • isHistoryEnabledForActivity

      boolean isHistoryEnabledForActivity(String processDefinitionId, String activityId)
      Returns whether history is enabled for the provided activity. This method has an extra activityInstance parameter, for legacy reasons and should only be used in those exceptional situations.
    • isHistoryEnabledForUserTask

      boolean isHistoryEnabledForUserTask(TaskInfo taskInfo)
      Returns whether history is enabled for the provided user task.
    • isHistoryEnabledForUserTask

      boolean isHistoryEnabledForUserTask(ExecutionEntity executionEntity, TaskEntity taskEntity)
      Returns whether history is enabled for the provided user task. This method has an extra executionEntity parameter, for legacy reasons and should only be used in those exceptional situations.
    • isHistoryEnabledForVariableInstance

      boolean isHistoryEnabledForVariableInstance(VariableInstanceEntity variableInstanceEntity)
      Returns whether history is enabled for the provided variable instance.
    • isHistoryEnabledForVariableInstance

      boolean isHistoryEnabledForVariableInstance(String processDefinitionId, VariableInstanceEntity variableInstanceEntity)
      Returns whether history is enabled for the provided variable instance. This method has an extra processDefinitionId parameter, for legacy reasons and should only be used in those exceptional situations.
    • isHistoryEnabledForVariables

      boolean isHistoryEnabledForVariables(String processDefinitionId)
      Returns whether history is enabled for variables for the provided historic process instance.
    • isHistoryEnabledForVariables

      boolean isHistoryEnabledForVariables(HistoricTaskInstance historicTaskInstance)
      Returns whether variable history is enabled for the provided historic task instance.
    • isHistoryEnabledForIdentityLink

      boolean isHistoryEnabledForIdentityLink(IdentityLinkEntity identityLink)
      Returns whether history is enabled for the provided identity link.
    • isHistoryEnabledForEntityLink

      boolean isHistoryEnabledForEntityLink(EntityLinkEntity entityLink)
      Returns whether history is enabled for the provided entity link.