org.kuali.rice.kew.api.validation

Class RuleValidationContext

java.lang.Object

org.kuali.rice.core.api.mo.AbstractDataTransferObject

org.kuali.rice.kew.api.validation.RuleValidationContext

All Implemented Interfaces:

Serializable, ModelObjectBasic, ModelObjectComplete, RuleValidationContextContract

public class RuleValidationContext
extends AbstractDataTransferObject
implements RuleValidationContextContract

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)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RuleValidationContext.Builder A builder which can be used to construct RuleValidationContext instances.

Method Summary

Methods

Modifier and Type	Method and Description
Rule	getRule() Retrieve the rule which is being validated.
String	getRuleAuthorPrincipalId() Retrieve the principal id 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 org.kuali.rice.core.api.mo.AbstractDataTransferObject

afterUnmarshal, beforeUnmarshal, equals, equalsExcludeFields, getDefaultHashCodeEqualsExcludeFields, hashCode, hashCodeExcludeFields, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getRule

public Rule getRule()

Retrieve the rule which is being validated.

Specified by:

getRule in interface RuleValidationContextContract

getRuleAuthorPrincipalId

public String getRuleAuthorPrincipalId()

Retrieve the principal id of the individual entering the rule into the system. May be null in the case of an XML rule import.

Specified by:

getRuleAuthorPrincipalId in interface RuleValidationContextContract

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;

Specified by:

getRuleDelegation in interface RuleValidationContextContract