org.kuali.kfs.sys.document.validation.impl

Class AccountingRuleEngineRuleBase

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.rice.kns.rules.DocumentRuleBase

org.kuali.kfs.sys.document.validation.impl.AccountingRuleEngineRuleBase

All Implemented Interfaces:

AccountingRuleEngineRule, org.kuali.rice.krad.rules.rule.AddAdHocRoutePersonRule, org.kuali.rice.krad.rules.rule.AddAdHocRouteWorkgroupRule, org.kuali.rice.krad.rules.rule.AddNoteRule, org.kuali.rice.krad.rules.rule.ApproveDocumentRule, org.kuali.rice.krad.rules.rule.BusinessRule, org.kuali.rice.krad.rules.rule.CompleteDocumentRule, org.kuali.rice.krad.rules.rule.RouteDocumentRule, org.kuali.rice.krad.rules.rule.SaveDocumentRule, org.kuali.rice.krad.rules.rule.SendAdHocRequestsRule

Direct Known Subclasses:

AccessSecurityAccountingDocumentRuleBase, LaborDocumentRuleEngineRuleBase

public class AccountingRuleEngineRuleBase
extends org.kuali.rice.kns.rules.DocumentRuleBase
implements AccountingRuleEngineRule

A rule that uses the accounting rule engine to perform rule validations.

Constructor Summary

Constructors

Constructor and Description
AccountingRuleEngineRuleBase() Constructs a AccountingRuleEngineRuleBase.java.

Method Summary

Methods

Modifier and Type	Method and Description
protected FinancialSystemTransactionalDocumentEntry	getDataDictionaryEntryForDocument(org.kuali.rice.krad.document.TransactionalDocument document) Returns the validation from the data dictionary for the document in the event
boolean	isDocumentAttributesValid(org.kuali.rice.krad.document.Document document, boolean validateRequired)
protected boolean	processCustomAddAdHocRoutePersonBusinessRules(org.kuali.rice.krad.document.Document document, org.kuali.rice.krad.bo.AdHocRoutePerson person)
protected boolean	processCustomAddAdHocRouteWorkgroupBusinessRules(org.kuali.rice.krad.document.Document document, org.kuali.rice.krad.bo.AdHocRouteWorkgroup workgroup)
protected boolean	processCustomAddNoteBusinessRules(org.kuali.rice.krad.document.Document document, org.kuali.rice.krad.bo.Note note)
protected boolean	processCustomApproveDocumentBusinessRules(org.kuali.rice.krad.rules.rule.event.ApproveDocumentEvent approveEvent)
protected boolean	processCustomRouteDocumentBusinessRules(org.kuali.rice.krad.document.Document document)
protected boolean	processCustomSaveDocumentBusinessRules(org.kuali.rice.krad.document.Document document)
boolean	validateForEvent(AttributedDocumentEvent event) Validates a particular event

Methods inherited from class org.kuali.rice.kns.rules.DocumentRuleBase

getDictionaryValidationService

Methods inherited from class org.kuali.rice.krad.rules.DocumentRuleBase

buildDocumentTypeActionRequestPermissionDetails, buildDocumentTypePermissionDetails, getDataDictionaryService, getDocumentDictionaryService, getGroupService, getKualiConfigurationService, getMaxDictionaryValidationDepth, getPermissionService, getPersonService, hasAdHocRouteCompletion, isAddHocRoutePersonValid, isAddHocRouteWorkgroupValid, isAdHocRouteCompletionToInitiator, isAdHocRouteRecipientsValid, isDocumentOverviewValid, isNoteValid, processAddAdHocRoutePerson, processAddAdHocRouteWorkgroup, processAddNote, processApproveDocument, processCompleteDocument, processCustomCompleteDocumentBusinessRules, processCustomSendAdHocRequests, processRouteDocument, processSaveDocument, processSendAdHocRequests, setDocumentDictionaryService, setMaxDictionaryValidationDepth, useKimPermission, validateSensitiveDataValue

Methods inherited from class java.lang.Object

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

Constructor Detail

AccountingRuleEngineRuleBase

public AccountingRuleEngineRuleBase()

Constructs a AccountingRuleEngineRuleBase.java.

Method Detail

validateForEvent

public boolean validateForEvent(AttributedDocumentEvent event)

Description copied from interface: AccountingRuleEngineRule

Validates a particular event

Specified by:

validateForEvent in interface AccountingRuleEngineRule

Parameters:

event - the event to validate

Returns:

true if validation succeeded and the process requiring validation should continue, false if the validation failed and the process should quit

See Also:

org.kuali.kfs.sys.document.validation.AccountingRuleEngineRule#validateForEvent(org.kuali.rice.krad.rule.event.KualiDocumentEvent)

getDataDictionaryEntryForDocument

protected FinancialSystemTransactionalDocumentEntry getDataDictionaryEntryForDocument(org.kuali.rice.krad.document.TransactionalDocument document)

Returns the validation from the data dictionary for the document in the event

Parameters:

document - the document to look up a data dictionary entry for

Returns:

a document entry

processCustomAddAdHocRoutePersonBusinessRules

protected boolean processCustomAddAdHocRoutePersonBusinessRules(org.kuali.rice.krad.document.Document document,
                                                    org.kuali.rice.krad.bo.AdHocRoutePerson person)

Overrides:

processCustomAddAdHocRoutePersonBusinessRules in class org.kuali.rice.krad.rules.DocumentRuleBase

See Also:

DocumentRuleBase.processCustomAddAdHocRoutePersonBusinessRules(org.kuali.rice.krad.document.Document, org.kuali.rice.krad.bo.AdHocRoutePerson)

processCustomAddAdHocRouteWorkgroupBusinessRules

protected boolean processCustomAddAdHocRouteWorkgroupBusinessRules(org.kuali.rice.krad.document.Document document,
                                                       org.kuali.rice.krad.bo.AdHocRouteWorkgroup workgroup)

Overrides:

processCustomAddAdHocRouteWorkgroupBusinessRules in class org.kuali.rice.krad.rules.DocumentRuleBase

See Also:

DocumentRuleBase.processCustomAddAdHocRouteWorkgroupBusinessRules(org.kuali.rice.krad.document.Document, org.kuali.rice.krad.bo.AdHocRouteWorkgroup)

processCustomAddNoteBusinessRules

protected boolean processCustomAddNoteBusinessRules(org.kuali.rice.krad.document.Document document,
                                        org.kuali.rice.krad.bo.Note note)

Overrides:

processCustomAddNoteBusinessRules in class org.kuali.rice.krad.rules.DocumentRuleBase

See Also:

DocumentRuleBase.processCustomAddNoteBusinessRules(org.kuali.rice.krad.document.Document, org.kuali.rice.krad.bo.Note)

processCustomApproveDocumentBusinessRules

protected boolean processCustomApproveDocumentBusinessRules(org.kuali.rice.krad.rules.rule.event.ApproveDocumentEvent approveEvent)

Overrides:

processCustomApproveDocumentBusinessRules in class org.kuali.rice.krad.rules.DocumentRuleBase

See Also:

org.kuali.rice.krad.rules.DocumentRuleBase#processCustomApproveDocumentBusinessRules(org.kuali.rice.krad.rule.event.ApproveDocumentEvent)

processCustomRouteDocumentBusinessRules

protected boolean processCustomRouteDocumentBusinessRules(org.kuali.rice.krad.document.Document document)

Overrides:

processCustomRouteDocumentBusinessRules in class org.kuali.rice.krad.rules.DocumentRuleBase

See Also:

DocumentRuleBase.processCustomRouteDocumentBusinessRules(org.kuali.rice.krad.document.Document)

processCustomSaveDocumentBusinessRules

protected boolean processCustomSaveDocumentBusinessRules(org.kuali.rice.krad.document.Document document)

Overrides:

processCustomSaveDocumentBusinessRules in class org.kuali.rice.krad.rules.DocumentRuleBase

See Also:

DocumentRuleBase.processCustomSaveDocumentBusinessRules(org.kuali.rice.krad.document.Document)

isDocumentAttributesValid

public boolean isDocumentAttributesValid(org.kuali.rice.krad.document.Document document,
                                boolean validateRequired)

Overrides:

isDocumentAttributesValid in class org.kuali.rice.krad.rules.DocumentRuleBase

See Also:

DocumentRuleBase.isDocumentAttributesValid(org.kuali.rice.krad.document.Document, boolean)