Package org.flowable.cmmn.engine.impl.history

Class DefaultCmmnHistoryConfigurationSettings

java.lang.Object

org.flowable.cmmn.engine.impl.history.DefaultCmmnHistoryConfigurationSettings

All Implemented Interfaces:

CmmnHistoryConfigurationSettings

public class DefaultCmmnHistoryConfigurationSettings
extends Object
implements CmmnHistoryConfigurationSettings

Author:

Joram Barrez

Field Summary

Fields

Modifier and Type	Field	Description
protected CmmnEngineConfiguration	cmmnEngineConfiguration

Constructor Summary

Constructors

Constructor	Description
DefaultCmmnHistoryConfigurationSettings(CmmnEngineConfiguration cmmnEngineConfiguration)

Method Summary

Modifier and Type	Method	Description
protected HistoryLevel	getCaseDefinitionHistoryLevel(String caseDefinitionId)
protected String	getCaseDefinitionId(EntityLinkEntity entityLink)
protected String	getCaseDefinitionId(IdentityLinkEntity identityLink)
protected boolean	hasTaskHistoryLevel(HistoryLevel historyLevel)
protected boolean	includePlanItemDefinitionInHistory(String caseDefinitionId, String activityId)
protected boolean	isEnableCaseDefinitionHistoryLevel()
boolean	isHistoryEnabled()	Returns whether history is enabled on the case engine configuration.
boolean	isHistoryEnabled(String caseDefinitionId)	Returns whether any history should be stored for the given case definition (i.e.
protected boolean	isHistoryEnabledForActivity(String caseDefinitionId, String activityId)
boolean	isHistoryEnabledForCaseInstance(CaseInstanceEntity caseInstanceEntity)	Returns whether history is enabled for the provided case instance.
boolean	isHistoryEnabledForEntityLink(EntityLinkEntity entityLink)	Returns whether history is enabled for the provided entity link.
boolean	isHistoryEnabledForIdentityLink(IdentityLinkEntity identityLinkEntity)	Returns whether history is enabled for the provided identity link.
boolean	isHistoryEnabledForMilestone(MilestoneInstanceEntity milestoneInstanceEntity)	Returns whether history is enabled for the provided activity.
boolean	isHistoryEnabledForPlanItemInstance(PlanItemInstanceEntity planItemInstanceEntity)	Returns whether history is enabled for the provided plan item instance.
boolean	isHistoryEnabledForUserTask(TaskInfo taskInfo)	Returns whether history is enabled for the provided user task.
boolean	isHistoryEnabledForVariableInstance(VariableInstanceEntity variableInstanceEntity)	Returns whether history is enabled for the provided variable instance.
boolean	isHistoryEnabledForVariables(HistoricTaskInstance historicTaskInstance)	Returns whether variable history is enabled for the provided historic task instance.
boolean	isHistoryLevelAtLeast(HistoryLevel level, String caseDefinitionId)	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 Details

cmmnEngineConfiguration

protected CmmnEngineConfiguration cmmnEngineConfiguration

Constructor Details

DefaultCmmnHistoryConfigurationSettings

public DefaultCmmnHistoryConfigurationSettings(CmmnEngineConfiguration cmmnEngineConfiguration)

Method Details

isHistoryEnabled

public boolean isHistoryEnabled()

Description copied from interface: CmmnHistoryConfigurationSettings

Returns whether history is enabled on the case engine configuration.

Specified by:

isHistoryEnabled in interface CmmnHistoryConfigurationSettings

isEnableCaseDefinitionHistoryLevel

protected boolean isEnableCaseDefinitionHistoryLevel()

isHistoryEnabled

public boolean isHistoryEnabled(String caseDefinitionId)

Description copied from interface: CmmnHistoryConfigurationSettings

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

Specified by:

isHistoryEnabled in interface CmmnHistoryConfigurationSettings

isHistoryLevelAtLeast

public boolean isHistoryLevelAtLeast(HistoryLevel level,
 String caseDefinitionId)

Description copied from interface: CmmnHistoryConfigurationSettings

Returns whether the history level is at least the given level. If case definitions have more specific settings the level will be checked against that before checking the engine configuration.

Specified by:

isHistoryLevelAtLeast in interface CmmnHistoryConfigurationSettings

isHistoryEnabledForCaseInstance

public boolean isHistoryEnabledForCaseInstance(CaseInstanceEntity caseInstanceEntity)

Description copied from interface: CmmnHistoryConfigurationSettings

Returns whether history is enabled for the provided case instance.

Specified by:

isHistoryEnabledForCaseInstance in interface CmmnHistoryConfigurationSettings

isHistoryEnabledForActivity

protected boolean isHistoryEnabledForActivity(String caseDefinitionId,
 String activityId)

isHistoryEnabledForMilestone

public boolean isHistoryEnabledForMilestone(MilestoneInstanceEntity milestoneInstanceEntity)

Description copied from interface: CmmnHistoryConfigurationSettings

Returns whether history is enabled for the provided activity.

Specified by:

isHistoryEnabledForMilestone in interface CmmnHistoryConfigurationSettings

isHistoryEnabledForPlanItemInstance

public boolean isHistoryEnabledForPlanItemInstance(PlanItemInstanceEntity planItemInstanceEntity)

Description copied from interface: CmmnHistoryConfigurationSettings

Returns whether history is enabled for the provided plan item instance.

Specified by:

isHistoryEnabledForPlanItemInstance in interface CmmnHistoryConfigurationSettings

isHistoryEnabledForUserTask

public boolean isHistoryEnabledForUserTask(TaskInfo taskInfo)

Description copied from interface: CmmnHistoryConfigurationSettings

Returns whether history is enabled for the provided user task.

Specified by:

isHistoryEnabledForUserTask in interface CmmnHistoryConfigurationSettings

hasTaskHistoryLevel

protected boolean hasTaskHistoryLevel(HistoryLevel historyLevel)

isHistoryEnabledForVariableInstance

public boolean isHistoryEnabledForVariableInstance(VariableInstanceEntity variableInstanceEntity)

Description copied from interface: CmmnHistoryConfigurationSettings

Returns whether history is enabled for the provided variable instance.

Specified by:

isHistoryEnabledForVariableInstance in interface CmmnHistoryConfigurationSettings

isHistoryEnabledForIdentityLink

public boolean isHistoryEnabledForIdentityLink(IdentityLinkEntity identityLinkEntity)

Description copied from interface: CmmnHistoryConfigurationSettings

Returns whether history is enabled for the provided identity link.

Specified by:

isHistoryEnabledForIdentityLink in interface CmmnHistoryConfigurationSettings

getCaseDefinitionId

protected String getCaseDefinitionId(IdentityLinkEntity identityLink)

isHistoryEnabledForEntityLink

public boolean isHistoryEnabledForEntityLink(EntityLinkEntity entityLink)

Description copied from interface: CmmnHistoryConfigurationSettings

Returns whether history is enabled for the provided entity link.

Specified by:

isHistoryEnabledForEntityLink in interface CmmnHistoryConfigurationSettings

isHistoryEnabledForVariables

public boolean isHistoryEnabledForVariables(HistoricTaskInstance historicTaskInstance)

Description copied from interface: CmmnHistoryConfigurationSettings

Returns whether variable history is enabled for the provided historic task instance.

Specified by:

isHistoryEnabledForVariables in interface CmmnHistoryConfigurationSettings

getCaseDefinitionId

protected String getCaseDefinitionId(EntityLinkEntity entityLink)

getCaseDefinitionHistoryLevel

protected HistoryLevel getCaseDefinitionHistoryLevel(String caseDefinitionId)

includePlanItemDefinitionInHistory

protected boolean includePlanItemDefinitionInHistory(String caseDefinitionId,
 String activityId)