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

Class ReportingCodesRule

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.coa.document.validation.impl.ReportingCodesRule

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 ReportingCodesRule
extends org.kuali.rice.kns.maintenance.rules.MaintenanceDocumentRuleBase

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

Field Summary

Fields

Modifier and Type	Field and Description
protected org.kuali.rice.krad.service.BusinessObjectService	businessObjectService
protected ReportingCode	newReportingCode
protected ReportingCode	oldReportingCode

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

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

Constructor Summary

Constructors

Constructor and Description
ReportingCodesRule() Constructs a ReportingCodesRule and pseudo-injects services

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkReportsToReportingCode() This checks to see if the user has entered in two different values for the reporting code and the reports to reporting code.
protected boolean	processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document) This performs rules checks on document route ProjectCodeRule#checkReportsToReportingCode() This rule fails on business rule failures
protected boolean	processCustomSaveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document) This performs rules checks on document save ProjectCodeRule#checkReportsToReportingCode() This rule does not fail on business rule failures
protected void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService boService)
protected void	setupConvenienceObjects(org.kuali.rice.kns.document.MaintenanceDocument document) This method sets the convenience objects like newReportingCode and oldReportingCode, 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

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, processCustomApproveDocumentBusinessRules, 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

oldReportingCode

protected ReportingCode oldReportingCode

newReportingCode

protected ReportingCode newReportingCode

businessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService businessObjectService

Constructor Detail

ReportingCodesRule

public ReportingCodesRule()

Constructs a ReportingCodesRule and pseudo-injects services

Method Detail

processCustomRouteDocumentBusinessRules

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

This performs rules checks on document route

• ProjectCodeRule#checkReportsToReportingCode()

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

• ProjectCodeRule#checkReportsToReportingCode()

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

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

This method sets the convenience objects like newReportingCode and oldReportingCode, 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 -

checkReportsToReportingCode

protected boolean checkReportsToReportingCode()

This checks to see if the user has entered in two different values for the reporting code and the reports to reporting code. If they are different then it makes sure that the reports to reporting code actually exists in the system.

Returns:

true if the reports to reporting code is filled and exists or true if it isn't filled in (doesn't need to be), false otherwise

setBusinessObjectService

protected void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService boService)