001    /*
002     * Copyright 2011 The Kuali Foundation.
003     * 
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     * 
008     * http://www.opensource.org/licenses/ecl2.php
009     * 
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.kfs.fp.document.validation.impl;
017    
018    import static org.kuali.kfs.sys.KFSConstants.ACCOUNTING_LINE_ERRORS;
019    import static org.kuali.kfs.sys.KFSKeyConstants.ERROR_DOCUMENT_BALANCE_CONSIDERING_CREDIT_AND_DEBIT_AMOUNTS;
020    
021    import org.kuali.kfs.fp.document.AuxiliaryVoucherDocument;
022    import org.kuali.kfs.sys.document.validation.GenericValidation;
023    import org.kuali.kfs.sys.document.validation.event.AttributedDocumentEvent;
024    import org.kuali.rice.kns.util.GlobalVariables;
025    import org.kuali.rice.kns.util.KualiDecimal;
026    
027    /**
028     * Validation for Auxiliary Voucher, which checks tha tthe accounting lines on the document, with all of
029     * their various credits and debits, balance.
030     */
031    public class AuxiliaryVoucherAccountingLinesBalanceValidation extends GenericValidation {
032        private AuxiliaryVoucherDocument auxiliaryVoucherDocumentForValidation;
033    
034        /**
035         * Returns true if credit/debit entries are in balance
036         * @see org.kuali.kfs.sys.document.validation.Validation#validate(org.kuali.kfs.sys.document.validation.event.AttributedDocumentEvent)
037         */
038        public boolean validate(AttributedDocumentEvent event) {
039            KualiDecimal creditAmount = getAuxiliaryVoucherDocumentForValidation().getCreditTotal();
040            KualiDecimal debitAmount = getAuxiliaryVoucherDocumentForValidation().getDebitTotal();
041    
042            boolean balanced = debitAmount.equals(creditAmount);
043            if (!balanced) {
044                String errorParams[] = { creditAmount.toString(), debitAmount.toString() };
045                GlobalVariables.getMessageMap().putError(ACCOUNTING_LINE_ERRORS, ERROR_DOCUMENT_BALANCE_CONSIDERING_CREDIT_AND_DEBIT_AMOUNTS, errorParams);
046            }
047            return balanced;
048        }
049    
050        /**
051         * Gets the auxiliaryVoucherDocumentForValidation attribute. 
052         * @return Returns the auxiliaryVoucherDocumentForValidation.
053         */
054        public AuxiliaryVoucherDocument getAuxiliaryVoucherDocumentForValidation() {
055            return auxiliaryVoucherDocumentForValidation;
056        }
057    
058        /**
059         * Sets the auxiliaryVoucherDocumentForValidation attribute value.
060         * @param auxiliaryVoucherDocumentForValidation The auxiliaryVoucherDocumentForValidation to set.
061         */
062        public void setAuxiliaryVoucherDocumentForValidation(AuxiliaryVoucherDocument accountingDocumentForValidation) {
063            this.auxiliaryVoucherDocumentForValidation = accountingDocumentForValidation;
064        }
065    }