org.kuali.rice.krad.rules.rule.event

Class RuleEventBase

java.lang.Object

org.kuali.rice.krad.rules.rule.event.RuleEventBase

All Implemented Interfaces:

RuleEvent

Direct Known Subclasses:

DocumentEventBase

public abstract class RuleEventBase
extends Object
implements RuleEvent

Created by nigupta on 4/28/2014.

Constructor Summary

Constructors

Constructor and Description
RuleEventBase(String description, String errorPathPrefix) As a general rule, business rule classes should not change the original object.

Method Summary

Methods

Modifier and Type	Method and Description
void	addFact(String key, Object object)
List<RuleEvent>	generateEvents() This will return a list of events that are spawned from this event.
String	getDescription() A description of the event.
String	getErrorPathPrefix()
Map<String,Object>	getFacts() The map that holds the data that to be validated.
String	getName() the name of this event
String	getRuleMethodName() The method name of the rule class to invoke.
void	setFacts(Map<String,Object> facts)
void	setName(String name)
void	setRuleMethodName(String name)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.rules.rule.event.RuleEvent

getRuleInterfaceClass, invokeRuleMethod, validate

Constructor Detail

RuleEventBase

public RuleEventBase(String description,
             String errorPathPrefix)

As a general rule, business rule classes should not change the original object. This constructor was created so that PreRulesCheckEvent, a UI level rule checker, can make changes.

Parameters:

description -

errorPathPrefix -

Method Detail

addFact

public void addFact(String key,
           Object object)

getName

public String getName()

the name of this event

Specified by:

getName in interface RuleEvent

Returns:

- the event name

setName

public void setName(String name)

See Also:

getName()

getDescription

public final String getDescription()

Description copied from interface: RuleEvent

A description of the event.

Specified by:

getDescription in interface RuleEvent

Returns:

a description of this event

getErrorPathPrefix

public String getErrorPathPrefix()

Specified by:

getErrorPathPrefix in interface RuleEvent

Returns:

the error path prefix for this event

toString

public String toString()

Overrides:

toString in class Object

See Also:

Object.toString()

getFacts

public Map<String,Object> getFacts()

The map that holds the data that to be validated.

Specified by:

getFacts in interface RuleEvent

Returns:

the map containing the data

setFacts

public void setFacts(Map<String,Object> facts)

See Also:

getFacts()

getRuleMethodName

public String getRuleMethodName()

The method name of the rule class to invoke.

If the rule method name is specified, then that business rule method is invoked to apply custom rules, else the default method is invoked.

Specified by:

getRuleMethodName in interface RuleEvent

Returns:

the name of the method

setRuleMethodName

public void setRuleMethodName(String name)

See Also:

getRuleMethodName()

generateEvents

public List<RuleEvent> generateEvents()

Description copied from interface: RuleEvent

This will return a list of events that are spawned from this event.

Specified by:

generateEvents in interface RuleEvent

Returns:

list of events

See Also:

RuleEvent.generateEvents()