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

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

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

Business rule(s) applicable to AccountingPeriodMaintence documents.

Field Summary

protected static String	BUDGET_RECORDING_LEVEL_MIXED
protected static String	ENDOWMENT_FUND_CD
protected static String	GENERAL_FUND_CD
protected static org.apache.log4j.Logger	LOG
protected AccountingPeriod	newAccountingPeriod
protected AccountingPeriod	oldAccountingPeriod
protected static String	PLANT_FUND_CD
protected static String	RESTRICTED_CD_RESTRICTED
protected static String	RESTRICTED_CD_TEMPORARILY_RESTRICTED
protected static String	RESTRICTED_CD_UNRESTRICTED
protected static String	RESTRICTED_FUND_CD
protected static String	SUB_FUND_GROUP_MEDICAL_PRACTICE_FUNDS

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

AccountingPeriodRule()

Method Summary

protected boolean	processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document) This method checks to see if the fiscal year for any of Options is the same as the AccountingPeriod's fiscal year
protected boolean	processCustomSaveDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document) This method checks the following rules: calls processCustomRouteDocumentBusinessRules but does not fail if any of them fail (this only happens on routing)
void	setupConvenienceObjects() 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.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, processCustomApproveDocumentBusinessRules, 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

GENERAL_FUND_CD

protected static final String GENERAL_FUND_CD

See Also:

Constant Field Values

RESTRICTED_FUND_CD

protected static final String RESTRICTED_FUND_CD

See Also:

Constant Field Values

ENDOWMENT_FUND_CD

protected static final String ENDOWMENT_FUND_CD

See Also:

Constant Field Values

PLANT_FUND_CD

protected static final String PLANT_FUND_CD

See Also:

Constant Field Values

RESTRICTED_CD_RESTRICTED

protected static final String RESTRICTED_CD_RESTRICTED

See Also:

Constant Field Values

RESTRICTED_CD_UNRESTRICTED

protected static final String RESTRICTED_CD_UNRESTRICTED

See Also:

Constant Field Values

RESTRICTED_CD_TEMPORARILY_RESTRICTED

protected static final String RESTRICTED_CD_TEMPORARILY_RESTRICTED

See Also:

Constant Field Values

SUB_FUND_GROUP_MEDICAL_PRACTICE_FUNDS

protected static final String SUB_FUND_GROUP_MEDICAL_PRACTICE_FUNDS

See Also:

Constant Field Values

BUDGET_RECORDING_LEVEL_MIXED

protected static final String BUDGET_RECORDING_LEVEL_MIXED

See Also:

Constant Field Values

oldAccountingPeriod

protected AccountingPeriod oldAccountingPeriod

newAccountingPeriod

protected AccountingPeriod newAccountingPeriod

Constructor Detail

AccountingPeriodRule

public AccountingPeriodRule()

Method Detail

setupConvenienceObjects

public void setupConvenienceObjects()

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.

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

processCustomSaveDocumentBusinessRules

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

This method checks the following rules: calls processCustomRouteDocumentBusinessRules but does not fail if any of them fail (this only happens on routing)

Overrides:

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

See Also:

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

processCustomRouteDocumentBusinessRules

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

This method checks to see if the fiscal year for any of Options is the same as the AccountingPeriod's fiscal year

Overrides:

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

See Also:

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