org.kuali.kra.proposaldevelopment.rules

Class BudgetModularTotalDirectCostRule

java.lang.Object

org.kuali.kra.proposaldevelopment.rules.BudgetModularTotalDirectCostRule

public final class BudgetModularTotalDirectCostRule
extends Object

This validates the Budget Modular's Total Direct Cost.

The validation methods in this class may produce errors and/or warnings.

The error handling behavior in this class is important to mention since it is a little different than the rest of KC. This class adds error messages directly to the GlobalVariables.getMessageMap() Make sure to add to the error map's path before calling the validate method. Currently warning are generated and placed in a Set<String>. This is different because warnings are not supported by the rice framework and therefore behave differently from errors. See getErrorMessages()

Constructor Summary

Constructors

Constructor and Description
BudgetModularTotalDirectCostRule()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	validateTotalDirectCost(BudgetParentDocument parentDocument, boolean reportErrors, Set<String> warningMessages) Validates the total direct cost (tdc) for each budget version.

Methods inherited from class java.lang.Object

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

Constructor Detail

BudgetModularTotalDirectCostRule

public BudgetModularTotalDirectCostRule()

Method Detail

validateTotalDirectCost

public boolean validateTotalDirectCost(BudgetParentDocument parentDocument,
                              boolean reportErrors,
                              Set<String> warningMessages)

Validates the total direct cost (tdc) for each budget version.

This method will validate tdc for every completed budget version that has a modular budget.

The tdc rule that this method is checking is whether or not the tdc contains a positive value. If none of the budget versions meeting the aforementioned criteria is positive than an error is produced. If at least one budget version meeting the aforementioned criteria is positive and at least one is not positive than a warning is produced.

Parameters:

parentDocument - the document to check rule against

reportErrors - whether to report errors

warningMessages - container to place warning messages. Warning messages are added to this set to be accessed by the caller.

Throws:

NullPointerException - if the pdDocument or warningMessages are null.