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

Class DocumentEventBase

java.lang.Object

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

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

All Implemented Interfaces:

DocumentEvent, RuleEvent

Direct Known Subclasses:

AddAdHocRoutePersonEvent, AddAdHocRouteWorkgroupEvent, AddCollectionLineEvent, AddDelegationEvent, AddDelegationMemberEvent, AddGroupEvent, AddGroupMemberEvent, AddMemberEvent, AddNoteEvent, AddPermissionEvent, AddPersonDelegationMemberEvent, AddPersonDocumentRoleQualifierEvent, AddResponsibilityEvent, AddRoleEvent, ApproveDocumentEvent, CompleteDocumentEvent, DocumentAuditEvent, KualiAddLineEvent, PromptBeforeValidationEvent, RouteDocumentEvent, SaveDocumentEvent, SendAdHocRequestsEvent

public abstract class DocumentEventBase
extends RuleEventBase
implements DocumentEvent

Abstract superclass for document-related events.

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected Document	document

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DocumentEventBase(String description, String errorPathPrefix) As a general rule, business rule classes should not change the original object.
	DocumentEventBase(String description, String errorPathPrefix, Document document) Constructs a KualiEvent with the given description and errorPathPrefix for the given document.

Method Summary

Modifier and Type	Method and Description
Document	getDocument()
protected static String	getDocumentId(Document document) Provides null-safe access to the documentNumber of the given document.
void	validate() Validates the event has all the necessary properties.

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, getRuleInterfaceClass, getRuleMethodName, invokeRuleMethod

Field Detail

document

protected Document document

Constructor Detail

DocumentEventBase

protected DocumentEventBase(String description,
                            String errorPathPrefix)

As a general rule, business rule classes should not change the original object. This constructor was created so that PreRulesCheckEvent, a UI level rule checker, can make changes.

Parameters:

description -

errorPathPrefix -

DocumentEventBase

public DocumentEventBase(String description,
                         String errorPathPrefix,
                         Document document)

Constructs a KualiEvent with the given description and errorPathPrefix for the given document.

Parameters:

errorPathPrefix -

document -

description -

Method Detail

getDocument

public final Document getDocument()

Specified by:

getDocument in interface DocumentEvent

Returns:

Document The document associated with this event

See Also:

DocumentEvent.getDocument()

validate

public void validate()

Description copied from interface: RuleEvent

Validates the event has all the necessary properties.

Specified by:

validate in interface RuleEvent

See Also:

RuleEvent.validate()

getDocumentId

protected static String getDocumentId(Document document)

Provides null-safe access to the documentNumber of the given document.

Parameters:

document -

Returns:

String containing the documentNumber of the given document, or some indication of why the documentNumber isn't accessible