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

Class AddAdHocRouteWorkgroupEvent

java.lang.Object

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

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

All Implemented Interfaces:

KualiDocumentEvent

public final class AddAdHocRouteWorkgroupEvent
extends KualiDocumentEventBase

This class represents the add AdHocRouteWorkgroup event that is part of an eDoc in Kuali. This is triggered when a user presses the add button for a given adHocRouteWorkgroup.

Field Summary

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

document

Constructor Summary

Constructors

Constructor and Description
AddAdHocRouteWorkgroupEvent(Document document, AdHocRouteWorkgroup adHocRouteWorkgroup) Constructs an AddAdHocRouteWorkgroupEvent with the given document
AddAdHocRouteWorkgroupEvent(String errorPathPrefix, Document document, AdHocRouteWorkgroup adHocRouteWorkgroup) Constructs an AddAdHocRouteWorkgroupEvent with the specified errorPathPrefix, document, and adHocRouteWorkgroup

Method Summary

Modifier and Type	Method and Description
AdHocRouteWorkgroup	getAdHocRouteWorkgroup() This method retrieves the document adHocRouteWorkgroup 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.KualiDocumentEventBase

generateEvents, getDescription, getDocument, getDocumentId, getErrorPathPrefix, getName, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

AddAdHocRouteWorkgroupEvent

public AddAdHocRouteWorkgroupEvent(String errorPathPrefix,
                                   Document document,
                                   AdHocRouteWorkgroup adHocRouteWorkgroup)

Constructs an AddAdHocRouteWorkgroupEvent with the specified errorPathPrefix, document, and adHocRouteWorkgroup

Parameters:

document -

adHocRouteWorkgroup -

errorPathPrefix -

AddAdHocRouteWorkgroupEvent

public AddAdHocRouteWorkgroupEvent(Document document,
                                   AdHocRouteWorkgroup adHocRouteWorkgroup)

Constructs an AddAdHocRouteWorkgroupEvent with the given document

Parameters:

document -

adHocRouteWorkgroup -

Method Detail

getAdHocRouteWorkgroup

public AdHocRouteWorkgroup getAdHocRouteWorkgroup()

This method retrieves the document adHocRouteWorkgroup associated with this event.

Returns:

AdHocRouteWorkgroup

validate

public void validate()

Description copied from interface: KualiDocumentEvent

Validates the event has all the necessary properties.

Specified by:

validate in interface KualiDocumentEvent

Overrides:

validate in class KualiDocumentEventBase

See Also:

KualiDocumentEvent.validate()

getRuleInterfaceClass

public Class<? extends BusinessRule> getRuleInterfaceClass()

Description copied from interface: KualiDocumentEvent

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

Returns:

See Also:

KualiDocumentEvent.getRuleInterfaceClass()

invokeRuleMethod

public boolean invokeRuleMethod(BusinessRule rule)

Description copied from interface: KualiDocumentEvent

Invokes the event handling method on the rule object.

Returns:

See Also:

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