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

Class CompleteDocumentEvent

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.CompleteDocumentEvent

All Implemented Interfaces:

DocumentEvent, RuleEvent

public class CompleteDocumentEvent
extends DocumentEventBase

Complete document event

Author:

Kuali Rice Team (kuali-rice@googlegroups.com)

Field Summary

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

document

Constructor Summary

Constructors

Constructor and Description
CompleteDocumentEvent(Document document) Constructs a RouteDocumentEvent with the given document
CompleteDocumentEvent(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	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

CompleteDocumentEvent

public CompleteDocumentEvent(String errorPathPrefix,
                     Document document)

Constructs a RouteDocumentEvent with the specified errorPathPrefix and document

Parameters:

errorPathPrefix -

document -

CompleteDocumentEvent

public CompleteDocumentEvent(Document document)

Constructs a RouteDocumentEvent with the given document

Parameters:

document -

Method Detail

getRuleInterfaceClass

public Class 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()