org.kuali.ole.coa.document.validation.impl

Class DelegateRule

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.rice.kns.rules.DocumentRuleBase

org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

org.kuali.ole.sys.document.validation.impl.KfsMaintenanceDocumentRuleBase

org.kuali.ole.coa.document.validation.impl.DelegateRule

All Implemented Interfaces:

org.kuali.rice.kns.rule.AddCollectionLineRule, org.kuali.rice.kns.rules.MaintenanceDocumentRule, 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

public class DelegateRule
extends KfsMaintenanceDocumentRuleBase

Validates content of a AccountDelegate maintenance document upon triggering of a approve, save, or route event.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	LOG
protected AccountDelegate	newDelegate
protected AccountDelegate	oldDelegate

Fields inherited from class org.kuali.ole.sys.document.validation.impl.KfsMaintenanceDocumentRuleBase

financialSystemUserService, personService

Fields inherited from class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

boDictionaryService, boService, businessObjectAuthorizationService, businessObjectMetaDataService, configService, dataObjectMetaDataService, ddService, dictionaryValidationService, DOCUMENT_ERROR_PREFIX, documentHelperService, MAINTAINABLE_ERROR_PATH, MAINTAINABLE_ERROR_PREFIX, maintDocDictionaryService, persistenceStructureService, priorErrorPath, roleService, workflowDocumentService

Constructor Summary

Constructors

Constructor and Description
DelegateRule()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkDelegateUserRules(org.kuali.rice.kns.document.MaintenanceDocument document) This checks to see if the user is valid and active for this module
protected boolean	checkOnlyOnePrimaryRoute(org.kuali.rice.kns.document.MaintenanceDocument document) This checks to see if there is already a record for the primary route
protected boolean	checkSimpleRules() This checks to see if the delegate start date is valid and they are active from amount is >= 0 to amount cannot be empty when from amount is filled out to amount is >= from amount account cannot be closed
protected boolean	processCustomApproveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document) This runs specific rules that are called when a document is approved: checkSimpleRules() checkOnlyOnePrimaryRoute(MaintenanceDocument) checkDelegateUserRules(MaintenanceDocument)
protected boolean	processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document) This runs specific rules that are called when a document is routed: checkSimpleRules() checkOnlyOnePrimaryRoute(MaintenanceDocument) checkDelegateUserRules(MaintenanceDocument)
protected boolean	processCustomSaveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document) This runs specific rules that are called when a document is saved: checkSimpleRules() checkOnlyOnePrimaryRoute(MaintenanceDocument) checkDelegateUserRules(MaintenanceDocument)
protected void	setupConvenienceObjects(org.kuali.rice.kns.document.MaintenanceDocument document) This method sets the convenience objects like newAccount and oldAccount, so you have short and easy handles to the new and old objects contained in the maintenance document.

Methods inherited from class org.kuali.ole.sys.document.validation.impl.KfsMaintenanceDocumentRuleBase

getFinancialSystemUserService, getKfsUserService

Methods inherited from class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

checkEmptyBOField, checkEmptyDocumentField, checkEmptyValue, checkForPartiallyFilledOutReferenceForeignKeys, clearErrorPath, consolidateFieldNames, dataDictionaryValidate, errorAlreadyExists, getBoService, getConfigService, getDataObjectMetaDataService, getDateTimeService, getDdService, getDictionaryValidationService, getDocumentHelperService, getFieldLabel, getFieldLabel, getHumanReadablePrimaryKeyFieldNames, getMaintDocDictionaryService, getNewBo, getOldBo, getPersistenceStructureService, getPersonService, getRoleService, getWorkflowDocumentService, isCorrectMaintenanceClass, isDocumentInactivatingBusinessObject, isDocumentValidForSave, primaryKeyCheck, processAddCollectionLineBusinessRules, processApproveDocument, processCustomAddCollectionLineBusinessRules, processGlobalApproveDocumentBusinessRules, processGlobalRouteDocumentBusinessRules, processGlobalSaveDocumentBusinessRules, processInactivationBlockChecking, processInactivationBlockChecking, processRouteDocument, processSaveDocument, putDocumentError, putDocumentError, putFieldError, putFieldError, putFieldError, putFieldErrorWithShortLabel, putGlobalError, putGlobalError, putGlobalError, putGlobalsError, putGlobalsError, putInactivationBlockingErrorOnPage, resumeErrorPath, setBoDictionaryService, setBoService, setBusinessObjectAuthorizationService, setBusinessObjectMetaDataService, setConfigService, setDataObjectMetaDataService, setDdService, setDictionaryValidationService, setDocumentHelperService, setMaintDocDictionaryService, setNewBo, setPersistenceStructureService, setPersonService, setupBaseConvenienceObjects, setupConvenienceObjects, setWorkflowDocumentService, showErrorMap, validateDocumentStructure, validateDuplicateIdentifierInDataDictionary, validateGlobalBusinessObjectPersistable, validateMaintenanceDocument

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

buildDocumentTypeActionRequestPermissionDetails, buildDocumentTypePermissionDetails, getDataDictionaryService, getDocumentDictionaryService, getGroupService, getKualiConfigurationService, getMaxDictionaryValidationDepth, getPermissionService, hasAdHocRouteCompletion, isAddHocRoutePersonValid, isAddHocRouteWorkgroupValid, isAdHocRouteCompletionToInitiator, isAdHocRouteRecipientsValid, isDocumentAttributesValid, isDocumentOverviewValid, isNoteValid, processAddAdHocRoutePerson, processAddAdHocRouteWorkgroup, processAddNote, processCompleteDocument, processCustomAddAdHocRoutePersonBusinessRules, processCustomAddAdHocRouteWorkgroupBusinessRules, processCustomAddNoteBusinessRules, processCustomApproveDocumentBusinessRules, processCustomCompleteDocumentBusinessRules, processCustomRouteDocumentBusinessRules, processCustomSaveDocumentBusinessRules, processCustomSendAdHocRequests, processSendAdHocRequests, setDocumentDictionaryService, setMaxDictionaryValidationDepth, useKimPermission, validateSensitiveDataValue

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static final org.apache.log4j.Logger LOG

oldDelegate

protected AccountDelegate oldDelegate

newDelegate

protected AccountDelegate newDelegate

Constructor Detail

DelegateRule

public DelegateRule()

Method Detail

processCustomSaveDocumentBusinessRules

protected boolean processCustomSaveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document)

This runs specific rules that are called when a document is saved:

• checkSimpleRules()
• checkOnlyOnePrimaryRoute(MaintenanceDocument)
• checkDelegateUserRules(MaintenanceDocument)

Overrides:

processCustomSaveDocumentBusinessRules in class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

Returns:

doesn't fail on save, even if sub-rules fail

See Also:

MaintenanceDocumentRuleBase.processCustomSaveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)

processCustomRouteDocumentBusinessRules

protected boolean processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document)

This runs specific rules that are called when a document is routed:

• checkSimpleRules()
• checkOnlyOnePrimaryRoute(MaintenanceDocument)
• checkDelegateUserRules(MaintenanceDocument)

Overrides:

processCustomRouteDocumentBusinessRules in class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

Returns:

fails if sub-rules fail

See Also:

MaintenanceDocumentRuleBase.processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)

processCustomApproveDocumentBusinessRules

protected boolean processCustomApproveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document)

This runs specific rules that are called when a document is approved:

• checkSimpleRules()
• checkOnlyOnePrimaryRoute(MaintenanceDocument)
• checkDelegateUserRules(MaintenanceDocument)

Overrides:

processCustomApproveDocumentBusinessRules in class org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

See Also:

MaintenanceDocumentRuleBase.processCustomApproveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument)

setupConvenienceObjects

protected void setupConvenienceObjects(org.kuali.rice.kns.document.MaintenanceDocument document)

This method sets the convenience objects like newAccount and oldAccount, so you have short and easy handles to the new and old objects contained in the maintenance document. It also calls the BusinessObjectBase.refresh(), which will attempt to load all sub-objects from the DB by their primary keys, if available.

Parameters:

document - - the maintenanceDocument being evaluated

checkSimpleRules

protected boolean checkSimpleRules()

This checks to see if

• the delegate start date is valid and they are active
• from amount is >= 0
• to amount cannot be empty when from amount is filled out
• to amount is >= from amount
• account cannot be closed

Returns:

checkOnlyOnePrimaryRoute

protected boolean checkOnlyOnePrimaryRoute(org.kuali.rice.kns.document.MaintenanceDocument document)

This checks to see if there is already a record for the primary route

Parameters:

document -

Returns:

false if there is a record

checkDelegateUserRules

protected boolean checkDelegateUserRules(org.kuali.rice.kns.document.MaintenanceDocument document)

This checks to see if the user is valid and active for this module

Parameters:

document -

Returns:

false if this user is not valid or active for being a delegate