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

Class AddNoteEvent

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

All Implemented Interfaces:

DocumentEvent, RuleEvent

public final class AddNoteEvent
extends DocumentEventBase

This class represents the add note event that is part of an eDoc in Kuali. This is triggered when a user presses the add button for a given note or it could happen when another piece of code calls the create note 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
AddNoteEvent(Document document, Note note) Constructs an AddNoteEvent with the given document
AddNoteEvent(String errorPathPrefix, Document document, Note note) Constructs an AddNoteEvent with the specified errorPathPrefix and document

Method Summary

Methods

Modifier and Type	Method and Description
Note	getNote() This method retrieves the note associated with 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.
void	validate() Validates the event has all the necessary properties.

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

getDocument, getDocumentId

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

addFact, generateEvents, 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

generateEvents, getDescription, getErrorPathPrefix, getFacts, getName, getRuleMethodName

Constructor Detail

AddNoteEvent

public AddNoteEvent(String errorPathPrefix,
            Document document,
            Note note)

Constructs an AddNoteEvent with the specified errorPathPrefix and document

Parameters:

document -

errorPathPrefix -

AddNoteEvent

public AddNoteEvent(Document document,
            Note note)

Constructs an AddNoteEvent with the given document

Parameters:

document -

Method Detail

getNote

public Note getNote()

This method retrieves the note associated with this event.

Returns:

note

validate

public void validate()

Description copied from interface: RuleEvent

Validates the event has all the necessary properties.

Specified by:

validate in interface RuleEvent

Overrides:

validate in class DocumentEventBase

See Also:

RuleEvent.validate()

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)