/*
    * 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 java.util.List;
  
  import org.kuali.ole.fp.businessobject.CapitalAccountingLines;
  import org.kuali.ole.fp.businessobject.CapitalAssetInformation;
  import org.kuali.ole.fp.document.CapitalAccountingLinesDocumentBase;
  import org.kuali.ole.fp.document.CapitalAssetEditable;
  import org.kuali.ole.sys.OLEConstants;
  import org.kuali.ole.sys.OLEKeyConstants;
  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.rice.core.api.util.type.KualiDecimal;
  import org.kuali.rice.krad.util.GlobalVariables;
  import org.kuali.rice.krad.util.ObjectUtils;
  
  /**
   * validate the capital accounting lines associated with the accounting document for validation
   */
  public class CapitalAccountingLinesValidations extends GenericValidation {
      private static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(CapitalAccountingLinesValidations.class);
  
      private AccountingDocument accountingDocumentForValidation;
  
      /**
       * @see org.kuali.ole.sys.document.validation.Validation#validate(org.kuali.ole.sys.document.validation.event.AttributedDocumentEvent)
       */
      public boolean validate(AttributedDocumentEvent event) {
          return this.validateCapitalAccountingLines(accountingDocumentForValidation);
      }
  
      // determine whether the given document's all capital accounting lines are processed.
      protected boolean validateCapitalAccountingLines(AccountingDocument accountingDocumentForValidation) {
          LOG.debug("validateCapitalAccountingLines - start");
  
          boolean isValid = true;
          
          if (accountingDocumentForValidation instanceof CapitalAssetEditable == false) {
              return true;
          }
  
          CapitalAccountingLinesDocumentBase capitalAccountingLinesDocumentBase = (CapitalAccountingLinesDocumentBase) accountingDocumentForValidation;
          List <CapitalAccountingLines> capitalAccountingLines = capitalAccountingLinesDocumentBase.getCapitalAccountingLines();
          
          CapitalAssetEditable capitalAssetEditable = (CapitalAssetEditable) accountingDocumentForValidation;
  
          List<CapitalAssetInformation> capitalAssets = capitalAssetEditable.getCapitalAssetInformation();
  
          isValid &= allCapitalAccountingLinesProcessed(capitalAccountingLines, capitalAssets);
          isValid &= capitalAssetExistsForCapitalAccountingLinesProcessed(capitalAccountingLines, capitalAssets);
          isValid &= totalAmountMatchForCapitalAccountingLinesAndCapitalAssets(capitalAccountingLines, capitalAssets);
          
          return isValid;
      }
  
      protected boolean allCapitalAccountingLinesProcessed(List<CapitalAccountingLines> capitalAccountingLines, List<CapitalAssetInformation> capitalAssets) {
          LOG.debug("allCapitalAccountingLinesProcessed - start");
          
          boolean processed = true;
          
          for (CapitalAccountingLines capitalAccountingLine : capitalAccountingLines) {
              if (!capitalAccountingLine.isSelectLine()) {
                  processed = false;
                  GlobalVariables.getMessageMap().putError(OLEConstants.EDIT_ACCOUNTING_LINES_FOR_CAPITALIZATION_ERRORS, OLEKeyConstants.ERROR_DOCUMENT_ACCOUNTING_LINE_FOR_CAPITALIZATION_NOT_PROCESSED);
                  
                  break;
              }
          }
          
          return processed;
      }
  
      protected boolean capitalAssetExistsForCapitalAccountingLinesProcessed(List<CapitalAccountingLines> capitalAccountingLines, List<CapitalAssetInformation> capitalAssets) {
          LOG.debug("capitalAssetExistsForCapitalAccountingLinesProcessed - start");
          
          boolean exists = true;
          
          for (CapitalAccountingLines capitalAccountingLine : capitalAccountingLines) {
              if (!capitalAssetExist(capitalAccountingLine, capitalAssets)) {
                  exists = false;
                  GlobalVariables.getMessageMap().putError(OLEConstants.EDIT_ACCOUNTING_LINES_FOR_CAPITALIZATION_ERRORS, OLEKeyConstants.ERROR_DOCUMENT_ACCOUNTING_LINE_FOR_CAPITALIZATION_HAS_NO_CAPITAL_ASSET, capitalAccountingLine.getSequenceNumber().toString(), capitalAccountingLine.getLineType(), capitalAccountingLine.getChartOfAccountsCode(), capitalAccountingLine.getAccountNumber(), capitalAccountingLine.getFinancialObjectCode());
                  
                  break;
             }
         }
         
         return exists;
     }
     
     /**
      * 
      * @param capitalAccountingLine
      * @param capitalAssetInformation
      * @return true if accounting line has a capital asset information
      */
     protected boolean capitalAssetExist(CapitalAccountingLines capitalAccountingLine, List<CapitalAssetInformation> capitalAssetInformation) {
         boolean exists = false;
         
         if (ObjectUtils.isNull(capitalAssetInformation) && capitalAssetInformation.size() <= 0) {
             return exists;
         }
         
         for (CapitalAssetInformation capitalAsset : capitalAssetInformation) {
           //  if (capitalAsset.getSequenceNumber().compareTo(capitalAccountingLine.getSequenceNumber()) == 0 &&
          //           capitalAsset.getFinancialDocumentLineTypeCode().equals(OLEConstants.SOURCE.equals(capitalAccountingLine.getLineType()) ? OLEConstants.SOURCE_ACCT_LINE_TYPE_CODE : OLEConstants.TARGET_ACCT_LINE_TYPE_CODE) && 
          //           capitalAsset.getChartOfAccountsCode().equals(capitalAccountingLine.getChartOfAccountsCode()) && 
          //           capitalAsset.getAccountNumber().equals(capitalAccountingLine.getAccountNumber()) && 
          //           capitalAsset.getFinancialObjectCode().equals(capitalAccountingLine.getFinancialObjectCode())) {
                 return true;
           //  }
         }
         
         return exists;
     }
     
     protected boolean totalAmountMatchForCapitalAccountingLinesAndCapitalAssets(List<CapitalAccountingLines> capitalAccountingLines, List<CapitalAssetInformation> capitalAssets) {
         boolean totalAmountMatched = true;
         
         KualiDecimal capitalAccountingLinesTotals = KualiDecimal.ZERO;
         KualiDecimal capitalAAssetTotals = KualiDecimal.ZERO;
         
         for (CapitalAccountingLines capitalAccountingLine : capitalAccountingLines) {
             capitalAccountingLinesTotals = capitalAccountingLinesTotals.add(capitalAccountingLine.getAmount());
         }
     
         for (CapitalAssetInformation capitalAsset : capitalAssets) {
             capitalAAssetTotals = capitalAAssetTotals.add(capitalAsset.getCapitalAssetLineAmount());
         }
         
         if (capitalAccountingLinesTotals.isGreaterThan(capitalAAssetTotals)) {
             //not all the accounting lines amounts have been distributed to capital assets
             GlobalVariables.getMessageMap().putError(OLEConstants.EDIT_ACCOUNTING_LINES_FOR_CAPITALIZATION_ERRORS, OLEKeyConstants.ERROR_DOCUMENT_ACCOUNTING_LINES_NOT_ALL_TOTALS_DISTRIBUTED_TO_CAPITAL_ASSETS);
             return false;
         }
         
         if (capitalAccountingLinesTotals.isLessEqual(capitalAAssetTotals)) {
             //not all the accounting lines amounts have been distributed to capital assets
             GlobalVariables.getMessageMap().putError(OLEConstants.EDIT_ACCOUNTING_LINES_FOR_CAPITALIZATION_ERRORS, OLEKeyConstants.ERROR_DOCUMENT_ACCOUNTING_LINE_FOR_CAPITALIZATION_HAS_NO_CAPITAL_ASSET);
             return false;
         }
         
         return totalAmountMatched;
     }
     
     
     /**
      * Sets the accountingDocumentForValidation attribute value.
      * 
      * @param accountingDocumentForValidation The accountingDocumentForValidation to set.
      */
     public void setAccountingDocumentForValidation(AccountingDocument accountingDocumentForValidation) {
         this.accountingDocumentForValidation = accountingDocumentForValidation;
     }
 }