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

Interface RuleEvent

All Known Subinterfaces:

DocumentEvent

All Known Implementing Classes:

AddAdHocRoutePersonEvent, AddAdHocRouteWorkgroupEvent, AddCollectionLineEvent, AddDelegationEvent, AddDelegationMemberEvent, AddGroupEvent, AddGroupMemberEvent, AddMemberEvent, AddNoteEvent, AddPermissionEvent, AddPersonDelegationMemberEvent, AddPersonDocumentRoleQualifierEvent, AddResponsibilityEvent, AddRoleEvent, ApproveDocumentEvent, BlanketApproveDocumentEvent, CompleteDocumentEvent, DocumentAuditEvent, DocumentEventBase, KualiAddLineEvent, PromptBeforeValidationEvent, RouteDocumentEvent, RuleEventBase, RuleEventImpl, SaveDocumentEvent, SaveOnlyDocumentEvent, SendAdHocRequestsEvent

public interface RuleEvent

class representing the rule event to process a business rule

Author:

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

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.
String	getDescription() A description of the event.
String	getErrorPathPrefix()
Map<String,Object>	getFacts() The map that holds the data that to be validated.
String	getName() The name of the event.
Class<? extends BusinessRule>	getRuleInterfaceClass() Returns the interface that classes must implement to receive this event.
String	getRuleMethodName() The method name of the rule class to invoke.
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

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

getRuleMethodName

String getRuleMethodName()

The method name of the rule class to invoke.

If the rule method name is specified, then that business rule method is invoked to apply custom rules, else the default method is invoked.

Returns:

the name of the method

getFacts

Map<String,Object> getFacts()

The map that holds the data that to be validated.

Returns:

the map containing the data

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

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

Returns:

list of events