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

Class AddAdHocRoutePersonEvent

java.lang.Object

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

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

All Implemented Interfaces:

KualiDocumentEvent

public final class AddAdHocRoutePersonEvent
extends KualiDocumentEventBase

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

Field Summary

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

document

Constructor Summary

Constructors

Constructor and Description
AddAdHocRoutePersonEvent(Document document, AdHocRoutePerson adHocRoutePerson) Constructs an AddAdHocRoutePersonEvent with the given document
AddAdHocRoutePersonEvent(String errorPathPrefix, Document document, AdHocRoutePerson adHocRoutePerson) Constructs an AddAdHocRoutePersonEvent with the specified errorPathPrefix, document, and adHocRoutePerson

Method Summary

Methods

Modifier and Type	Method and Description
AdHocRoutePerson	getAdHocRoutePerson() This method retrieves the document adHocRoutePerson 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

AddAdHocRoutePersonEvent

public AddAdHocRoutePersonEvent(String errorPathPrefix,
                        Document document,
                        AdHocRoutePerson adHocRoutePerson)

Constructs an AddAdHocRoutePersonEvent with the specified errorPathPrefix, document, and adHocRoutePerson

Parameters:

document -

adHocRoutePerson -

errorPathPrefix -

AddAdHocRoutePersonEvent

public AddAdHocRoutePersonEvent(Document document,
                        AdHocRoutePerson adHocRoutePerson)

Constructs an AddAdHocRoutePersonEvent with the given document

Parameters:

document -

adHocRoutePerson -

Method Detail

getAdHocRoutePerson

public AdHocRoutePerson getAdHocRoutePerson()

This method retrieves the document adHocRoutePerson associated with this event.

Returns:

AdHocRoutePerson

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)