org.kuali.rice.kew.validation
Class RuleValidationContext

java.lang.Object
  extended by org.kuali.rice.kew.validation.RuleValidationContext

public class RuleValidationContext
extends Object

The RuleValidationContext represents the context under which to validate a Rule which is being entered into the system, be it through the web-based Rule GUI or via an XML import. The ruleAuthor is the UserSession of the individual who is entering or editing the rule. This may be null if the rule is being run through validation from the context of an XML rule import. The RuleDelegation represents the pointer to the rule from it's parent rule's RuleResponsibility. This will be null if the rule being entered is not a delegation rule.

Author:
Kuali Rice Team (rice.collab@kuali.org)

Field Summary
private  RuleBaseValues rule
           
private  UserSession ruleAuthor
           
private  RuleDelegation ruleDelegation
           
 
Constructor Summary
RuleValidationContext(RuleBaseValues rule, RuleDelegation ruleDelegation, UserSession ruleAuthor)
          Construct a RuleValidationContext under which to validate a rule.
 
Method Summary
 RuleBaseValues getRule()
          Retrieve the rule which is being validated.
 UserSession getRuleAuthor()
          Retrieve the UserSession of the individual entering the rule into the system.
 RuleDelegation getRuleDelegation()
          Retrieve the RuleDelegation representing the parent of the rule being validated.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

rule

private final RuleBaseValues rule

ruleDelegation

private final RuleDelegation ruleDelegation

ruleAuthor

private final UserSession ruleAuthor
Constructor Detail

RuleValidationContext

public RuleValidationContext(RuleBaseValues rule,
                             RuleDelegation ruleDelegation,
                             UserSession ruleAuthor)
Construct a RuleValidationContext under which to validate a rule. The rule must be non-null, the delegation and author can be null given the circumstances defined in the description of this class.

Method Detail

getRule

public RuleBaseValues getRule()
Retrieve the rule which is being validated.


getRuleAuthor

public UserSession getRuleAuthor()
Retrieve the UserSession of the individual entering the rule into the system. May be null in the case of an XML rule import.


getRuleDelegation

public RuleDelegation getRuleDelegation()
Retrieve the RuleDelegation representing the parent of the rule being validated. If the rule is not a delegation rule, then this will return null;



Copyright © 2004-2011 The Kuali Foundation. All Rights Reserved.