org.kuali.kra.budget.document

Class BudgetDocumentRule

java.lang.Object

org.kuali.rice.krad.rules.DocumentRuleBase

org.kuali.kra.rules.ResearchDocumentRuleBase

org.kuali.kra.costshare.CostShareRuleResearchDocumentBase

org.kuali.kra.budget.document.BudgetDocumentRule

All Implemented Interfaces:

AddBudgetCostShareRule, AddBudgetProjectIncomeRule, AddBudgetPeriodRule, DeleteBudgetPeriodRule, GenerateBudgetPeriodRule, SaveBudgetPeriodRule, SyncModularBudgetRule, 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.DocumentAuditRule, org.kuali.rice.krad.rules.rule.RouteDocumentRule, org.kuali.rice.krad.rules.rule.SaveDocumentRule, org.kuali.rice.krad.rules.rule.SendAdHocRequestsRule

Direct Known Subclasses:

AwardBudgetDocumentRule

public class BudgetDocumentRule
extends CostShareRuleResearchDocumentBase
implements AddBudgetPeriodRule, AddBudgetCostShareRule, AddBudgetProjectIncomeRule, SaveBudgetPeriodRule, DeleteBudgetPeriodRule, GenerateBudgetPeriodRule, org.kuali.rice.krad.rules.rule.DocumentAuditRule, SyncModularBudgetRule

Field Summary

Fields inherited from class org.kuali.kra.rules.ResearchDocumentRuleBase

CHOMP_LAST_LETTER_S_FROM_COLLECTION_NAME, DOCUMENT_ERROR_PATH, VALIDATION_REQUIRED

Constructor Summary

Constructors

Constructor and Description
BudgetDocumentRule()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	processAddBudgetCostShareBusinessRules(AddBudgetCostShareEvent addBudgetCostShareEvent) ProcessDefinitionDefinitionDefinition business rules for add of BudgetCostShare
boolean	processAddBudgetPeriodBusinessRules(AddBudgetPeriodEvent addBudgetPeriodEvent) Rule invoked upon adding a budget period BudgetDocument
boolean	processAddBudgetProjectIncomeBusinessRules(AddBudgetProjectIncomeEvent addBudgetIncomeEvent)
protected boolean	processBudgetExpenseBusinessRules(BudgetDocument budgetDocument) This method checks business rules related to Budget Expenses functionality
protected boolean	processBudgetPersonnelBudgetBusinessRules(BudgetDocument budgetDocument) This method checks business rules related to Budget Personnel Budget functionality
protected boolean	processBudgetPersonnelBusinessRules(BudgetDocument budgetDocument) This method checks business rules related to Budget Personnel functionality
protected boolean	processBudgetProjectIncomeBusinessRule(BudgetDocument budgetDocument) Validate budget project income.
protected boolean	processBudgetRatesBusinessRule(BudgetDocument budgetDocument) Validate budget rates.
protected boolean	processCustomSaveDocumentBusinessRules(org.kuali.rice.krad.document.Document document)
boolean	processDeleteBudgetPeriodBusinessRules(DeleteBudgetPeriodEvent deleteBudgetPeriodEvent) Rule invoked upon adding a budget period BudgetDocument
boolean	processGenerateBudgetPeriodBusinessRules(GenerateBudgetPeriodEvent generateBudgetPeriodEvent) Rule invoked upon generating budget period BudgetDocument
protected boolean	processRunAuditBudgetVersionRule(BudgetParentDocument parentDocument)
boolean	processRunAuditBusinessRules(org.kuali.rice.krad.document.Document document)
boolean	processSaveBudgetPeriodBusinessRules(SaveBudgetPeriodEvent saveBudgetPeriodEvent) Rule invoked upon adding a budget period BudgetDocument
boolean	processSyncModularBusinessRules(org.kuali.rice.krad.document.Document document)

Methods inherited from class org.kuali.kra.costshare.CostShareRuleResearchDocumentBase

getCostShareService, setCostShareService, validatePeriodNumber, validateProjectPeriod, validateProjectPeriod

Methods inherited from class org.kuali.kra.rules.ResearchDocumentRuleBase

addAuditError, getBusinessObjectService, getErrorReporter, getKnsDictionaryValidationService, getParameterService, getSoftErrors, hasPermission, hasPermission, hasRole, hasRole, isInvalid, isValid, keyValue, processBudgetVersionsBusinessRule, reportError, reportErrorWithoutFullErrorPath, reportSoftError, reportWarning, setBusinessObjectService, setParameterService

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

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

Methods inherited from class java.lang.Object

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

Constructor Detail

BudgetDocumentRule

public BudgetDocumentRule()

Method Detail

processAddBudgetCostShareBusinessRules

public boolean processAddBudgetCostShareBusinessRules(AddBudgetCostShareEvent addBudgetCostShareEvent)

Description copied from interface: AddBudgetCostShareRule

ProcessDefinitionDefinitionDefinition business rules for add of BudgetCostShare

Specified by:

processAddBudgetCostShareBusinessRules in interface AddBudgetCostShareRule

Returns:

See Also:

AddBudgetCostShareRule.processAddBudgetCostShareBusinessRules(org.kuali.kra.budget.distributionincome.AddBudgetCostShareEvent)

processAddBudgetPeriodBusinessRules

public boolean processAddBudgetPeriodBusinessRules(AddBudgetPeriodEvent addBudgetPeriodEvent)

Description copied from interface: AddBudgetPeriodRule

Rule invoked upon adding a budget period BudgetDocument

Specified by:

processAddBudgetPeriodBusinessRules in interface AddBudgetPeriodRule

Returns:

boolean

See Also:

org.kuali.kra.budget.parameters.AddBudgetPeriodRule#processAddBudgetPeriodBusinessRules(org.kuali.kra.budget.document.BudgetDocument,org.kuali.kra.budget.parameters.BudgetPeriod)

processAddBudgetProjectIncomeBusinessRules

public boolean processAddBudgetProjectIncomeBusinessRules(AddBudgetProjectIncomeEvent addBudgetIncomeEvent)

Specified by:

processAddBudgetProjectIncomeBusinessRules in interface AddBudgetProjectIncomeRule

See Also:

AddBudgetProjectIncomeRule.processAddBudgetProjectIncomeBusinessRules(org.kuali.kra.budget.distributionincome.AddBudgetProjectIncomeEvent)

processSaveBudgetPeriodBusinessRules

public boolean processSaveBudgetPeriodBusinessRules(SaveBudgetPeriodEvent saveBudgetPeriodEvent)

Description copied from interface: SaveBudgetPeriodRule

Rule invoked upon adding a budget period BudgetDocument

Specified by:

processSaveBudgetPeriodBusinessRules in interface SaveBudgetPeriodRule

Returns:

boolean

processDeleteBudgetPeriodBusinessRules

public boolean processDeleteBudgetPeriodBusinessRules(DeleteBudgetPeriodEvent deleteBudgetPeriodEvent)

Description copied from interface: DeleteBudgetPeriodRule

Rule invoked upon adding a budget period BudgetDocument

Specified by:

processDeleteBudgetPeriodBusinessRules in interface DeleteBudgetPeriodRule

Returns:

boolean

processGenerateBudgetPeriodBusinessRules

public boolean processGenerateBudgetPeriodBusinessRules(GenerateBudgetPeriodEvent generateBudgetPeriodEvent)

Description copied from interface: GenerateBudgetPeriodRule

Rule invoked upon generating budget period BudgetDocument

Specified by:

processGenerateBudgetPeriodBusinessRules in interface GenerateBudgetPeriodRule

Returns:

boolean

processCustomSaveDocumentBusinessRules

protected boolean processCustomSaveDocumentBusinessRules(org.kuali.rice.krad.document.Document document)

Overrides:

processCustomSaveDocumentBusinessRules in class org.kuali.rice.krad.rules.DocumentRuleBase

processBudgetProjectIncomeBusinessRule

protected boolean processBudgetProjectIncomeBusinessRule(BudgetDocument budgetDocument)

Validate budget project income. costshare percentage must be between 0 and 999.99

Parameters:

budgetDocument -

Returns:

processBudgetRatesBusinessRule

protected boolean processBudgetRatesBusinessRule(BudgetDocument budgetDocument)

Validate budget rates. Applicable rates are mandatory

Parameters:

budgetDocument -

Returns:

processBudgetPersonnelBusinessRules

protected boolean processBudgetPersonnelBusinessRules(BudgetDocument budgetDocument)

This method checks business rules related to Budget Personnel functionality

Parameters:

budgetDocument -

Returns:

processBudgetExpenseBusinessRules

protected boolean processBudgetExpenseBusinessRules(BudgetDocument budgetDocument)

This method checks business rules related to Budget Expenses functionality

Parameters:

budgetDocument -

Returns:

processBudgetPersonnelBudgetBusinessRules

protected boolean processBudgetPersonnelBudgetBusinessRules(BudgetDocument budgetDocument)

This method checks business rules related to Budget Personnel Budget functionality

Parameters:

budgetDocument -

Returns:

processRunAuditBusinessRules

public boolean processRunAuditBusinessRules(org.kuali.rice.krad.document.Document document)

Specified by:

processRunAuditBusinessRules in interface org.kuali.rice.krad.rules.rule.DocumentAuditRule

Overrides:

processRunAuditBusinessRules in class ResearchDocumentRuleBase

See Also:

DocumentAuditRule.processRunAuditBusinessRules(org.kuali.rice.krad.document.Document)

processRunAuditBudgetVersionRule

protected boolean processRunAuditBudgetVersionRule(BudgetParentDocument parentDocument)

processSyncModularBusinessRules

public boolean processSyncModularBusinessRules(org.kuali.rice.krad.document.Document document)

Specified by:

processSyncModularBusinessRules in interface SyncModularBudgetRule