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

All Known Implementing Classes:

AddAdHocRoutePersonEvent, AddAdHocRouteWorkgroupEvent, AddCollectionLineEvent, AddDelegationEvent, AddDelegationMemberEvent, AddGroupEvent, AddGroupMemberEvent, AddMemberEvent, AddNoteEvent, AddPermissionEvent, AddPersonDelegationMemberEvent, AddPersonDocumentRoleQualifierEvent, AddResponsibilityEvent, AddRoleEvent, ApproveDocumentEvent, BlanketApproveDocumentEvent, CompleteDocumentEvent, 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

List<KualiDocumentEvent>	generateEvents() This will return a list of events that are spawned from this event.
String	getDescription() A description of the event.
Document	getDocument()
String	getErrorPathPrefix()
String	getName() The name of the 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.

Method Detail

getDocument

Document getDocument()

Returns:

Document The document associated with this event

getName

String getName()

The name of the event.

Returns:

String

getDescription

String getDescription()

A description of the event.

Returns:

String

getErrorPathPrefix

String getErrorPathPrefix()

Returns:

errorPathPrefix for this event

getRuleInterfaceClass

Class<? extends BusinessRule> getRuleInterfaceClass()

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

Returns:

rule interface

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 - business rule

Returns:

true if the rule matches

generateEvents

List<KualiDocumentEvent> generateEvents()

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

Returns:

list of events