public boolean processSyncModularBusinessRules(Document document) {
if (!(document instanceof BudgetDocument)) {
return false;
}
boolean valid = true;
BudgetDocument budgetDocument = (BudgetDocument) document;
GlobalVariables.getErrorMap().addToErrorPath("document");
List budgetPeriods = budgetDocument.getBudget().getBudgetPeriods();
if (ObjectUtils.isNotNull(budgetPeriods) || budgetPeriods.size() >= 1) {
BudgetPeriod period1 = (BudgetPeriod) budgetPeriods.get(0);
if (ObjectUtils.isNull(period1.getBudgetLineItems())
|| period1.getBudgetLineItems().isEmpty()) {
valid = false;
}
} else {
valid = false;
}
if (!valid) {
GlobalVariables.getErrorMap()
.putError("modularBudget", KeyConstants.ERROR_NO_DETAILED_BUDGET);
}
GlobalVariables.getErrorMap().removeFromErrorPath("document");
return valid;
}
/** {@inheritDoc} */
@Override
public ActionForward save(
ActionMapping mapping,
ActionForm form,
HttpServletRequest request,
HttpServletResponse response)
throws Exception {
BudgetForm budgetForm = (BudgetForm) form;
final BudgetDocument budgetDoc = budgetForm.getDocument();
fixDocHeaderVersion(budgetDoc);
Budget budget = budgetDoc.getBudget();
getBudgetCommonService(budgetDoc.getParentDocument()).calculateBudgetOnSave(budget);
ActionForward forward = super.save(mapping, form, request, response);
BudgetForm savedBudgetForm = (BudgetForm) form;
BudgetDocument savedBudgetDoc = savedBudgetForm.getDocument();
refreshBudgetDocumentVersion(savedBudgetDoc);
getBusinessObjectService().save(savedBudgetDoc.getParentDocument().getBudgetDocumentVersions());
final BudgetTDCValidator tdcValidator = new BudgetTDCValidator(request);
if (budgetForm.toBudgetVersionsPage()
|| "BudgetVersionsAction".equals(budgetForm.getActionName())) {
GlobalVariables.getErrorMap()
.addToErrorPath(KNSConstants.DOCUMENT_PROPERTY_NAME + ".proposal");
tdcValidator.validateGeneratingErrorsAndWarnings(budgetDoc.getParentDocument());
} else {
tdcValidator.validateGeneratingWarnings(budgetDoc.getParentDocument());
}
if (budgetForm.getMethodToCall().equals("save") && budgetForm.isAuditActivated()) {
if (Boolean.valueOf(savedBudgetDoc.getParentDocument().getProposalBudgetFlag())) {
forward = this.getReturnToProposalForward(budgetForm);
} else {
forward = mapping.findForward("budgetActions");
}
}
return forward;
}
@Override
protected boolean processCustomSaveDocumentBusinessRules(Document document) {
if (!(document instanceof BudgetDocument)) {
return false;
}
boolean valid = true;
BudgetDocument budgetDocument = (BudgetDocument) document;
GlobalVariables.getErrorMap().addToErrorPath("document");
getDictionaryValidationService()
.validateDocumentAndUpdatableReferencesRecursively(
document,
getMaxDictionaryValidationDepth(),
VALIDATION_REQUIRED,
CHOMP_LAST_LETTER_S_FROM_COLLECTION_NAME);
GlobalVariables.getErrorMap().addToErrorPath("parentDocument");
if (ObjectUtils.isNull(budgetDocument.getParentDocument())) {
budgetDocument.refreshReferenceObject("parentDocument");
}
if (Boolean.valueOf(budgetDocument.getParentDocument().getProposalBudgetFlag())) {
valid &= processBudgetVersionsBusinessRule(budgetDocument.getParentDocument(), true);
}
// else {
// valid &= processBudgetTypeBusinessRules(budgetDocument);
// }
GlobalVariables.getErrorMap().removeFromErrorPath("parentDocument");
GlobalVariables.getErrorMap().addToErrorPath("budget");
valid &= processBudgetPersonnelBusinessRules(budgetDocument);
valid &= processBudgetExpenseBusinessRules(budgetDocument);
valid &= processBudgetPersonnelBudgetBusinessRules(budgetDocument);
valid &= processBudgetRatesBusinessRule(budgetDocument);
valid &= processBudgetProjectIncomeBusinessRule(budgetDocument);
GlobalVariables.getErrorMap().removeFromErrorPath("budget");
GlobalVariables.getErrorMap().removeFromErrorPath("document");
return valid;
}
/**
* This method checks business rules related to Budget Personnel Budget functionality
*
* @param budgetDocument
* @return
*/
protected boolean processBudgetPersonnelBudgetBusinessRules(BudgetDocument budgetDocument) {
boolean valid = true;
ErrorMap errorMap = GlobalVariables.getErrorMap();
List<BudgetPeriod> budgetPeriods = budgetDocument.getBudget().getBudgetPeriods();
int i = 0;
int j = 0;
int k = 0;
for (BudgetPeriod budgetPeriod : budgetPeriods) {
j = 0;
List<BudgetLineItem> budgetLineItems = budgetPeriod.getBudgetLineItems();
k = 0;
for (BudgetLineItem budgetLineItem : budgetLineItems) {
for (BudgetPersonnelDetails budgetPersonnelDetails :
budgetLineItem.getBudgetPersonnelDetailsList()) {
if (budgetPersonnelDetails != null
&& budgetPersonnelDetails.getStartDate() != null
&& budgetPersonnelDetails.getStartDate().before(budgetLineItem.getStartDate())) {
errorMap.putError(
"budgetPeriod["
+ i
+ "].budgetLineItems["
+ j
+ "].budgetPersonnelDetailsList["
+ k
+ "].startDate",
KeyConstants.ERROR_PERSONNELBUDGETLINEITEM_STARTDATE_BEFORE_LINEITEM_STARTDATE);
valid = false;
}
if (budgetPersonnelDetails != null
&& budgetPersonnelDetails.getEndDate() != null
&& budgetPersonnelDetails.getEndDate().after(budgetLineItem.getEndDate())) {
errorMap.putError(
"budgetPeriod["
+ i
+ "].budgetLineItems["
+ j
+ "].budgetPersonnelDetailsList["
+ k
+ "].endDate",
KeyConstants.ERROR_PERSONNELBUDGETLINEITEM_ENDDATE_AFTER_LINEITEM_ENDDATE);
valid = false;
}
if (budgetPersonnelDetails.getPercentEffort().isLessThan(new BudgetDecimal(0))
|| budgetPersonnelDetails.getPercentEffort().isGreaterThan(new BudgetDecimal(100))) {
errorMap.putError(
"budgetPeriod["
+ i
+ "].budgetLineItems["
+ j
+ "].budgetPersonnelDetailsList["
+ k
+ "].percentEffort",
KeyConstants.ERROR_PERCENTAGE,
Constants.PERCENT_EFFORT_FIELD);
}
if (budgetPersonnelDetails.getPercentCharged().isLessThan(new BudgetDecimal(0))
|| budgetPersonnelDetails.getPercentCharged().isGreaterThan(new BudgetDecimal(100))) {
errorMap.putError(
"budgetPeriod["
+ i
+ "].budgetLineItems["
+ j
+ "].budgetPersonnelDetailsList["
+ k
+ "].percentCharged",
KeyConstants.ERROR_PERCENTAGE,
Constants.PERCENT_CHARGED_FIELD);
}
if (budgetPersonnelDetails
.getPercentCharged()
.isGreaterThan(budgetPersonnelDetails.getPercentEffort())) {
errorMap.putError(
"budgetPeriod["
+ i
+ "].budgetLineItems["
+ j
+ "].budgetPersonnelDetailsList["
+ k
+ "].percentCharged",
KeyConstants.ERROR_PERCENT_EFFORT_LESS_THAN_PERCENT_CHARGED);
}
k++;
}
j++;
}
i++;
}
return valid;
}
/**
* This method checks business rules related to Budget Expenses functionality
*
* @param budgetDocument
* @return
*/
protected boolean processBudgetExpenseBusinessRules(BudgetDocument budgetDocument) {
boolean valid = true;
// TODO - put budget expense validation rules here.
ErrorMap errorMap = GlobalVariables.getErrorMap();
List<BudgetPeriod> budgetPeriods = budgetDocument.getBudget().getBudgetPeriods();
int i = 0;
int j = 0;
for (BudgetPeriod budgetPeriod : budgetPeriods) {
j = 0;
List<BudgetLineItem> budgetLineItems = budgetPeriod.getBudgetLineItems();
for (BudgetLineItem budgetLineItem : budgetLineItems) {
if (budgetLineItem != null
&& budgetLineItem.getStartDate() != null
&& budgetLineItem.getStartDate().before(budgetPeriod.getStartDate())) {
errorMap.putError(
"budgetCategoryTypes["
+ budgetLineItem.getBudgetCategory().getBudgetCategoryTypeCode()
+ "].budgetPeriods["
+ i
+ "].budgetLineItems["
+ j
+ "].startDate",
KeyConstants.ERROR_LINEITEM_STARTDATE_BEFORE_PERIOD_STARTDATE);
valid = false;
}
if (budgetLineItem != null
&& budgetLineItem.getEndDate() != null
&& budgetLineItem.getEndDate().after(budgetPeriod.getEndDate())) {
errorMap.putError(
"budgetCategoryTypes["
+ budgetLineItem.getBudgetCategory().getBudgetCategoryTypeCode()
+ "].budgetPeriods["
+ i
+ "].budgetLineItems["
+ j
+ "].endDate",
KeyConstants.ERROR_LINEITEM_ENDDATE_AFTER_PERIOD_ENDDATE);
valid = false;
}
// if (budgetLineItem!=null && budgetLineItem.getCostSharingAmount() != null
// && budgetLineItem.getCostSharingAmount().isNegative()) {
// errorMap.putError("budgetPeriod[" + i +"].budgetLineItem[" + j +
// "].costSharingAmount", KeyConstants.ERROR_NEGATIVE_AMOUNT,"Cost Sharing");
// valid = false;
// }
if (budgetLineItem != null
&& budgetLineItem.getQuantity() != null
&& budgetLineItem.getQuantity().intValue() < 0) {
errorMap.putError(
"budgetPeriod[" + i + "].budgetLineItem[" + j + "].quantity",
KeyConstants.ERROR_NEGATIVE_AMOUNT,
"Quantity");
valid = false;
}
// if (budgetLineItem!=null && budgetLineItem.getLineItemCost() != null &&
// budgetLineItem.getLineItemCost().isNegative()) {
// errorMap.putError("budgetPeriod[" + i +"].budgetLineItem[" + j +
// "].lineItemCost", KeyConstants.ERROR_NEGATIVE_AMOUNT,"Total Base Cost");
// valid = false;
// }
// if(budgetLineItem.getEndDate().compareTo(budgetLineItem.getStartDate())
// <=0 ) {
//
// errorMap.putError("budgetPeriod["+i+"].budgetLineItem["+j+"].endDate",
// KeyConstants.ERROR_LINE_ITEM_DATES);
// return false;
// }
j++;
}
i++;
}
return valid;
}
/**
* Validate budget rates. Applicable rates are mandatory
*
* @param budgetDocument
* @return
*/
protected boolean processBudgetRatesBusinessRule(BudgetDocument budgetDocument) {
boolean valid = true;
final int APPLICABLE_RATE_LENGTH_EXCEEDED = 1;
final int APPLICABLE_RATE_NEGATIVE = -1;
ErrorMap errorMap = GlobalVariables.getErrorMap();
int i = 0;
for (BudgetRate budgetRate : budgetDocument.getBudget().getBudgetRates()) {
String rateClassType = budgetRate.getRateClass().getRateClassTypeT().getDescription();
String errorPath = "budgetProposalRate[" + rateClassType + "][" + i + "]";
errorMap.addToErrorPath(errorPath);
/* look for applicable rate */
if (budgetRate.isApplicableRateNull()) {
valid = false;
errorMap.putError("applicableRate", KeyConstants.ERROR_REQUIRED_APPLICABLE_RATE);
} else if (!BudgetDecimal.isNumeric(budgetRate.getApplicableRate().toString())) {
valid = false;
errorMap.putError("applicableRate", KeyConstants.ERROR_APPLICABLE_RATE_NOT_NUMERIC);
} else {
switch (verifyApplicableRate(budgetRate.getApplicableRate())) {
case APPLICABLE_RATE_LENGTH_EXCEEDED:
valid = false;
errorMap.putError(
"applicableRate",
KeyConstants.ERROR_APPLICABLE_RATE_LIMIT,
Constants.APPLICABLE_RATE_LIMIT);
break;
case APPLICABLE_RATE_NEGATIVE:
valid = false;
errorMap.putError("applicableRate", KeyConstants.ERROR_APPLICABLE_RATE_NEGATIVE);
break;
}
}
errorMap.removeFromErrorPath(errorPath);
i++;
}
i = 0;
for (BudgetLaRate budgetLaRate : budgetDocument.getBudget().getBudgetLaRates()) {
String rateClassType = "";
if (ObjectUtils.isNotNull(budgetLaRate.getRateClass())
&& ObjectUtils.isNotNull(budgetLaRate.getRateClass().getRateClassTypeT())) {
rateClassType = budgetLaRate.getRateClass().getRateClassTypeT().getDescription();
}
String errorPath = "budgetRate[" + rateClassType + "][" + i + "]";
errorMap.addToErrorPath(errorPath);
/* look for applicable rate */
if (budgetLaRate.isApplicableRateNull()) {
valid = false;
errorMap.putError("applicableRate", KeyConstants.ERROR_REQUIRED_APPLICABLE_RATE);
} else if (!BudgetDecimal.isNumeric(budgetLaRate.getApplicableRate().toString())) {
valid = false;
errorMap.putError("applicableRate", KeyConstants.ERROR_APPLICABLE_RATE_NOT_NUMERIC);
} else {
switch (verifyApplicableRate(budgetLaRate.getApplicableRate())) {
case APPLICABLE_RATE_LENGTH_EXCEEDED:
valid = false;
errorMap.putError(
"applicableRate",
KeyConstants.ERROR_APPLICABLE_RATE_LIMIT,
Constants.APPLICABLE_RATE_LIMIT);
break;
case APPLICABLE_RATE_NEGATIVE:
valid = false;
errorMap.putError("applicableRate", KeyConstants.ERROR_APPLICABLE_RATE_NEGATIVE);
break;
}
}
errorMap.removeFromErrorPath(errorPath);
i++;
}
return valid;
}
/**
* Validate budget project income. costshare percentage must be between 0 and 999.99
*
* @param budgetDocument
* @return
*/
protected boolean processBudgetProjectIncomeBusinessRule(BudgetDocument budgetDocument) {
boolean valid = true;
ErrorMap errorMap = GlobalVariables.getErrorMap();
int i = 0;
for (BudgetCostShare budgetCostShare : budgetDocument.getBudget().getBudgetCostShares()) {
String errorPath = "budgetCostShare[" + i + "]";
errorMap.addToErrorPath(errorPath);
if (budgetCostShare.getSharePercentage() != null
&& (budgetCostShare.getSharePercentage().isLessThan(new BudgetDecimal(0))
|| budgetCostShare.getSharePercentage().isGreaterThan(new BudgetDecimal(100)))) {
errorMap.putError("sharePercentage", KeyConstants.ERROR_COST_SHARE_PERCENTAGE);
valid = false;
}
// check for duplicate fiscal year and source accounts on all unchecked cost shares
if (i < budgetDocument.getBudget().getBudgetCostShareCount()) {
for (int j = i + 1; j < budgetDocument.getBudget().getBudgetCostShareCount(); j++) {
BudgetCostShare tmpCostShare = budgetDocument.getBudget().getBudgetCostShare(j);
int thisFiscalYear =
budgetCostShare.getProjectPeriod() == null
? Integer.MIN_VALUE
: budgetCostShare.getProjectPeriod();
int otherFiscalYear =
tmpCostShare.getProjectPeriod() == null
? Integer.MIN_VALUE
: tmpCostShare.getProjectPeriod();
if (thisFiscalYear == otherFiscalYear
&& StringUtils.equalsIgnoreCase(
budgetCostShare.getSourceAccount(), tmpCostShare.getSourceAccount())) {
errorMap.putError(
"fiscalYear",
KeyConstants.ERROR_COST_SHARE_DUPLICATE,
thisFiscalYear == Integer.MIN_VALUE ? "" : thisFiscalYear + "",
budgetCostShare.getSourceAccount() == null
? "\"\""
: budgetCostShare.getSourceAccount());
valid = false;
}
}
}
// validate project period stuff
String currentField = "document.budget.budgetCostShare[" + i + "].projectPeriod";
int numberOfProjectPeriods = budgetDocument.getBudget().getBudgetPeriods().size();
boolean validationCheck =
this.validateProjectPeriod(
budgetCostShare.getProjectPeriod(), currentField, numberOfProjectPeriods);
valid &= validationCheck;
errorMap.removeFromErrorPath(errorPath);
i++;
}
// check project income for values that are not greater than 0
GlobalVariables.getErrorMap().removeFromErrorPath("budget");
GlobalVariables.getErrorMap().addToErrorPath("budgets[0]");
i = 0;
for (BudgetProjectIncome budgetProjectIncome :
budgetDocument.getBudget().getBudgetProjectIncomes()) {
String errorPath = "budgetProjectIncomes[" + i + "]";
errorMap.addToErrorPath(errorPath);
if (budgetProjectIncome.getProjectIncome() == null
|| !budgetProjectIncome.getProjectIncome().isGreaterThan(new KualiDecimal(0.00))) {
errorMap.putError("projectIncome", "error.projectIncome.negativeOrZero");
valid = false;
}
errorMap.removeFromErrorPath(errorPath);
i++;
}
GlobalVariables.getErrorMap().removeFromErrorPath("budgets[0]");
GlobalVariables.getErrorMap().addToErrorPath("budget");
return valid;
}