/*
    * 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.sys.service.impl;
  
  import java.util.ArrayList;
  import java.util.Collection;
  import java.util.List;
  import java.util.Map;
  
  import org.apache.commons.lang.StringUtils;
  import org.apache.struts.action.ActionForward;
  import org.apache.struts.action.ActionMapping;
  import org.kuali.ole.sys.businessobject.ElectronicPaymentClaim;
  import org.kuali.ole.sys.service.ElectronicFundTransferActionHelper;
  import org.kuali.ole.sys.service.ElectronicPaymentClaimingService;
  import org.kuali.ole.sys.web.struts.ElectronicFundTransferForm;
  import org.kuali.rice.kim.api.identity.Person;
  import org.kuali.rice.kns.lookup.LookupResultsService;
  import org.kuali.rice.kns.service.DataDictionaryService;
  import org.kuali.rice.krad.exception.AuthorizationException;
  import org.kuali.rice.krad.util.GlobalVariables;
  
  /**
   * Represents a web action that occurs when a user returns a bunch of selected claims and redirects to the electronic funds transfer "claimng" page
   */
  public class ElectronicFundTransferRefreshActionHelper implements ElectronicFundTransferActionHelper {
      private ElectronicPaymentClaimingService electronicPaymentClaimingService;
      private DataDictionaryService ddService;
      protected LookupResultsService lookupResultsService;
      
      protected static final String BASIC_FORWARD = "basic";
      protected static final String ACTION_NAME = "claim";
      protected static final String PORTAL_FORWARD = "portal";
  
      /**
       * @see org.kuali.ole.sys.service.ElectronicFundTransferActionHelper#performAction(org.kuali.rice.kns.web.struts.form.KualiForm, org.apache.struts.action.ActionMapping)
       */
      public ActionForward performAction(ElectronicFundTransferForm form, ActionMapping mapping, Map params, String basePath) {
          // is the current user able to claim electronic funds?
          Person currentUser = GlobalVariables.getUserSession().getPerson();
          if (!form.hasAvailableClaimingDocumentStrategies()) {
              throw new AuthorizationException(currentUser.getPrincipalName(), ElectronicFundTransferRefreshActionHelper.ACTION_NAME, ddService.getDataDictionary().getBusinessObjectEntry(ElectronicPaymentClaim.class.getName()).getObjectLabel());
          }
          // does the current user have claimed funds waiting for them?
          String lookupResultsSequenceNumber = null;
          if (params.get("lookupResultsSequenceNumber") != null) {
              lookupResultsSequenceNumber = ((String[])params.get("lookupResultsSequenceNumber"))[0];
          }
          if (StringUtils.isBlank(lookupResultsSequenceNumber)) {
              return mapping.findForward(PORTAL_FORWARD);
          }
          List<ElectronicPaymentClaim> claims = getClaimedPayments(currentUser, lookupResultsSequenceNumber);
          if (claims.size() == 0) {
              return mapping.findForward(PORTAL_FORWARD);
          }
          // if so, load their currently claimed electronic funds to the form
          form.setClaims(claims);
          // and redirect
          return mapping.findForward(BASIC_FORWARD);
      }
      
      /**
       * Gets the selected electronic payment claim records from the LookupResults service
       * @param currentUser the claiming user
       * @param lookupResultsSequenceNumber the parameter for the lookup results sequence number
       * @return a list of claims
       */
      protected List<ElectronicPaymentClaim> getClaimedPayments(Person currentUser, String lookupResultsSequenceNumber) {
          List<ElectronicPaymentClaim> claims = new ArrayList<ElectronicPaymentClaim>();
          try {
              Collection selectedClaims = lookupResultsService.retrieveSelectedResultBOs(lookupResultsSequenceNumber, ElectronicPaymentClaim.class, currentUser.getPrincipalId());
              for (Object claimAsObj : selectedClaims) {
                  ElectronicPaymentClaim claim = (ElectronicPaymentClaim) claimAsObj;
                  if (!claim.getPaymentClaimStatusCode().equals(ElectronicPaymentClaim.ClaimStatusCodes.CLAIMED) && StringUtils.isBlank(claim.getReferenceFinancialDocumentNumber())) {
                      claims.add(claim);
                  }
              }
          }
          catch (Exception e) {
              throw new RuntimeException(e);
          }        
          return claims;
      }
      
      /**
       * Sets the electronicPaymentClaimingService attribute value.
      * @param electronicPaymentClaimingService The electronicPaymentClaimingService to set.
      */
     public void setElectronicPaymentClaimingService(ElectronicPaymentClaimingService electronicPaymentClaimingService) {
         this.electronicPaymentClaimingService = electronicPaymentClaimingService;
     }
     
     /**
      * Sets the ddService attribute value.
      * @param ddService The ddService to set.
      */
     public void setDataDictonaryService(DataDictionaryService ddService) {
         this.ddService = ddService;
     }
 
     /**
      * Sets the lookupResultsService attribute value.
      * @param lookupResultsService The lookupResultsService to set.
      */
     public void setLookupResultsService(LookupResultsService lookupResultsService) {
         this.lookupResultsService = lookupResultsService;
     }
     
     
 }