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

Class CompleteDocumentEvent

java.lang.Object

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

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

All Implemented Interfaces:

KualiDocumentEvent

public class CompleteDocumentEvent
extends KualiDocumentEventBase

Complete document event

Author:

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

Field Summary

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

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

Modifier and Type	Method and Description
List	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.KualiDocumentEventBase

getDescription, getDocument, getDocumentId, getErrorPathPrefix, getName, toString, validate

Methods inherited from class java.lang.Object

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

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: KualiDocumentEvent

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

Returns:

See Also:

KualiDocumentEvent.getRuleInterfaceClass()

invokeRuleMethod

public boolean invokeRuleMethod(BusinessRule rule)

Description copied from interface: KualiDocumentEvent

Invokes the event handling method on the rule object.

Returns:

See Also:

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

generateEvents

public List generateEvents()

Description copied from interface: KualiDocumentEvent

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

Specified by:

generateEvents in interface KualiDocumentEvent

Overrides:

generateEvents in class KualiDocumentEventBase

Returns:

See Also:

KualiDocumentEvent.generateEvents()