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

Class DocumentAuditEvent

java.lang.Object

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

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

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

All Implemented Interfaces:

DocumentEvent, RuleEvent

public class DocumentAuditEvent
extends DocumentEventBase

Event class for document audit

Author:

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

Field Summary

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

document

Constructor Summary

Constructors

Constructor and Description
DocumentAuditEvent(Document document) Constructs a RunAuditEvent with the given document.
DocumentAuditEvent(String errorPathPrefix, Document document) Constructs a RunAuditEvent with the given errorPathPrefix and document.

Method Summary

Methods

Modifier and Type	Method and Description
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.

Methods inherited from class org.kuali.rice.krad.rules.rule.event.DocumentEventBase

getDocument, getDocumentId, validate

Methods inherited from class org.kuali.rice.krad.rules.rule.event.RuleEventBase

addFact, generateEvents, getDescription, getErrorPathPrefix, getFacts, getName, getRuleMethodName, setFacts, setName, setRuleMethodName, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.rice.krad.rules.rule.event.RuleEvent

generateEvents, getDescription, getErrorPathPrefix, getFacts, getName, getRuleMethodName

Constructor Detail

DocumentAuditEvent

public DocumentAuditEvent(String errorPathPrefix,
                  Document document)

Constructs a RunAuditEvent with the given errorPathPrefix and document.

Parameters:

errorPathPrefix -

document -

DocumentAuditEvent

public DocumentAuditEvent(Document document)

Constructs a RunAuditEvent with the given document.

Parameters:

document -

Method Detail

getRuleInterfaceClass

public Class<? extends BusinessRule> getRuleInterfaceClass()

Description copied from interface: RuleEvent

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

Returns:

rule interface

See Also:

RuleEvent.getRuleInterfaceClass()

invokeRuleMethod

public boolean invokeRuleMethod(BusinessRule rule)

Description copied from interface: RuleEvent

Invokes the event handling method on the rule object.

Parameters:

rule - business rule

Returns:

true if the rule matches

See Also:

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