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

Class SaveDocumentEvent

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

All Implemented Interfaces:

DocumentEvent, RuleEvent, SaveEvent

Direct Known Subclasses:

RuleEventImpl, SaveOnlyDocumentEvent

public class SaveDocumentEvent
extends DocumentEventBase
implements SaveEvent

Rule event generated for a save of a document instance.

This could be triggered when a user presses the save button for a given document or it could happen when another piece of code calls the save method in the document service.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

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

document

Constructor Summary

Constructors

Constructor and Description
SaveDocumentEvent(Document document) Constructs a SaveDocumentEvent with the given document
SaveDocumentEvent(String errorPathPrefix, Document document) Constructs a SaveDocumentEvent with the specified errorPathPrefix and document
SaveDocumentEvent(String description, String errorPathPrefix, Document 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

SaveDocumentEvent

public SaveDocumentEvent(String errorPathPrefix,
                 Document document)

Constructs a SaveDocumentEvent with the specified errorPathPrefix and document

Parameters:

document -

errorPathPrefix -

SaveDocumentEvent

public SaveDocumentEvent(Document document)

Constructs a SaveDocumentEvent with the given document

Parameters:

document -

SaveDocumentEvent

public SaveDocumentEvent(String description,
                 String errorPathPrefix,
                 Document document)

See Also:

DocumentEventBase.DocumentEventBase(java.lang.String, java.lang.String, org.kuali.rice.krad.document.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.

Specified by:

getRuleInterfaceClass in interface RuleEvent

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.

Specified by:

invokeRuleMethod in interface RuleEvent

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