/*
    * 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.gl.service.impl;
  
  import java.util.HashMap;
  import java.util.List;
  import java.util.Map;
  
  import org.apache.commons.codec.binary.Base64;
  import org.kuali.ole.gl.businessobject.OriginEntryFull;
  import org.kuali.ole.gl.service.GlCorrectionProcessOriginEntryService;
  import org.kuali.ole.sys.OLEConstants;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.rice.core.api.datetime.DateTimeService;
  import org.kuali.rice.kns.lookup.LookupResults;
  import org.kuali.rice.krad.service.BusinessObjectService;
  import org.kuali.rice.krad.util.GlobalVariables;
  import org.kuali.rice.krad.util.ObjectUtils;
  import org.springframework.transaction.annotation.Transactional;
  
  /**
   * This implementation of GlCorrectionProcessOriginEntryService uses the database to temporarily store lists of origin entries.
   * While this implementation does not clear out persisted origin entries, the batch job defined using the
   * org.kuali.ole.sys.batch.PurgeOldLookupResultsStep class may cause the purging of origin entries persisted with this implementation.
   * 
   * @see GlCorrectionProcessOriginEntryService
   */
  @Transactional
  public class GlCorrectionProcessOriginEntryServiceImpl implements GlCorrectionProcessOriginEntryService {
  
      private BusinessObjectService businessObjectService;
  
      /**
       * Persists the origin entries under a given sequence number. If entries are persisted again under the same sequence number,
       * then they will be overridden.
       * 
       * @param glcpSearchResuiltsSequenceNumber a sequence number
       * @param allEntries a list of origin entries
       * @throws Exception thrown if anything goes wrong
       * @see org.kuali.ole.gl.service.GlCorrectionProcessOriginEntryService#persistAllEntries(java.lang.String, java.util.List)
       */
      public void persistAllEntries(String glcpSearchResuiltsSequenceNumber, List<OriginEntryFull> allEntries) throws Exception {
          String serializedOriginEntries = new String(Base64.encodeBase64(ObjectUtils.toByteArray(allEntries)));
  
          LookupResults lookupResults = retrieveGlcpAllOriginEntries(glcpSearchResuiltsSequenceNumber);
          if (lookupResults == null) {
              lookupResults = new LookupResults();
              lookupResults.setLookupResultsSequenceNumber(glcpSearchResuiltsSequenceNumber);
              lookupResults.setLookupPersonId(GlobalVariables.getUserSession().getPerson().getPrincipalId());
          }
          lookupResults.setLookupDate(SpringContext.getBean(DateTimeService.class).getCurrentTimestamp());
          lookupResults.setSerializedLookupResults(serializedOriginEntries);
          businessObjectService.save(lookupResults);
      }
  
      /**
       * Retrieves the origin entries stored under the given sequence number
       * 
       * @param glcpSearchResuiltsSequenceNumber a sequence number
       * @return a list of origin entries, or null if no results are currently not in the system.
       * @throws Exception thrown if something goes wrong - vague documentation for a vague exception
       * @see org.kuali.ole.gl.service.GlCorrectionProcessOriginEntryService#retrieveAllEntries(java.lang.String)
       */
      public List<OriginEntryFull> retrieveAllEntries(String glcpSearchResuiltsSequenceNumber) throws Exception {
          LookupResults lookupResults = retrieveGlcpAllOriginEntries(glcpSearchResuiltsSequenceNumber);
          if (lookupResults == null) {
              return null;
          }
          List<OriginEntryFull> allOEs = (List<OriginEntryFull>) ObjectUtils.fromByteArray(Base64.decodeBase64(lookupResults.getSerializedLookupResults().getBytes()));
          return allOEs;
      }
  
      protected LookupResults retrieveGlcpAllOriginEntries(String glcpSearchResuiltsSequenceNumber) {
          Map<String, String> criteria = new HashMap<String, String>();
          criteria.put(OLEConstants.LOOKUP_RESULTS_SEQUENCE_NUMBER, glcpSearchResuiltsSequenceNumber);
          LookupResults gaoe = (LookupResults) getBusinessObjectService().findByPrimaryKey(LookupResults.class, criteria);
          return gaoe;
      }
  
      /**
       * Gets the businessObjectService attribute.
       * 
       * @return Returns the businessObjectService.
       */
      protected BusinessObjectService getBusinessObjectService() {
          return businessObjectService;
     }
 
     /**
      * Sets the businessObjectService attribute value.
      * 
      * @param businessObjectService The businessObjectService to set.
      */
     public void setBusinessObjectService(BusinessObjectService businessObjectService) {
         this.businessObjectService = businessObjectService;
     }
 }