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

java.lang.Object
  org.kuali.rice.krad.rules.rule.event.KualiDocumentEventBase
      org.kuali.rice.krad.rules.rule.event.SaveDocumentEvent

All Implemented Interfaces:

KualiDocumentEvent, SaveEvent

Direct Known Subclasses:

SaveOnlyDocumentEvent

public class SaveDocumentEvent
extends KualiDocumentEventBase
implements SaveEvent

This class represents the save event that is part of an eDoc in Kuali. 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.

Field Summary

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

document

Constructor Summary

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

List<KualiDocumentEvent>	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.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

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:

KualiDocumentEventBase.KualiDocumentEventBase(java.lang.String, java.lang.String, org.kuali.rice.krad.document.Document)

Method Detail

getRuleInterfaceClass

public Class<? extends BusinessRule> getRuleInterfaceClass()

Description copied from interface: KualiDocumentEvent

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

Specified by:

getRuleInterfaceClass in interface KualiDocumentEvent

Returns:

rule interface

See Also:

KualiDocumentEvent.getRuleInterfaceClass()

invokeRuleMethod

public boolean invokeRuleMethod(BusinessRule rule)

Description copied from interface: KualiDocumentEvent

Invokes the event handling method on the rule object.

Specified by:

invokeRuleMethod in interface KualiDocumentEvent

Parameters:

rule - business rule

Returns:

true if the rule matches

See Also:

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

generateEvents

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

list of events

See Also:

KualiDocumentEvent.generateEvents()