org.kuali.rice.kns.rule.event
Class AddAdHocRoutePersonEvent

java.lang.Object
  extended by org.kuali.rice.kns.rule.event.KualiDocumentEventBase
      extended by org.kuali.rice.kns.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
private  AdHocRoutePerson adHocRoutePerson
           
 
Fields inherited from class org.kuali.rice.kns.rule.event.KualiDocumentEventBase
document
 
Constructor Summary
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
 AdHocRoutePerson getAdHocRoutePerson()
          This method retrieves the document adHocRoutePerson associated with this event.
 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.
 
Methods inherited from class org.kuali.rice.kns.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
 

Field Detail

adHocRoutePerson

private AdHocRoutePerson adHocRoutePerson
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 getRuleInterfaceClass()
Description copied from interface: KualiDocumentEvent
Returns the interface that classes must implement to recieve 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.kns.rule.BusinessRule)


Copyright © 2004-2011 The Kuali Foundation. All Rights Reserved.