org.kuali.kfs.coa.document.validation.impl
Class ProjectCodeRule

java.lang.Object
  org.kuali.rice.kns.rules.DocumentRuleBase
      org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase
          org.kuali.kfs.coa.document.validation.impl.ProjectCodeRule

All Implemented Interfaces:

org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRule, org.kuali.rice.kns.rule.AddAdHocRoutePersonRule, org.kuali.rice.kns.rule.AddAdHocRouteWorkgroupRule, org.kuali.rice.kns.rule.AddCollectionLineRule, org.kuali.rice.kns.rule.AddNoteRule, org.kuali.rice.kns.rule.ApproveDocumentRule, org.kuali.rice.kns.rule.BusinessRule, org.kuali.rice.kns.rule.RouteDocumentRule, org.kuali.rice.kns.rule.SaveDocumentRule, org.kuali.rice.kns.rule.SendAdHocRequestsRule

public class ProjectCodeRule
extends org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

This class implements the business rules specific to the ProjectCode Maintenance Document.

Field Summary

protected static org.apache.log4j.Logger	LOG
protected ProjectCode	newProjectCode
protected ProjectCode	oldProjectCode

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

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

Constructor Summary

ProjectCodeRule()

Method Summary

protected boolean	checkExistenceAndActive() This method currently doesn't do anything
protected boolean	processCustomApproveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document) This performs rules checks on document approve checkExistenceAndActive() This rule fails on business rule failures
protected boolean	processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document) This performs rules checks on document route checkExistenceAndActive() This rule fails on business rule failures
protected boolean	processCustomSaveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document) This performs rules checks on document save checkExistenceAndActive() This rule does not fail on business rule failures
void	setupConvenienceObjects() This method sets the convenience objects like newProjectCode and oldProjectCode, so you have short and easy handles to the new and old objects contained in the maintenance document.

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

apcRuleFails, applyApcRule, checkEmptyBOField, checkEmptyDocumentField, checkEmptyValue, checkForPartiallyFilledOutReferenceForeignKeys, clearErrorPath, consolidateFieldNames, dataDictionaryValidate, errorAlreadyExists, getBoDictionaryService, getBoService, getBusinessObjectAuthorizationService, getConfigService, getDateTimeService, getDdService, getDictionaryValidationService, getDocumentHelperService, getFieldLabel, getFieldLabel, getHumanReadablePrimaryKeyFieldNames, getMaintDocDictionaryService, getNewBo, getOldBo, getPersistenceService, 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, setConfigService, setDdService, setDictionaryValidationService, setDocumentHelperService, setMaintDocDictionaryService, setNewBo, setPersistenceService, setPersistenceStructureService, setPersonService, setupBaseConvenienceObjects, setWorkflowDocumentService, showErrorMap, validateDocumentStructure, validateDuplicateIdentifierInDataDictionary, validateGlobalBusinessObjectPersistable, validateMaintenanceDocument

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

getDataDictionaryService, getIdentityManagementService, getKualiConfigurationService, getMaxDictionaryValidationDepth, getWorkflowInfoService, isAddHocRoutePersonValid, isAddHocRouteWorkgroupValid, isAdHocRouteRecipientsValid, isDocumentAttributesValid, isDocumentOverviewValid, isNoteValid, processAddAdHocRoutePerson, processAddAdHocRouteWorkgroup, processAddNote, processCustomAddAdHocRoutePersonBusinessRules, processCustomAddAdHocRouteWorkgroupBusinessRules, processCustomAddNoteBusinessRules, processCustomApproveDocumentBusinessRules, processCustomRouteDocumentBusinessRules, processCustomSaveDocumentBusinessRules, processCustomSendAdHocRequests, processSendAdHocRequests, setMaxDictionaryValidationDepth, validateSensitiveDataValue

Methods inherited from class java.lang.Object

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

Field Detail

LOG

protected static org.apache.log4j.Logger LOG

oldProjectCode

protected ProjectCode oldProjectCode

newProjectCode

protected ProjectCode newProjectCode

Constructor Detail

ProjectCodeRule

public ProjectCodeRule()

Method Detail

processCustomApproveDocumentBusinessRules

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

This performs rules checks on document approve

• checkExistenceAndActive()

This rule fails on business rule failures

Overrides:

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

See Also:

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

processCustomRouteDocumentBusinessRules

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

This performs rules checks on document route

• checkExistenceAndActive()

This rule fails on business rule failures

Overrides:

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

See Also:

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

processCustomSaveDocumentBusinessRules

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

This performs rules checks on document save

• checkExistenceAndActive()

This rule does not fail on business rule failures

Overrides:

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

See Also:

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

setupConvenienceObjects

public void setupConvenienceObjects()

This method sets the convenience objects like newProjectCode and oldProjectCode, 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.

Specified by:

setupConvenienceObjects in interface org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRule

Overrides:

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

Parameters:

document - - the maintenanceDocument being evaluated

checkExistenceAndActive

protected boolean checkExistenceAndActive()

This method currently doesn't do anything

Returns:

true