/*
    * 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.OLEConstants.GL_CREDIT_CODE;
  import static org.kuali.ole.sys.OLEKeyConstants.ERROR_DOCUMENT_BALANCE;
  
  import org.kuali.ole.sys.OLEConstants;
  import org.kuali.ole.sys.businessobject.GeneralLedgerPendingEntry;
  import org.kuali.ole.sys.document.AccountingDocument;
  import org.kuali.ole.sys.document.validation.GenericValidation;
  import org.kuali.ole.sys.document.validation.event.AttributedDocumentEvent;
  import org.kuali.ole.sys.service.GeneralLedgerPendingEntryService;
  import org.kuali.rice.core.api.util.type.KualiDecimal;
  import org.kuali.rice.krad.exception.ValidationException;
  import org.kuali.rice.krad.util.GlobalVariables;
  
  /**
   * Validation that checks that the general ledger pending entries associated with an auxiliary voucher
   * document balance.
   */
  public class AuxiliaryVoucherGeneralLedgerPendingEntriesBalanceValdiation extends GenericValidation {
      private AccountingDocument accountingDocumentForValidation;
      private GeneralLedgerPendingEntryService generalLedgerPendingEntryService;
  
      /**
       * Returns true if the explicit, non-DI credit and debit GLPEs derived from the document's accountingLines 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) {
  //      generate GLPEs specifically here so that we can compare debits to credits
          if (!getGeneralLedgerPendingEntryService().generateGeneralLedgerPendingEntries(getAccountingDocumentForValidation())) {
              throw new ValidationException("general ledger GLPE generation failed");
          }
  
          // now loop through all of the GLPEs and calculate buckets for debits and credits
          KualiDecimal creditAmount = KualiDecimal.ZERO;
          KualiDecimal debitAmount = KualiDecimal.ZERO;
  
          for (GeneralLedgerPendingEntry glpe : getAccountingDocumentForValidation().getGeneralLedgerPendingEntries()) {
              // make sure we are looking at only the explicit entries that aren't DI types
              if (!glpe.isTransactionEntryOffsetIndicator() && !glpe.getFinancialDocumentTypeCode().equals(OLEConstants.FinancialDocumentTypeCodes.DISTRIBUTION_OF_INCOME_AND_EXPENSE)) {
                  if (GL_CREDIT_CODE.equals(glpe.getTransactionDebitCreditCode())) {
                      creditAmount = creditAmount.add(glpe.getTransactionLedgerEntryAmount());
                  }
                  else { // DEBIT
                      debitAmount = debitAmount.add(glpe.getTransactionLedgerEntryAmount());
                  }
              }
          }
  
          boolean balanced = debitAmount.equals(creditAmount);
          if (!balanced) {
              String errorParams[] = { creditAmount.toString(), debitAmount.toString() };
              GlobalVariables.getMessageMap().putError(ACCOUNTING_LINE_ERRORS, ERROR_DOCUMENT_BALANCE, errorParams);
          }
          return balanced;
      }
  
      /**
       * Gets the accountingDocumentForValidation attribute. 
       * @return Returns the accountingDocumentForValidation.
       */
      public AccountingDocument getAccountingDocumentForValidation() {
          return accountingDocumentForValidation;
      }
  
      /**
       * Sets the accountingDocumentForValidation attribute value.
       * @param accountingDocumentForValidation The accountingDocumentForValidation to set.
       */
      public void setAccountingDocumentForValidation(AccountingDocument accountingDocumentForValidation) {
          this.accountingDocumentForValidation = accountingDocumentForValidation;
      }
  
      /**
       * Gets the generalLedgerPendingEntryService attribute. 
       * @return Returns the generalLedgerPendingEntryService.
       */
      public GeneralLedgerPendingEntryService getGeneralLedgerPendingEntryService() {
          return generalLedgerPendingEntryService;
      }
  
      /**
       * Sets the generalLedgerPendingEntryService attribute value.
      * @param generalLedgerPendingEntryService The generalLedgerPendingEntryService to set.
      */
     public void setGeneralLedgerPendingEntryService(GeneralLedgerPendingEntryService generalLedgerPendingEntryService) {
         this.generalLedgerPendingEntryService = generalLedgerPendingEntryService;
     }
 }