/*
    * The Kuali Financial System, a comprehensive financial management system for higher education.
    * 
    * Copyright 2005-2014 The Kuali Foundation
    * 
    * This program is free software: you can redistribute it and/or modify
    * it under the terms of the GNU Affero General Public License as
    * published by the Free Software Foundation, either version 3 of the
    * License, or (at your option) any later version.
   * 
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU Affero General Public License for more details.
   * 
   * You should have received a copy of the GNU Affero General Public License
   * along with this program.  If not, see <http://www.gnu.org/licenses/>.
   */
  package org.kuali.kfs.module.purap.document.validation.impl;
  
  import org.kuali.kfs.module.purap.PurapConstants;
  import org.kuali.kfs.module.purap.PurapParameterConstants;
  import org.kuali.kfs.module.purap.document.AccountsPayableDocument;
  import org.kuali.kfs.module.purap.document.PurchasingAccountsPayableDocument;
  import org.kuali.kfs.module.purap.document.VendorCreditMemoDocument;
  import org.kuali.kfs.sys.context.SpringContext;
  import org.kuali.kfs.sys.service.impl.KfsParameterConstants;
  import org.kuali.rice.core.web.format.CurrencyFormatter;
  import org.kuali.rice.coreservice.framework.parameter.ParameterService;
  import org.kuali.rice.krad.document.Document;
  
  /**
   * Business rule(s) applicable to the Credit Memo document.
   */
  public class CreditMemoDocumentPreRules extends AccountsPayableDocumentPreRulesBase {
  
      /**
       * Default constructor
       */
      public CreditMemoDocumentPreRules() {
          super();
      }
  
      /**
       * @see org.kuali.rice.kns.rules.PromptBeforeValidationBase#doRules(org.kuali.rice.krad.document.Document)
       */
      @Override
      public boolean doPrompts(Document document) {
          return super.doPrompts(document);
      }
  
      /**
       * @see org.kuali.kfs.module.purap.document.validation.impl.AccountsPayableDocumentPreRulesBase#getDocumentName()
       */
      @Override
      public String getDocumentName() {
          return "Credit Memo";
      }
      
      /** 
       * @see org.kuali.kfs.module.purap.document.validation.impl.AccountsPayableDocumentPreRulesBase#createInvoiceNoMatchQuestionText(org.kuali.kfs.module.purap.document.AccountsPayableDocument)
       */
      @Override
      public String createInvoiceNoMatchQuestionText(AccountsPayableDocument accountsPayableDocument){
          
          String questionText = super.createInvoiceNoMatchQuestionText(accountsPayableDocument);                
          
          CurrencyFormatter cf = new CurrencyFormatter();
          VendorCreditMemoDocument cm = (VendorCreditMemoDocument) accountsPayableDocument;
          StringBuffer questionTextBuffer = new StringBuffer("");
          questionTextBuffer.append(questionText);
          
          questionTextBuffer.append("[br][br][b]Summary Detail Below[/b][br][br][table questionTable]");
          questionTextBuffer.append("[tr][td leftTd]Credit Memo Amount entered on start screen:[/td][td rightTd]").append((String)cf.format(cm.getInitialAmount())).append("[/td][/tr]");
          questionTextBuffer.append("[tr][td leftTd]Total credit processed prior to restocking fee:[/td][td rightTd]").append((String)cf.format(cm.getLineItemTotal())).append("[/td][/tr]");
          
          //if sales tax is enabled, show additional summary lines
          boolean salesTaxInd = SpringContext.getBean(ParameterService.class).getParameterValueAsBoolean(KfsParameterConstants.PURCHASING_DOCUMENT.class, PurapParameterConstants.ENABLE_SALES_TAX_IND);                
          if(salesTaxInd){
              questionTextBuffer.append("[tr][td leftTd]Grand Total Prior to Tax:[/td][td rightTd]").append((String)cf.format(cm.getGrandPreTaxTotal())).append("[/td][/tr]");
              questionTextBuffer.append("[tr][td leftTd]Grand Total Tax:[/td][td rightTd]").append((String)cf.format(cm.getGrandTaxAmount())).append("[/td][/tr]");
          }
          
          questionTextBuffer.append("[tr][td leftTd]Grand Total:[/td][td rightTd]").append((String)cf.format(cm.getGrandTotal())).append("[/td][/tr][/table]");
  
          return questionTextBuffer.toString();
          
      }
      
      @Override
      protected boolean checkCAMSWarningStatus(PurchasingAccountsPayableDocument purapDocument) {
          return PurapConstants.CAMSWarningStatuses.CREDIT_MEMO_STATUS_WARNING_NO_CAMS_DATA.contains(purapDocument.getApplicationDocumentStatus());
      }
      
      /**
       * Determines if the amount entered on the init tab is mismatched with the grand total of the document.
       * 
       * @param accountsPayableDocument
       * @return
      */
     @Override
     protected boolean validateInvoiceTotalsAreMismatched(AccountsPayableDocument accountsPayableDocument) {
         boolean mismatched = false;
         String[] excludeArray = { PurapConstants.ItemTypeCodes.ITEM_TYPE_PMT_TERMS_DISCOUNT_CODE };
 
         //  if UseTax is included, then the invoiceInitialAmount should be compared against the 
         // total amount NOT INCLUDING tax
         if (accountsPayableDocument.isUseTaxIndicator()) {
             if (accountsPayableDocument.getTotalPreTaxDollarAmountAllItems(excludeArray).compareTo(accountsPayableDocument.getInitialAmount()) != 0 && !accountsPayableDocument.isUnmatchedOverride()) {
                 mismatched = true;
             }
         }
         //  if NO UseTax, then the invoiceInitialAmount should be compared against the 
         // total amount INCLUDING sales tax (since if the vendor invoices with sales tax, then we pay it)
         else {
             if (accountsPayableDocument.getTotalDollarAmountAllItems(excludeArray).compareTo(accountsPayableDocument.getInitialAmount()) != 0 && !accountsPayableDocument.isUnmatchedOverride()) {
                 mismatched = true;
             }
         }
         return mismatched;
     }
 }