org.kuali.rice.kew.rule
Class AccumulatingBSFRuleExpression.RuleHelper

java.lang.Object
  org.kuali.rice.kew.rule.AccumulatingBSFRuleExpression.RuleHelper

Enclosing class:

AccumulatingBSFRuleExpression

private static final class AccumulatingBSFRuleExpression.RuleHelper
extends Object

Helper class that is exposed to groovy scripts

Field Summary

private List<RuleResponsibility>	responsibilities Responsibilities accumulated during the evaluation
private int	responsibilityPriority
private Rule	rule
private BSFRuleExpression.WorkflowRuleAPI	workflow

Constructor Summary

private

AccumulatingBSFRuleExpression.RuleHelper(Rule rule, RouteContext context)

Method Summary

void	accumulate(RuleExpressionResult result) Adds the responsibilities in the result to the list of accumulated responsibilities
boolean	evalRule(String ruleName) Evaluates a named rule accumulating responsibilities regardless of rule success
boolean	evalRule(String ruleName, boolean accumOnSuccess) Evaluates a named rule and if it is successful accumulates the rule responsibilities
List<RuleResponsibility>	getResponsibilities()
RuleExpressionResult	getResult(boolean success)

Methods inherited from class java.lang.Object

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

Field Detail

rule

private Rule rule

workflow

private BSFRuleExpression.WorkflowRuleAPI workflow

responsibilities

private List<RuleResponsibility> responsibilities

Responsibilities accumulated during the evaluation

responsibilityPriority

private int responsibilityPriority

Constructor Detail

AccumulatingBSFRuleExpression.RuleHelper

private AccumulatingBSFRuleExpression.RuleHelper(Rule rule,
                                                 RouteContext context)

Method Detail

getResponsibilities

public List<RuleResponsibility> getResponsibilities()

Returns:

the accumulated responsibilities

getResult

public RuleExpressionResult getResult(boolean success)

Parameters:

success - whether the result should be successful

Returns:

the RuleExpressionResult with success flag and accumulated responsibilities

accumulate

public void accumulate(RuleExpressionResult result)

Adds the responsibilities in the result to the list of accumulated responsibilities

Parameters:

result - a RuleExpressionResult whose responsibilities to accumulate

evalRule

public boolean evalRule(String ruleName)
                 throws WorkflowException

Evaluates a named rule accumulating responsibilities regardless of rule success

Parameters:

ruleName - the name of the rule to evaluate

Returns:

whether the rule was successful

Throws:

WorkflowException

evalRule

public boolean evalRule(String ruleName,
                        boolean accumOnSuccess)
                 throws WorkflowException

Evaluates a named rule and if it is successful accumulates the rule responsibilities

Parameters:

ruleName - the name of the rule to evaluate

accumOnSuccess - whether to accumulate the rules responsibilities on success (true), or on failure (false)

Returns:

whether the rule was successful

Throws:

WorkflowException