/*
    * Copyright 2006 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.web.struts;
  
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  
  import org.apache.struts.action.ActionForm;
  import org.apache.struts.action.ActionForward;
  import org.apache.struts.action.ActionMapping;
  import org.kuali.ole.fp.businessobject.CreditCardDetail;
  import org.kuali.ole.fp.document.CreditCardReceiptDocument;
  import org.kuali.ole.fp.document.validation.impl.CreditCardReceiptDocumentRuleUtil;
  import org.kuali.ole.sys.OLEConstants;
  import org.kuali.ole.sys.OLEPropertyConstants;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.ole.sys.service.BankService;
  import org.kuali.rice.kew.api.exception.WorkflowException;
  import org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase;
  import org.kuali.rice.krad.util.GlobalVariables;
  
  /**
   * This is the action class for the CreditCardReceiptDocument.
   */
  public class CreditCardReceiptAction extends CapitalAccountingLinesActionBase {
      /**
       * Adds handling for credit card receipt amount updates.
       * 
       * @see org.apache.struts.action.Action#execute(org.apache.struts.action.ActionMapping, org.apache.struts.action.ActionForm,
       *      javax.servlet.http.HttpServletRequest, javax.servlet.http.HttpServletResponse)
       */
      @Override
      public ActionForward execute(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
          CreditCardReceiptForm ccrForm = (CreditCardReceiptForm) form;
  
          if (ccrForm.hasDocumentId()) {
              CreditCardReceiptDocument ccrDoc = ccrForm.getCreditCardReceiptDocument();
  
              ccrDoc.setTotalCreditCardAmount(ccrDoc.calculateCreditCardReceiptTotal()); // recalc b/c changes to the amounts could
              // have happened
  
              //set bank
              ccrDoc.setBank(SpringContext.getBean(BankService.class).getByPrimaryId(ccrDoc.getCreditCardReceiptBankCode()));
          }
  
          // proceed as usual
          return super.execute(mapping, form, request, response);
      }
  
      /**
       * Adds a CreditCardDetail instance created from the current "new creditCardReceipt" line to the document
       * 
       * @param mapping
       * @param form
       * @param request
       * @param response
       * @return ActionForward
       * @throws Exception
       */
      public ActionForward addCreditCardReceipt(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
          CreditCardReceiptForm ccrForm = (CreditCardReceiptForm) form;
          CreditCardReceiptDocument ccrDoc = ccrForm.getCreditCardReceiptDocument();
  
          CreditCardDetail newCreditCardReceipt = ccrForm.getNewCreditCardReceipt();
          ccrDoc.prepareNewCreditCardReceipt(newCreditCardReceipt);
  
          // creditCardReceipt business rules
          boolean rulePassed = validateNewCreditCardReceipt(newCreditCardReceipt);
          if (rulePassed) {
              // add creditCardReceipt
              ccrDoc.addCreditCardReceipt(newCreditCardReceipt);
  
              // clear the used creditCardReceipt
              ccrForm.setNewCreditCardReceipt(new CreditCardDetail());
          }
  
          return mapping.findForward(OLEConstants.MAPPING_BASIC);
      }
  
      /**
       * Deletes the selected creditCardReceipt (line) from the document
       * 
       * @param mapping
       * @param form
       * @param request
       * @param response
      * @return ActionForward
      * @throws Exception
      */
     public ActionForward deleteCreditCardReceipt(ActionMapping mapping, ActionForm form, HttpServletRequest request, HttpServletResponse response) throws Exception {
         CreditCardReceiptForm ccrForm = (CreditCardReceiptForm) form;
         CreditCardReceiptDocument ccrDoc = ccrForm.getCreditCardReceiptDocument();
 
         int deleteIndex = getLineToDelete(request);
         // delete creditCardReceipt
         ccrDoc.removeCreditCardReceipt(deleteIndex);
 
         return mapping.findForward(OLEConstants.MAPPING_BASIC);
     }
 
     /**
      * This method validates a new credit card receipt detail record.
      * 
      * @param creditCardReceipt
      * @return boolean
      */
     protected boolean validateNewCreditCardReceipt(CreditCardDetail creditCardReceipt) {
         GlobalVariables.getMessageMap().addToErrorPath(OLEPropertyConstants.NEW_CREDIT_CARD_RECEIPT);
         boolean isValid = CreditCardReceiptDocumentRuleUtil.validateCreditCardReceipt(creditCardReceipt);
         GlobalVariables.getMessageMap().removeFromErrorPath(OLEPropertyConstants.NEW_CREDIT_CARD_RECEIPT);
         return isValid;
     }
 
     /**
      * Do initialization for a new credit card receipt
      *
      * @see org.kuali.rice.kns.web.struts.action.KualiDocumentActionBase#createDocument(org.kuali.rice.kns.web.struts.form.KualiDocumentFormBase)
      */
     @Override
     protected void createDocument(KualiDocumentFormBase kualiDocumentFormBase) throws WorkflowException {
         super.createDocument(kualiDocumentFormBase);
         ((CreditCardReceiptDocument) kualiDocumentFormBase.getDocument()).initiateDocument();
     }
 }