de.viadee.bpm.vPAV.processing.dataflow

Interface DataFlowRule

All Known Subinterfaces:

ConditionedProcessVariableSet

All Known Implementing Classes:

DataFlowRuleBuilder

public interface DataFlowRule

Data flow rule that can be evaluated in two different ways. Also represents last stage of rule building construction with the option to define reason and criticality.

Method Summary

Modifier and Type	Method and Description
DataFlowRule	because(String reason) Method to define a reason.
void	check(Collection<ProcessVariable> variables) Evaluates rule on the set of process variables.
Collection<EvaluationResult<ProcessVariable>>	evaluate(Collection<ProcessVariable> variables) Evaluates rule on the set of process variables.
CriticalityEnum	getCriticality()
String	getRuleDescription()
String	getViolationMessageFor(EvaluationResult<ProcessVariable> result)
DataFlowRule	withCriticality(CriticalityEnum criticality) Method to define criticality.

Method Detail

because

DataFlowRule because(String reason)

Method to define a reason.

Parameters:

reason - - Reason

Returns:

Same step builder as this is not a stage transition.

withCriticality

DataFlowRule withCriticality(CriticalityEnum criticality)

Method to define criticality. Also implying issue type for vPAV validation.

Parameters:

criticality - - Criticality of rule

Returns:

Same step builder as this is not a stage transition.

check

void check(Collection<ProcessVariable> variables)

Evaluates rule on the set of process variables. If at least one process variable violates the rule, an AssertionError is thrown including a rule description and listing rule violations.

Parameters:

variables - - process variables to evaluate rule on.

Throws:

AssertionError - in case at least one violation exists.

evaluate

Collection<EvaluationResult<ProcessVariable>> evaluate(Collection<ProcessVariable> variables)

Evaluates rule on the set of process variables. EvaluationResult for each validated process variable is returned.

Parameters:

variables - -process variables to evaluate rule on.

Returns:

Collection of EvalutionResults for variables

getRuleDescription

String getRuleDescription()

getViolationMessageFor

String getViolationMessageFor(EvaluationResult<ProcessVariable> result)

Parameters:

result - - EvaluationResult

Returns:

Violation message

getCriticality

CriticalityEnum getCriticality()