/*
    * Copyright 2007 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.module.purap.document;
  
  import org.kuali.ole.module.purap.PurapConstants;
  import org.kuali.ole.module.purap.PurapConstants.PurapDocTypeCodes;
  import org.kuali.ole.module.purap.PurapConstants.PurchaseOrderStatuses;
  import org.kuali.ole.module.purap.document.service.PurchaseOrderService;
  import org.kuali.ole.module.purap.service.PurapGeneralLedgerService;
  import org.kuali.ole.sys.OLEConstants;
  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.context.SpringContext;
  import org.kuali.rice.kew.api.exception.WorkflowException;
  import org.kuali.rice.kew.framework.postprocessor.DocumentRouteStatusChange;
  import org.kuali.rice.krad.rules.rule.event.KualiDocumentEvent;
  import org.kuali.rice.krad.workflow.service.WorkflowDocumentService;
  
  import java.util.ArrayList;
  import java.util.Iterator;
  import java.util.List;
  
  import static org.kuali.ole.sys.OLEConstants.GL_CREDIT_CODE;
  
  /**
   * Purchase Order Void Document
   */
  public class PurchaseOrderVoidDocument extends PurchaseOrderDocument {
      protected static org.apache.log4j.Logger LOG = org.apache.log4j.Logger.getLogger(PurchaseOrderVoidDocument.class);
  
      /**
       * General Ledger pending entries are not created on save for this document. They are created when the document has been finally
       * processed. Overriding this method so that entries are not created yet.
       *
       * @see org.kuali.ole.module.purap.document.PurchaseOrderDocument#prepareForSave(org.kuali.rice.krad.rule.event.KualiDocumentEvent)
       */
      @Override
      public void prepareForSave(KualiDocumentEvent event) {
          if (this.getFinancialSystemDocumentHeader().getWorkflowDocument().isCanceled()) {
              setSourceAccountingLines(new ArrayList());
              setGeneralLedgerPendingEntries(new ArrayList());
          }
      }
  
      /**
       * When Purchase Order Void document has been processed through Workflow, the general ledger entries are created and the PO
       * status changes to "VOID".
       *
       * @see org.kuali.ole.module.purap.document.PurchaseOrderDocument#doRouteStatusChange()
       */
      @Override
      public void doRouteStatusChange(DocumentRouteStatusChange statusChangeEvent) {
          super.doRouteStatusChange(statusChangeEvent);
  
          try {
              // DOCUMENT PROCESSED
              if (this.getFinancialSystemDocumentHeader().getWorkflowDocument().isProcessed()) {
                  // generate GL entries
                  SpringContext.getBean(PurapGeneralLedgerService.class).generateEntriesVoidPurchaseOrder(this);
  
                  // update indicators
                  SpringContext.getBean(PurchaseOrderService.class).setCurrentAndPendingIndicatorsForApprovedPODocuments(this);
  
                  // set purap status
                  updateAndSaveAppDocStatus(PurchaseOrderStatuses.APPDOC_VOID);
              }
              // DOCUMENT DISAPPROVED
              else if (this.getFinancialSystemDocumentHeader().getWorkflowDocument().isDisapproved()) {
                  SpringContext.getBean(PurchaseOrderService.class).setCurrentAndPendingIndicatorsForDisapprovedChangePODocuments(this);
                  // for app doc status
                  try {
                      String nodeName = SpringContext.getBean(WorkflowDocumentService.class).getCurrentRouteLevelName(this.getFinancialSystemDocumentHeader().getWorkflowDocument());
                      String reqStatus = PurapConstants.PurchaseOrderStatuses.getPurchaseOrderAppDocDisapproveStatuses().get(nodeName);
                      updateAndSaveAppDocStatus(PurapConstants.PurchaseOrderStatuses.getPurchaseOrderAppDocDisapproveStatuses().get(reqStatus));
                  } catch (WorkflowException e) {
                      logAndThrowRuntimeException("Error saving routing data while saving App Doc Status " + getDocumentNumber(), e);
                  }
              }
              // DOCUMENT CANCELED
              else if (this.getFinancialSystemDocumentHeader().getWorkflowDocument().isCanceled()) {
                  SpringContext.getBean(PurchaseOrderService.class).setCurrentAndPendingIndicatorsForCancelledChangePODocuments(this);
                  // for app doc status
                  updateAndSaveAppDocStatus(PurchaseOrderStatuses.APPDOC_CANCELLED);
              }
         } catch (WorkflowException e) {
             logAndThrowRuntimeException("Error saving routing data while saving document with id " + getDocumentNumber(), e);
         }
     }
 
     /**
      * @see org.kuali.module.purap.rules.PurapAccountingDocumentRuleBase#customizeExplicitGeneralLedgerPendingEntry(org.kuali.ole.sys.document.AccountingDocument,
      *      org.kuali.ole.sys.businessobject.AccountingLine, org.kuali.ole.sys.businessobject.GeneralLedgerPendingEntry)
      */
     @Override
     public void customizeExplicitGeneralLedgerPendingEntry(GeneralLedgerPendingEntrySourceDetail postable, GeneralLedgerPendingEntry explicitEntry) {
         super.customizeExplicitGeneralLedgerPendingEntry(postable, explicitEntry);
 
         SpringContext.getBean(PurapGeneralLedgerService.class).customizeGeneralLedgerPendingEntry(this, (AccountingLine) postable, explicitEntry, getPurapDocumentIdentifier(), GL_CREDIT_CODE, PurapDocTypeCodes.PO_DOCUMENT, true);
 
         // don't think i should have to override this, but default isn't getting the right PO doc
         explicitEntry.setFinancialDocumentTypeCode(PurapDocTypeCodes.PO_VOID_DOCUMENT);
         explicitEntry.setFinancialDocumentApprovedCode(OLEConstants.PENDING_ENTRY_APPROVED_STATUS_CODE.APPROVED);
     }
 
     @Override
     public List<GeneralLedgerPendingEntrySourceDetail> getGeneralLedgerPendingEntrySourceDetails() {
         List<GeneralLedgerPendingEntrySourceDetail> accountingLines = new ArrayList<GeneralLedgerPendingEntrySourceDetail>();
         if (getGlOnlySourceAccountingLines() != null) {
             Iterator iter = getGlOnlySourceAccountingLines().iterator();
             while (iter.hasNext()) {
                 accountingLines.add((GeneralLedgerPendingEntrySourceDetail) iter.next());
             }
         }
         return accountingLines;
     }
 
 }