/*
    * Copyright 2010 The Kuali Foundation.
    * 
    * Licensed under the Educational Community License, Version 1.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/ecl1.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.service.impl;
  
  import org.apache.commons.lang.StringUtils;
  import org.kuali.ole.coa.businessobject.ObjectCode;
  import org.kuali.ole.coa.businessobject.OffsetDefinition;
  import org.kuali.ole.coa.service.OffsetDefinitionService;
  import org.kuali.ole.fp.document.YearEndDocument;
  import org.kuali.ole.fp.document.service.YearEndPendingEntryService;
  import org.kuali.ole.gl.service.SufficientFundsService;
  import org.kuali.ole.sys.OLEConstants;
  import org.kuali.ole.sys.OLEPropertyConstants;
  import org.kuali.ole.sys.businessobject.AccountingLine;
  import org.kuali.ole.sys.businessobject.GeneralLedgerPendingEntry;
  import org.kuali.ole.sys.businessobject.GeneralLedgerPendingEntrySourceDetail;
  import org.kuali.ole.sys.document.validation.impl.AccountingDocumentRuleBaseConstants;
  import org.kuali.ole.sys.service.UniversityDateService;
  import org.kuali.rice.krad.document.TransactionalDocument;
  import org.kuali.rice.krad.util.ObjectUtils;
  
  /**
   * The default implementation of the YearEndPendingEntryService
   */
  public class YearEndPendingEntryServiceImpl implements YearEndPendingEntryService {
      private static final org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(YearEndPendingEntryServiceImpl.class);
      
      protected static final String FINAL_ACCOUNTING_PERIOD = OLEConstants.MONTH13;
      
      protected UniversityDateService universityDateService;
      protected SufficientFundsService sufficientFundsService;
      protected OffsetDefinitionService offsetDefinitionService;
  
      /**
       * @see org.kuali.ole.fp.document.service.YearEndPendingEntryService#customizeExplicitGeneralLedgerPendingEntry(org.kuali.rice.krad.document.TransactionalDocument, org.kuali.ole.sys.businessobject.AccountingLine, org.kuali.ole.sys.businessobject.GeneralLedgerPendingEntry)
       */
      @Override
      public void customizeExplicitGeneralLedgerPendingEntry(TransactionalDocument transactionalDocument, AccountingLine accountingLine, GeneralLedgerPendingEntry explicitEntry) {
          if (!(transactionalDocument instanceof YearEndDocument)) {
              throw new IllegalArgumentException("invalid (not a year end document) for class:" + transactionalDocument.getClass());
          }
          YearEndDocument yearEndDocument = (YearEndDocument) transactionalDocument;
          explicitEntry.setUniversityFiscalPeriodCode(getAccountingPeriodForYearEndEntry());
          explicitEntry.setUniversityFiscalYear(getPreviousFiscalYear());
      }
  
      /**
       * @see org.kuali.ole.fp.document.service.YearEndPendingEntryService#customizeOffsetGeneralLedgerPendingEntry(org.kuali.rice.krad.document.TransactionalDocument, org.kuali.ole.sys.businessobject.GeneralLedgerPendingEntrySourceDetail, org.kuali.ole.sys.businessobject.GeneralLedgerPendingEntry, org.kuali.ole.sys.businessobject.GeneralLedgerPendingEntry)
       */
      @Override
      public boolean customizeOffsetGeneralLedgerPendingEntry(TransactionalDocument transactionalDocument, GeneralLedgerPendingEntrySourceDetail accountingLine, GeneralLedgerPendingEntry explicitEntry, GeneralLedgerPendingEntry offsetEntry) {
          if (!(transactionalDocument instanceof YearEndDocument)) {
              throw new IllegalArgumentException("invalid (not a year end document) for class:" + transactionalDocument.getClass());
          }
          OffsetDefinition offsetDefinition = offsetDefinitionService.getByPrimaryId(getPreviousFiscalYear(), explicitEntry.getChartOfAccountsCode(), explicitEntry.getFinancialDocumentTypeCode(), explicitEntry.getFinancialBalanceTypeCode());
          if (!ObjectUtils.isNull(offsetDefinition)) {
              String offsetObjectCode = getOffsetFinancialObjectCode(offsetDefinition);
              offsetEntry.setFinancialObjectCode(offsetObjectCode);
              if (offsetObjectCode.equals(AccountingDocumentRuleBaseConstants.GENERAL_LEDGER_PENDING_ENTRY_CODE.getBlankFinancialObjectCode())) {
                  // no BO, so punt
                  offsetEntry.setAcctSufficientFundsFinObjCd(AccountingDocumentRuleBaseConstants.GENERAL_LEDGER_PENDING_ENTRY_CODE.getBlankFinancialObjectCode());
              }
              else {
                  offsetDefinition.refreshReferenceObject(OLEPropertyConstants.FINANCIAL_OBJECT);
                  ObjectCode financialObject = offsetDefinition.getFinancialObject();
                  // The ObjectCode reference may be invalid because a flexible offset account changed its chart code.
                  if (ObjectUtils.isNull(financialObject)) {
                      throw new RuntimeException("offset object code " + offsetEntry.getUniversityFiscalYear() + "-" + offsetEntry.getChartOfAccountsCode() + "-" + offsetEntry.getFinancialObjectCode());
                  }
                  offsetEntry.refreshReferenceObject(OLEPropertyConstants.ACCOUNT);
                  offsetEntry.setAcctSufficientFundsFinObjCd(sufficientFundsService.getSufficientFundsObjectCode(financialObject, offsetEntry.getAccount().getAccountSufficientFundsCode()));
              }
  
              offsetEntry.setFinancialObjectTypeCode(getOffsetFinancialObjectTypeCode(offsetDefinition));
              
              return true;
          }
          return false;
      }
  
      /**
       * @see org.kuali.ole.fp.document.service.YearEndPendingEntryService#getFinalAccountingPeriod()
       */
      @Override
      public String getFinalAccountingPeriod() {
          return FINAL_ACCOUNTING_PERIOD;
     }
     
     /**
      * @return the accounting period the year end entry should be populated with
      */
     protected String getAccountingPeriodForYearEndEntry() {
         return getFinalAccountingPeriod();
     }
 
     /**
      * @see org.kuali.ole.fp.document.service.YearEndPendingEntryService#getPreviousFiscalYear()
      */
     @Override
     public Integer getPreviousFiscalYear() {
         return universityDateService.getCurrentFiscalYear() - 1;
     }
     
     /**
      * Helper method that determines the offset entry's financial object code.
      * 
      * @param offsetDefinition
      * @return String
      */
     protected String getOffsetFinancialObjectCode(OffsetDefinition offsetDefinition) {
         if (null != offsetDefinition) {
             String returnString = (!StringUtils.isBlank(offsetDefinition.getFinancialObjectCode())) ? offsetDefinition.getFinancialObjectCode() : AccountingDocumentRuleBaseConstants.GENERAL_LEDGER_PENDING_ENTRY_CODE.getBlankFinancialObjectCode();
             return returnString;
         } else {
             return AccountingDocumentRuleBaseConstants.GENERAL_LEDGER_PENDING_ENTRY_CODE.getBlankFinancialObjectCode();
         }
     }
     
     /**
      * Helper method that determines the offset entry's financial object type code.
      * 
      * @param offsetDefinition
      * @return String
      */
     protected String getOffsetFinancialObjectTypeCode(OffsetDefinition offsetDefinition) {
         if (null != offsetDefinition && null != offsetDefinition.getFinancialObject()) {
             String returnString = (!StringUtils.isBlank(offsetDefinition.getFinancialObject().getFinancialObjectTypeCode())) ? offsetDefinition.getFinancialObject().getFinancialObjectTypeCode() : AccountingDocumentRuleBaseConstants.GENERAL_LEDGER_PENDING_ENTRY_CODE.getBlankFinancialObjectType();
             return returnString;
         } else {
             return AccountingDocumentRuleBaseConstants.GENERAL_LEDGER_PENDING_ENTRY_CODE.getBlankFinancialObjectType();
         }
 
     }
 
     public void setUniversityDateService(UniversityDateService universityDateService) {
         this.universityDateService = universityDateService;
     }
 
     public void setSufficientFundsService(SufficientFundsService sufficientFundsService) {
         this.sufficientFundsService = sufficientFundsService;
     }
 
     public void setOffsetDefinitionService(OffsetDefinitionService offsetDefinitionService) {
         this.offsetDefinitionService = offsetDefinitionService;
     }
 
 }