Java tutorial
/* * The Kuali Financial System, a comprehensive financial management system for higher education. * * Copyright 2005-2014 The Kuali Foundation * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as * published by the Free Software Foundation, either version 3 of the * License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public License * along with this program. If not, see <http://www.gnu.org/licenses/>. */ package org.kuali.kfs.fp.document.validation.impl; import static org.kuali.kfs.sys.KFSConstants.AMOUNT_PROPERTY_NAME; import static org.kuali.kfs.sys.KFSConstants.CREDIT_AMOUNT_PROPERTY_NAME; import static org.kuali.kfs.sys.KFSConstants.DEBIT_AMOUNT_PROPERTY_NAME; import static org.kuali.kfs.sys.KFSConstants.GL_DEBIT_CODE; import static org.kuali.kfs.sys.KFSConstants.JOURNAL_LINE_HELPER_PROPERTY_NAME; import static org.kuali.kfs.sys.KFSConstants.NEW_SOURCE_ACCT_LINE_PROPERTY_NAME; import static org.kuali.kfs.sys.KFSConstants.SQUARE_BRACKET_LEFT; import static org.kuali.kfs.sys.KFSConstants.SQUARE_BRACKET_RIGHT; import static org.kuali.kfs.sys.KFSConstants.VOUCHER_LINE_HELPER_CREDIT_PROPERTY_NAME; import static org.kuali.kfs.sys.KFSConstants.VOUCHER_LINE_HELPER_DEBIT_PROPERTY_NAME; import static org.kuali.kfs.sys.KFSKeyConstants.ERROR_ZERO_AMOUNT; import static org.kuali.kfs.sys.KFSKeyConstants.ERROR_ZERO_OR_NEGATIVE_AMOUNT; import static org.kuali.kfs.sys.KFSKeyConstants.JournalVoucher.ERROR_NEGATIVE_NON_BUDGET_AMOUNTS; import static org.kuali.kfs.sys.KFSPropertyConstants.BALANCE_TYPE; import java.util.Collection; import org.apache.commons.lang.StringUtils; import org.kuali.kfs.fp.document.JournalVoucherDocument; import org.kuali.kfs.sys.KFSParameterKeyConstants; import org.kuali.kfs.sys.businessobject.AccountingLine; import org.kuali.kfs.sys.context.SpringContext; import org.kuali.kfs.sys.document.validation.GenericValidation; import org.kuali.kfs.sys.document.validation.event.AttributedDocumentEvent; import org.kuali.rice.core.api.util.type.KualiDecimal; import org.kuali.rice.coreservice.framework.parameter.ParameterService; import org.kuali.rice.krad.util.GlobalVariables; /** * The Journal Voucher's version of the accounting line amount validation */ public class JournalVoucherAccountingLineAmountValidation extends GenericValidation { private JournalVoucherDocument journalVoucherForValidation; private AccountingLine accountingLineForValidation; /** * Accounting lines for Journal Vouchers can be positive or negative, just not "$0.00". * * Additionally, accounting lines cannot have negative dollar amounts if the balance type of the * journal voucher allows for general ledger pending entry offset generation or the balance type * is not a budget type code. * @see org.kuali.kfs.sys.document.validation.Validation#validate(org.kuali.kfs.sys.document.validation.event.AttributedDocumentEvent) */ @Override public boolean validate(AttributedDocumentEvent event) { KualiDecimal amount = getAccountingLineForValidation().getAmount(); getJournalVoucherForValidation().refreshReferenceObject(BALANCE_TYPE); if (getJournalVoucherForValidation().getBalanceType().isFinancialOffsetGenerationIndicator()) { // check for negative or zero amounts if (amount.isZero()) { // if 0 GlobalVariables.getMessageMap().putErrorWithoutFullErrorPath( buildMessageMapKeyPathForDebitCreditAmount(true), ERROR_ZERO_OR_NEGATIVE_AMOUNT, "an accounting line"); GlobalVariables.getMessageMap().putErrorWithoutFullErrorPath( buildMessageMapKeyPathForDebitCreditAmount(false), ERROR_ZERO_OR_NEGATIVE_AMOUNT, "an accounting line"); return false; } else if (amount.isNegative()) { // entered a negative number String debitCreditCode = getAccountingLineForValidation().getDebitCreditCode(); if (StringUtils.isNotBlank(debitCreditCode) && GL_DEBIT_CODE.equals(debitCreditCode)) { GlobalVariables.getMessageMap().putErrorWithoutFullErrorPath( buildMessageMapKeyPathForDebitCreditAmount(true), ERROR_ZERO_OR_NEGATIVE_AMOUNT, "an accounting line"); } else { GlobalVariables.getMessageMap().putErrorWithoutFullErrorPath( buildMessageMapKeyPathForDebitCreditAmount(false), ERROR_ZERO_OR_NEGATIVE_AMOUNT, "an accounting line"); } return false; } } else { // Check for zero amounts if (amount.isZero()) { // amount == 0 GlobalVariables.getMessageMap().putError(AMOUNT_PROPERTY_NAME, ERROR_ZERO_AMOUNT, "an accounting line"); return false; } else if (amount.isNegative()) { if (!allowNegativeAmounts(getAccountingLineForValidation())) { GlobalVariables.getMessageMap().putError(AMOUNT_PROPERTY_NAME, ERROR_NEGATIVE_NON_BUDGET_AMOUNTS); } } } return true; } /** * This method retrieves the parameter values that define the allowable balance type codes and determines if negative amounts * are allowed for the associated accounting line. * * @param acctLine The accounting line which will be used to determine if negative amounts are allowed. * @return True if the accounting line has a balance type found in the associated parameter, false otherwise. */ private boolean allowNegativeAmounts(AccountingLine acctLine) { Collection<String> budgetTypes = SpringContext.getBean(ParameterService.class).getParameterValuesAsString( JournalVoucherDocument.class, KFSParameterKeyConstants.FpParameterConstants.FP_BUDGET_BALANCE_TYPES); return budgetTypes.contains(acctLine.getBalanceTypeCode()); } /** * This method looks at the current full key path that exists in the MessageMap structure to determine how to build * the error map for the special journal voucher credit and debit fields since they don't conform to the standard * pattern of accounting lines. * * The error map key path is also dependent on whether or not the accounting line containing an error is a new * accounting line or an existing line that is being updated. This determination is made by searching for * NEW_SOURCE_ACCT_LINE_PROPERTY_NAME in the error path of the global error map. * * @param isDebit Identifies whether or not the line we are returning an error path for is a debit accounting line or not. * @return The full error map key path for the appropriate amount type. */ protected String buildMessageMapKeyPathForDebitCreditAmount(boolean isDebit) { // determine if we are looking at a new line add or an update boolean isNewLineAdd = GlobalVariables.getMessageMap().getErrorPath() .contains(NEW_SOURCE_ACCT_LINE_PROPERTY_NAME); isNewLineAdd |= GlobalVariables.getMessageMap().getErrorPath().contains(NEW_SOURCE_ACCT_LINE_PROPERTY_NAME); if (isNewLineAdd) { return isDebit ? DEBIT_AMOUNT_PROPERTY_NAME : CREDIT_AMOUNT_PROPERTY_NAME; } else { String index = StringUtils.substringBetween(GlobalVariables.getMessageMap().getKeyPath("", true), SQUARE_BRACKET_LEFT, SQUARE_BRACKET_RIGHT); String indexWithParams = SQUARE_BRACKET_LEFT + index + SQUARE_BRACKET_RIGHT; return isDebit ? (JOURNAL_LINE_HELPER_PROPERTY_NAME + indexWithParams + VOUCHER_LINE_HELPER_DEBIT_PROPERTY_NAME) : (JOURNAL_LINE_HELPER_PROPERTY_NAME + indexWithParams + VOUCHER_LINE_HELPER_CREDIT_PROPERTY_NAME); } } /** * Gets the accountingLineForValidation attribute. * @return Returns the accountingLineForValidation. */ public AccountingLine getAccountingLineForValidation() { return accountingLineForValidation; } /** * Sets the accountingLineForValidation attribute value. * @param accountingLineForValidation The accountingLineForValidation to set. */ public void setAccountingLineForValidation(AccountingLine accountingLineForValidation) { this.accountingLineForValidation = accountingLineForValidation; } /** * Gets the journalVoucherForValidation attribute. * @return Returns the journalVoucherForValidation. */ public JournalVoucherDocument getJournalVoucherForValidation() { return journalVoucherForValidation; } /** * Sets the journalVoucherForValidation attribute value. * @param journalVoucherForValidation The journalVoucherForValidation to set. */ public void setJournalVoucherForValidation(JournalVoucherDocument journalVoucherForValidation) { this.journalVoucherForValidation = journalVoucherForValidation; } }