/*
    * 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_SOURCE_AND_TARGET_AMOUNTS;
  import static org.kuali.ole.sys.OLEKeyConstants.ERROR_DOCUMENT_PC_TRANSACTION_TOTAL_ACCTING_LINE_TOTAL_NOT_EQUAL;
  
  import java.util.List;
  
  import org.kuali.ole.fp.businessobject.ProcurementCardTargetAccountingLine;
  import org.kuali.ole.fp.businessobject.ProcurementCardTransactionDetail;
  import org.kuali.ole.fp.document.ProcurementCardDocument;
  import org.kuali.ole.sys.businessobject.TargetAccountingLine;
  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;
  
  /**
   * Validates that an accounting line does not have a capital object object code 
   */
  public class ProcurementCardBalanceValidation extends GenericValidation {
      private ProcurementCardDocument accountingDocumentForValidation;
  
      /**
       * Validates that an accounting line does not have a capital object object code
       * <strong>Expects an accounting line as the first a parameter</strong>
       * @see org.kuali.ole.sys.document.validation.Validation#validate(java.lang.Object[])
       */
      public boolean validate(AttributedDocumentEvent event) {
          ProcurementCardDocument pcDocument = (ProcurementCardDocument) getAccountingDocumentForValidation();
  
          KualiDecimal targetTotal = pcDocument.getTargetTotal();
          KualiDecimal sourceTotal = pcDocument.getSourceTotal();
  
          boolean isValid = targetTotal.compareTo(sourceTotal) == 0;
  
          if (!isValid) {
              GlobalVariables.getMessageMap().putError(ACCOUNTING_LINE_ERRORS, ERROR_DOCUMENT_BALANCE_CONSIDERING_SOURCE_AND_TARGET_AMOUNTS, new String[] { sourceTotal.toString(), targetTotal.toString() });
          }
  
          List<ProcurementCardTransactionDetail> pcTransactionEntries = pcDocument.getTransactionEntries();
  
          for (ProcurementCardTransactionDetail pcTransactionDetail : pcTransactionEntries) {
              isValid &= isTransactionBalanceValid(pcTransactionDetail);
          }
  
          return isValid;
      }
  
      /**
       * This method validates the balance of the transaction given.  A procurement card transaction is in balance if 
       * the total amount of the transaction equals the total of the target accounting lines corresponding to the transaction.
       * 
       * @param pcTransaction The transaction detail used to retrieve the procurement card transaction and target accounting 
       *                      lines used to check for in balance.
       * @return True if the amounts are equal and the transaction is in balance, false otherwise.
       */
      protected boolean isTransactionBalanceValid(ProcurementCardTransactionDetail pcTransactionDetail) {
          boolean inBalance = true;
          KualiDecimal transAmount = pcTransactionDetail.getTransactionTotalAmount();
          List<ProcurementCardTargetAccountingLine> targetAcctingLines = pcTransactionDetail.getTargetAccountingLines();
  
          KualiDecimal targetLineTotal = KualiDecimal.ZERO;
  
          for (TargetAccountingLine targetLine : targetAcctingLines) {
              targetLineTotal = targetLineTotal.add(targetLine.getAmount());
          }
  
          // perform absolute value check because current system has situations where amounts may be opposite in sign
          // This will no longer be necessary following completion of KULFDBCK-1290
          inBalance = transAmount.abs().equals(targetLineTotal.abs());
  
          if (!inBalance) {
              GlobalVariables.getMessageMap().putError(ACCOUNTING_LINE_ERRORS, ERROR_DOCUMENT_PC_TRANSACTION_TOTAL_ACCTING_LINE_TOTAL_NOT_EQUAL, new String[] { transAmount.toString(), targetLineTotal.toString() });
          }
  
          return inBalance;
      }
  
      /**
       * Gets the accountingDocumentForValidation attribute. 
       * @return Returns the accountingDocumentForValidation.
       */
      public ProcurementCardDocument getAccountingDocumentForValidation() {
         return accountingDocumentForValidation;
     }
 
     /**
      * Sets the accountingDocumentForValidation attribute value.
      * @param accountingDocumentForValidation The accountingDocumentForValidation to set.
      */
     public void setAccountingDocumentForValidation(ProcurementCardDocument accountingDocumentForValidation) {
         this.accountingDocumentForValidation = accountingDocumentForValidation;
     }
 
     
 }