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

Class IndirectCostRecoveryAccountsRule

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.IndirectCostRecoveryAccountsRule

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

Direct Known Subclasses:

AccountRule, SubAccountRule

public abstract class IndirectCostRecoveryAccountsRule
extends KfsMaintenanceDocumentRuleBase

Business rule(s) applicable to AccountMaintenance documents.

Field Summary

Fields

Modifier and Type	Field and Description
protected static BigDecimal	BD100
protected String	boFieldPath
protected static org.apache.log4j.Logger	LOG

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
IndirectCostRecoveryAccountsRule()

Method Summary

Methods

Modifier and Type	Method and Description
protected boolean	checkICRCollectionExist(boolean expectFilled) This method checks if the ICR collection should or should not be filled error message is not handled in the function
protected boolean	checkICRCollectionExistWithErrorMessage(boolean expectFilled, String errorMessage, String args) This method checks if the ICR collection should or should not be filled add error message if validation is not successful
protected boolean	checkIndirectCostRecoveryAccount(IndirectCostRecoveryAccount icrAccount) Check valid IndirectCostRecovery Account
protected boolean	checkIndirectCostRecoveryAccount(String chartOfAccountsCode, String accountNumber, BigDecimal icraAccountLinePercentage)
protected boolean	checkIndirectCostRecoveryAccountDistributions() Check the collection list of indirect cost recovery account 1.
List<? extends IndirectCostRecoveryAccount>	getActiveIndirectCostRecoveryAccountList()
String	getBoFieldPath()
protected String	getDDAttributeLabel(String attribute) Get the attribute label from DataDictionary
boolean	processCustomAddCollectionLineBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document, String collectionName, org.kuali.rice.krad.bo.PersistableBusinessObject bo) Custom processing for adding collection lines
protected boolean	processCustomRouteDocumentBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document) This method calls the rule: OLEPropertyConstants.INDIRECT_COST_RECOVERY_ACCOUNT
void	setActiveIndirectCostRecoveryAccountList(List<? extends IndirectCostRecoveryAccount> indirectCostRecoveryAccountList)
void	setBoFieldPath(String boFieldPath)

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

BD100

protected static final BigDecimal BD100

boFieldPath

protected String boFieldPath

Constructor Detail

IndirectCostRecoveryAccountsRule

public IndirectCostRecoveryAccountsRule()

Method Detail

processCustomAddCollectionLineBusinessRules

public boolean processCustomAddCollectionLineBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument document,
                                                  String collectionName,
                                                  org.kuali.rice.krad.bo.PersistableBusinessObject bo)

Custom processing for adding collection lines

Overrides:

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

See Also:

MaintenanceDocumentRuleBase.processCustomAddCollectionLineBusinessRules(org.kuali.rice.kns.document.MaintenanceDocument, java.lang.String, org.kuali.rice.krad.bo.PersistableBusinessObject)

processCustomRouteDocumentBusinessRules

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

This method calls the rule: OLEPropertyConstants.INDIRECT_COST_RECOVERY_ACCOUNT

Overrides:

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

See Also:

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

checkICRCollectionExist

protected boolean checkICRCollectionExist(boolean expectFilled)

This method checks if the ICR collection should or should not be filled error message is not handled in the function

Parameters:

expectFilled -

Returns:

checkICRCollectionExistWithErrorMessage

protected boolean checkICRCollectionExistWithErrorMessage(boolean expectFilled,
                                              String errorMessage,
                                              String args)

This method checks if the ICR collection should or should not be filled add error message if validation is not successful

Parameters:

expectFilled -

errorMessage -

args -

Returns:

checkIndirectCostRecoveryAccount

protected boolean checkIndirectCostRecoveryAccount(IndirectCostRecoveryAccount icrAccount)

Check valid IndirectCostRecovery Account

Returns:

checkIndirectCostRecoveryAccount

protected boolean checkIndirectCostRecoveryAccount(String chartOfAccountsCode,
                                       String accountNumber,
                                       BigDecimal icraAccountLinePercentage)

checkIndirectCostRecoveryAccountDistributions

protected boolean checkIndirectCostRecoveryAccountDistributions()

Check the collection list of indirect cost recovery account 1. Check each account with rule: checkIndirectCostRecoveryAccount 2. Total distributions from all the account should be 100

Parameters:

document -

Returns:

getDDAttributeLabel

protected String getDDAttributeLabel(String attribute)

Get the attribute label from DataDictionary

Parameters:

attribute -

Returns:

getActiveIndirectCostRecoveryAccountList

public List<? extends IndirectCostRecoveryAccount> getActiveIndirectCostRecoveryAccountList()

setActiveIndirectCostRecoveryAccountList

public void setActiveIndirectCostRecoveryAccountList(List<? extends IndirectCostRecoveryAccount> indirectCostRecoveryAccountList)

getBoFieldPath

public String getBoFieldPath()

setBoFieldPath

public void setBoFieldPath(String boFieldPath)