/*
    * 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 org.kuali.ole.fp.businessobject.CashDrawer;
  import org.kuali.ole.fp.businessobject.CoinDetail;
  import org.kuali.ole.fp.businessobject.CurrencyDetail;
  import org.kuali.ole.fp.document.CashReceiptDocument;
  import org.kuali.ole.fp.document.CashReceiptFamilyBase;
  import org.kuali.ole.fp.document.service.CashReceiptService;
  import org.kuali.ole.fp.service.CashDrawerService;
  import org.kuali.ole.sys.OLEConstants;
  import org.kuali.ole.sys.OLEKeyConstants;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.ole.sys.document.validation.GenericValidation;
  import org.kuali.ole.sys.document.validation.event.AttributedDocumentEvent;
  import org.kuali.ole.sys.service.FinancialSystemWorkflowHelperService;
  import org.kuali.rice.kew.api.WorkflowDocument;
  import org.kuali.rice.krad.util.GlobalVariables;
  
  /**
   * Validation for the cash receipt document that verifies that the cash drawer is open at approval.
   */
  public class CashReceiptCashDrawerOpenValidation extends GenericValidation {
      private CashReceiptFamilyBase cashReceiptDocumentForValidation;
      private CashReceiptService cashReceiptService;
      private CashDrawerService cashDrawerService;
  
      /**
       * Makes sure that the cash drawer for the verification unit associated with this CR doc is
       * open. If it's not, the the rule fails.
       * @see org.kuali.ole.sys.document.validation.Validation#validate(org.kuali.ole.sys.document.validation.event.AttributedDocumentEvent)
       */
      @Override
      public boolean validate(AttributedDocumentEvent event) {
  
          CashDrawer cd = getCashDrawerService().getByCampusCode(getCashReceiptDocumentForValidation().getCampusLocationCode());
          if (cd == null) {
              throw new IllegalStateException("There is no cash drawer associated with unitName '" + getCashReceiptDocumentForValidation().getCampusLocationCode() + "' from cash receipt " + getCashReceiptDocumentForValidation().getDocumentNumber());
          }
          WorkflowDocument workflowDocument = getCashReceiptDocumentForValidation().getDocumentHeader().getWorkflowDocument();
          boolean isAdhocApproval = SpringContext.getBean(FinancialSystemWorkflowHelperService.class).isAdhocApprovalRequestedForPrincipal(workflowDocument, GlobalVariables.getUserSession().getPrincipalId());
  
          if (cd.isClosed() && !isAdhocApproval) {
              GlobalVariables.getMessageMap().putError(OLEConstants.GLOBAL_ERRORS, OLEKeyConstants.CashReceipt.MSG_CASH_DRAWER_CLOSED_VERIFICATION_NOT_ALLOWED, cd.getCampusCode());
              return false;
          }
  
          //check whether cash manager confirmed amount equals to the old amount
          CashReceiptDocument crDoc = (CashReceiptDocument)cashReceiptDocumentForValidation; 
          //check whether the change request is valid
          if (crDoc.getChangeCurrencyDetail() != null && crDoc.getChangeCoinDetail() != null) {
              return checkChangeRequestIsValid();
          }
          return true;
      }
      
      /**
       * 
       * This method checks whether the change request is valid by comparing the currency/coin counts in the request with the 
       * counts in the cash drawer + currency/coin counts sent with the cash receipt itself. 
       * @return Returns true if the request is valid. 
       */
      public boolean checkChangeRequestIsValid() {
          CashDrawer cd = getCashDrawerService().getByCampusCode(getCashReceiptDocumentForValidation().getCampusLocationCode());
          CurrencyDetail changeCurrency = ((CashReceiptDocument) getCashReceiptDocumentForValidation()).getChangeCurrencyDetail();
          CoinDetail changeCoin = ((CashReceiptDocument) getCashReceiptDocumentForValidation()).getChangeCoinDetail();
          CurrencyDetail confirmedCurrency = ((CashReceiptDocument) getCashReceiptDocumentForValidation()).getConfirmedCurrencyDetail();
          CoinDetail confirmedCoin = ((CashReceiptDocument) getCashReceiptDocumentForValidation()).getConfirmedCoinDetail();
          
          if(changeCurrency.getHundredDollarCount() > cd.getHundredDollarCount() + confirmedCurrency.getHundredDollarCount() ||
                  changeCurrency.getFiftyDollarCount() > cd.getFiftyDollarCount() + confirmedCurrency.getFiftyDollarCount() ||
                  changeCurrency.getTwentyDollarCount() > cd.getTwentyDollarCount() + confirmedCurrency.getTwentyDollarCount() ||
                  changeCurrency.getTenDollarCount() > cd.getTenDollarCount() + confirmedCurrency.getTenDollarCount() ||
                  changeCurrency.getFiveDollarCount() > cd.getFiveDollarCount() + confirmedCurrency.getFiveDollarCount() ||
                  changeCurrency.getTwoDollarCount() > cd.getTwoDollarCount() + confirmedCurrency.getTwoDollarCount() ||
                  changeCurrency.getOneDollarCount() > cd.getOneDollarCount() + confirmedCurrency.getOneDollarCount() ||
                  changeCoin.getHundredCentCount() > cd.getHundredCentCount() + confirmedCoin.getHundredCentCount() ||
                  changeCoin.getFiftyCentCount() > cd.getFiftyCentCount() + confirmedCoin.getFiftyCentCount() ||
                  changeCoin.getTwentyFiveCentCount() > cd.getTwentyFiveCentCount() + confirmedCoin.getTwentyFiveCentCount() ||
                  changeCoin.getTenCentCount() > cd.getTenCentCount() + confirmedCoin.getTenCentCount() ||
                  changeCoin.getFiveCentCount() > cd.getFiveCentCount() + confirmedCoin.getFiveCentCount() ||
                  changeCoin.getOneCentCount() > cd.getOneCentCount() + confirmedCoin.getOneCentCount()) {
                   
              GlobalVariables.getMessageMap().putError(OLEConstants.GLOBAL_ERRORS, OLEKeyConstants.CashReceipt.ERROR_CHANGE_REQUEST, "");
              return false;
         }
         
         return true;
     }
 
     /**
      * Gets the cashReceiptDocumentForValidation attribute. 
      * @return Returns the cashReceiptDocumentForValidation.
      */
     public CashReceiptFamilyBase getCashReceiptDocumentForValidation() {
         return cashReceiptDocumentForValidation;
     }
 
     /**
      * Sets the cashReceiptDocumentForValidation attribute value.
      * @param cashReceiptDocumentForValidation The cashReceiptDocumentForValidation to set.
      */
     public void setCashReceiptDocumentForValidation(CashReceiptFamilyBase cashReceiptFamilyDocumentForValidation) {
         this.cashReceiptDocumentForValidation = cashReceiptFamilyDocumentForValidation;
     }
 
     /**
      * Gets the cashDrawerService attribute. 
      * @return Returns the cashDrawerService.
      */
     public CashDrawerService getCashDrawerService() {
         return cashDrawerService;
     }
 
     /**
      * Sets the cashDrawerService attribute value.
      * @param cashDrawerService The cashDrawerService to set.
      */
     public void setCashDrawerService(CashDrawerService cashDrawerService) {
         this.cashDrawerService = cashDrawerService;
     }
 
     /**
      * Gets the cashReceiptService attribute. 
      * @return Returns the cashReceiptService.
      */
     public CashReceiptService getCashReceiptService() {
         return cashReceiptService;
     }
 
     /**
      * Sets the cashReceiptService attribute value.
      * @param cashReceiptService The cashReceiptService to set.
      */
     public void setCashReceiptService(CashReceiptService cashReceiptService) {
         this.cashReceiptService = cashReceiptService;
     }
 }