Package org.flowable.engine.impl.history

Class DefaultHistoryConfigurationSettings

java.lang.Object

org.flowable.engine.impl.history.DefaultHistoryConfigurationSettings

All Implemented Interfaces:

HistoryConfigurationSettings

public class DefaultHistoryConfigurationSettings
extends Object
implements HistoryConfigurationSettings

Author:

Joram Barrez

Field Summary

Fields

Modifier and Type	Field	Description
protected ProcessEngineConfigurationImpl	processEngineConfiguration

Constructor Summary

Constructors

Constructor	Description
DefaultHistoryConfigurationSettings(ProcessEngineConfigurationImpl processEngineConfiguration)

Method Summary

Modifier and Type	Method	Description
protected HistoryLevel	getProcessDefinitionHistoryLevel(String processDefinitionId)
protected String	getProcessDefinitionId(EntityLinkEntity entityLink)
protected String	getProcessDefinitionId(IdentityLinkEntity identityLink)
protected boolean	hasTaskHistoryLevel(HistoryLevel historyLevel)
protected boolean	includeFlowElementInHistory(String processDefinitionId, String activityId)
protected boolean	isEnableProcessDefinitionHistoryLevel()
boolean	isHistoryEnabled()	Returns whether history is enabled on the process engine configuration.
boolean	isHistoryEnabled(String processDefinitionId)	Returns whether any history should be stored for the given process definition (i.e.
boolean	isHistoryEnabledForActivity(String processDefinitionId, String activityId)	Returns whether history is enabled for the provided activity.
boolean	isHistoryEnabledForActivity(ActivityInstance activityInstance)	Returns whether history is enabled for the provided activity.
boolean	isHistoryEnabledForEntityLink(EntityLinkEntity entityLink)	Returns whether history is enabled for the provided entity link.
boolean	isHistoryEnabledForIdentityLink(IdentityLinkEntity identityLink)	Returns whether history is enabled for the provided identity link.
boolean	isHistoryEnabledForProcessInstance(ExecutionEntity processInstanceExecution)	Returns whether history is enabled for the provided process instance.
protected boolean	isHistoryEnabledForUserTask(String processDefinitionId)
boolean	isHistoryEnabledForUserTask(ExecutionEntity executionEntity, TaskEntity taskEntity)	Returns whether history is enabled for the provided user task.
boolean	isHistoryEnabledForUserTask(org.flowable.task.api.TaskInfo taskInfo)	Returns whether history is enabled for the provided user task.
boolean	isHistoryEnabledForVariableInstance(String processDefinitionId, VariableInstanceEntity variableInstanceEntity)	Returns whether history is enabled for the provided variable instance.
boolean	isHistoryEnabledForVariableInstance(VariableInstanceEntity variableInstanceEntity)	Returns whether history is enabled for the provided variable instance.
boolean	isHistoryLevelAtLeast(HistoryLevel level, String processDefinitionId)	Returns whether the history level is at least the given level.

Methods inherited from class java.lang.Object

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

Field Detail

processEngineConfiguration

protected ProcessEngineConfigurationImpl processEngineConfiguration

Constructor Detail

DefaultHistoryConfigurationSettings

public DefaultHistoryConfigurationSettings(ProcessEngineConfigurationImpl processEngineConfiguration)

Method Detail

isEnableProcessDefinitionHistoryLevel

protected boolean isEnableProcessDefinitionHistoryLevel()

isHistoryEnabled

public boolean isHistoryEnabled()

Description copied from interface: HistoryConfigurationSettings

Returns whether history is enabled on the process engine configuration.

Specified by:

isHistoryEnabled in interface HistoryConfigurationSettings

getProcessDefinitionHistoryLevel

protected HistoryLevel getProcessDefinitionHistoryLevel(String processDefinitionId)

isHistoryEnabled

public boolean isHistoryEnabled(String processDefinitionId)

Description copied from interface: HistoryConfigurationSettings

Returns whether any history should be stored for the given process definition (i.e. the history level is different from HistoryLevel.NONE.

Specified by:

isHistoryEnabled in interface HistoryConfigurationSettings

isHistoryLevelAtLeast

public boolean isHistoryLevelAtLeast(HistoryLevel level,
                                     String processDefinitionId)

Description copied from interface: HistoryConfigurationSettings

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.

Specified by:

isHistoryLevelAtLeast in interface HistoryConfigurationSettings

isHistoryEnabledForProcessInstance

public boolean isHistoryEnabledForProcessInstance(ExecutionEntity processInstanceExecution)

Description copied from interface: HistoryConfigurationSettings

Returns whether history is enabled for the provided process instance.

Specified by:

isHistoryEnabledForProcessInstance in interface HistoryConfigurationSettings

isHistoryEnabledForActivity

public boolean isHistoryEnabledForActivity(ActivityInstance activityInstance)

Description copied from interface: HistoryConfigurationSettings

Returns whether history is enabled for the provided activity.

Specified by:

isHistoryEnabledForActivity in interface HistoryConfigurationSettings

isHistoryEnabledForActivity

public boolean isHistoryEnabledForActivity(String processDefinitionId,
                                           String activityId)

Description copied from interface: HistoryConfigurationSettings

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.

Specified by:

isHistoryEnabledForActivity in interface HistoryConfigurationSettings

includeFlowElementInHistory

protected boolean includeFlowElementInHistory(String processDefinitionId,
                                              String activityId)

isHistoryEnabledForUserTask

public boolean isHistoryEnabledForUserTask(org.flowable.task.api.TaskInfo taskInfo)

Description copied from interface: HistoryConfigurationSettings

Returns whether history is enabled for the provided user task.

Specified by:

isHistoryEnabledForUserTask in interface HistoryConfigurationSettings

isHistoryEnabledForUserTask

public boolean isHistoryEnabledForUserTask(ExecutionEntity executionEntity,
                                           TaskEntity taskEntity)

Description copied from interface: HistoryConfigurationSettings

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.

Specified by:

isHistoryEnabledForUserTask in interface HistoryConfigurationSettings

isHistoryEnabledForUserTask

protected boolean isHistoryEnabledForUserTask(String processDefinitionId)

hasTaskHistoryLevel

protected boolean hasTaskHistoryLevel(HistoryLevel historyLevel)

isHistoryEnabledForVariableInstance

public boolean isHistoryEnabledForVariableInstance(VariableInstanceEntity variableInstanceEntity)

Description copied from interface: HistoryConfigurationSettings

Returns whether history is enabled for the provided variable instance.

Specified by:

isHistoryEnabledForVariableInstance in interface HistoryConfigurationSettings

isHistoryEnabledForVariableInstance

public boolean isHistoryEnabledForVariableInstance(String processDefinitionId,
                                                   VariableInstanceEntity variableInstanceEntity)

Description copied from interface: HistoryConfigurationSettings

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.

Specified by:

isHistoryEnabledForVariableInstance in interface HistoryConfigurationSettings

isHistoryEnabledForIdentityLink

public boolean isHistoryEnabledForIdentityLink(IdentityLinkEntity identityLink)

Description copied from interface: HistoryConfigurationSettings

Returns whether history is enabled for the provided identity link.

Specified by:

isHistoryEnabledForIdentityLink in interface HistoryConfigurationSettings

getProcessDefinitionId

protected String getProcessDefinitionId(IdentityLinkEntity identityLink)

isHistoryEnabledForEntityLink

public boolean isHistoryEnabledForEntityLink(EntityLinkEntity entityLink)

Description copied from interface: HistoryConfigurationSettings

Returns whether history is enabled for the provided entity link.

Specified by:

isHistoryEnabledForEntityLink in interface HistoryConfigurationSettings

getProcessDefinitionId

protected String getProcessDefinitionId(EntityLinkEntity entityLink)