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

Interface RuleEvent

All Known Subinterfaces:
DocumentEvent
All Known Implementing Classes:
AddAdHocRoutePersonEvent, AddAdHocRouteWorkgroupEvent, AddCollectionLineEvent, AddNoteEvent, ApproveDocumentEvent, BlanketApproveDocumentEvent, CompleteDocumentEvent, DocumentAuditEvent, DocumentEventBase, RouteDocumentEvent, RuleEventBase, 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 Details

    • 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