/*
    * Copyright 2008 The Kuali Foundation
    * 
    * Licensed under the Educational Community License, Version 2.0 (the "License");
    * you may not use this file except in compliance with the License.
    * You may obtain a copy of the License at
    * 
    * http://www.opensource.org/licenses/ecl2.php
    * 
   * Unless required by applicable law or agreed to in writing, software
   * distributed under the License is distributed on an "AS IS" BASIS,
   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   * See the License for the specific language governing permissions and
   * limitations under the License.
   */
  package org.kuali.ole.fp.document.validation.impl;
  
  import static org.kuali.ole.sys.OLEConstants.ACCOUNTING_LINE_ERRORS;
  import static org.kuali.ole.sys.OLEKeyConstants.ERROR_DOCUMENT_BALANCE_CONSIDERING_CREDIT_AND_DEBIT_AMOUNTS;
  
  import org.kuali.ole.fp.document.AuxiliaryVoucherDocument;
  import org.kuali.ole.sys.document.validation.GenericValidation;
  import org.kuali.ole.sys.document.validation.event.AttributedDocumentEvent;
  import org.kuali.rice.core.api.util.type.KualiDecimal;
  import org.kuali.rice.krad.util.GlobalVariables;
  
  /**
   * Validation for Auxiliary Voucher, which checks tha tthe accounting lines on the document, with all of
   * their various credits and debits, balance.
   */
  public class AuxiliaryVoucherAccountingLinesBalanceValidation extends GenericValidation {
      private AuxiliaryVoucherDocument auxiliaryVoucherDocumentForValidation;
  
      /**
       * Returns true if credit/debit entries are in balance
       * @see org.kuali.ole.sys.document.validation.Validation#validate(org.kuali.ole.sys.document.validation.event.AttributedDocumentEvent)
       */
      public boolean validate(AttributedDocumentEvent event) {
          KualiDecimal creditAmount = getAuxiliaryVoucherDocumentForValidation().getCreditTotal();
          KualiDecimal debitAmount = getAuxiliaryVoucherDocumentForValidation().getDebitTotal();
  
          boolean balanced = debitAmount.equals(creditAmount);
          if (!balanced) {
              String errorParams[] = { creditAmount.toString(), debitAmount.toString() };
              GlobalVariables.getMessageMap().putError(ACCOUNTING_LINE_ERRORS, ERROR_DOCUMENT_BALANCE_CONSIDERING_CREDIT_AND_DEBIT_AMOUNTS, errorParams);
          }
          return balanced;
      }
  
      /**
       * Gets the auxiliaryVoucherDocumentForValidation attribute. 
       * @return Returns the auxiliaryVoucherDocumentForValidation.
       */
      public AuxiliaryVoucherDocument getAuxiliaryVoucherDocumentForValidation() {
          return auxiliaryVoucherDocumentForValidation;
      }
  
      /**
       * Sets the auxiliaryVoucherDocumentForValidation attribute value.
       * @param auxiliaryVoucherDocumentForValidation The auxiliaryVoucherDocumentForValidation to set.
       */
      public void setAuxiliaryVoucherDocumentForValidation(AuxiliaryVoucherDocument accountingDocumentForValidation) {
          this.auxiliaryVoucherDocumentForValidation = accountingDocumentForValidation;
      }
  }