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

Class RouteDocumentEvent

java.lang.Object

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

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

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

All Implemented Interfaces:

DocumentEvent, RuleEvent

public final class RouteDocumentEvent
extends DocumentEventBase

This class represents the route event that is part of an eDoc in Kuali. This could be triggered when a user presses the route button for a given document or it could happen when another piece of code calls the route method in the document service.

Field Summary

Fields inherited from class org.kuali.rice.krad.rules.rule.event.DocumentEventBase

document

Constructor Summary

Constructors

Constructor and Description
RouteDocumentEvent(Document document) Constructs a RouteDocumentEvent with the given document
RouteDocumentEvent(String errorPathPrefix, Document document) Constructs a RouteDocumentEvent with the specified errorPathPrefix and document

Method Summary

Methods

Modifier and Type	Method and Description
List<RuleEvent>	generateEvents() This will return a list of events that are spawned from this event.
Class<? extends BusinessRule>	getRuleInterfaceClass() Returns the interface that classes must implement to receive this event.
boolean	invokeRuleMethod(BusinessRule rule) Invokes the event handling method on the rule object.

Methods inherited from class org.kuali.rice.krad.rules.rule.event.DocumentEventBase

getDocument, getDocumentId, validate

Methods inherited from class org.kuali.rice.krad.rules.rule.event.RuleEventBase

addFact, getDescription, getErrorPathPrefix, getFacts, getName, getRuleMethodName, setFacts, setName, setRuleMethodName, 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

getDescription, getErrorPathPrefix, getFacts, getName, getRuleMethodName

Constructor Detail

RouteDocumentEvent

public RouteDocumentEvent(String errorPathPrefix,
                  Document document)

Constructs a RouteDocumentEvent with the specified errorPathPrefix and document

Parameters:

errorPathPrefix -

document -

RouteDocumentEvent

public RouteDocumentEvent(Document document)

Constructs a RouteDocumentEvent with the given document

Parameters:

document -

Method Detail

getRuleInterfaceClass

public Class<? extends BusinessRule> getRuleInterfaceClass()

Description copied from interface: RuleEvent

Returns the interface that classes must implement to receive this event.

Returns:

rule interface

See Also:

RuleEvent.getRuleInterfaceClass()

invokeRuleMethod

public boolean invokeRuleMethod(BusinessRule rule)

Description copied from interface: RuleEvent

Invokes the event handling method on the rule object.

Parameters:

rule - business rule

Returns:

true if the rule matches

See Also:

RuleEvent.invokeRuleMethod(org.kuali.rice.krad.rules.rule.BusinessRule)

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

Overrides:

generateEvents in class RuleEventBase

Returns:

list of events

See Also:

RuleEvent.generateEvents()