org.kuali.rice.kns.rule.event
Interface KualiDocumentEvent

All Known Implementing Classes:

AddAdHocRoutePersonEvent, AddAdHocRouteWorkgroupEvent, AddDelegationEvent, AddDelegationMemberEvent, AddGroupEvent, AddGroupMemberEvent, AddMemberEvent, AddNoteEvent, AddPermissionEvent, AddPersonDelegationMemberEvent, AddPersonDocumentDelegationMemberQualifierEvent, AddPersonDocumentRoleQualifierEvent, AddResponsibilityEvent, AddRoleEvent, ApproveDocumentEvent, BlanketApproveDocumentEvent, DocumentAuditEvent, KualiAddLineEvent, KualiDocumentEventBase, PromptBeforeValidationEvent, RouteDocumentEvent, SaveDocumentEvent, SaveOnlyDocumentEvent, SendAdHocRequestsEvent

public interface KualiDocumentEvent

Parent interface of all document-related events, which are used to drive the business rules evaluation process.

Method Summary

java.util.List	generateEvents() This will return a list of events that are spawned from this event.
java.lang.String	getDescription() A description of the event.
Document	getDocument()
java.lang.String	getErrorPathPrefix()
java.lang.String	getName() The name of the event.
java.lang.Class	getRuleInterfaceClass() Returns the interface that classes must implement to recieve 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.

Method Detail

getDocument

Document getDocument()

Returns:

Document The document associated with this event

getName

java.lang.String getName()

The name of the event.

Returns:

String

getDescription

java.lang.String getDescription()

A description of the event.

Returns:

String

getErrorPathPrefix

java.lang.String getErrorPathPrefix()

Returns:

errorPathPrefix for this event

getRuleInterfaceClass

java.lang.Class getRuleInterfaceClass()

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

Returns:

validate

void validate()

Validates the event has all the necessary properties.

invokeRuleMethod

boolean invokeRuleMethod(BusinessRule rule)

Invokes the event handling method on the rule object.

Parameters:

rule -

Returns:

generateEvents

java.util.List generateEvents()

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

Returns: