/*
    * 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.sys.service.impl;
  
  import org.apache.log4j.Logger;
  import org.kuali.ole.sys.businessobject.UniversityDate;
  import org.kuali.ole.sys.context.SpringContext;
  import org.kuali.ole.sys.dataaccess.UniversityDateDao;
  import org.kuali.ole.sys.service.NonTransactional;
  import org.kuali.ole.sys.service.UniversityDateService;
  import org.kuali.ole.sys.util.KfsDateUtils;
  import org.kuali.rice.core.api.datetime.DateTimeService;
  import org.kuali.rice.krad.service.BusinessObjectService;
  import org.springframework.cache.annotation.Cacheable;
  
  /**
   * 
   * This is the default implementation of the UniversityDateService interface.
   */
  
  @NonTransactional
  public class UniversityDateServiceImpl implements UniversityDateService {
  
      private static final Logger LOG = Logger.getLogger(UniversityDateServiceImpl.class);
  
      protected UniversityDateDao universityDateDao;
      protected DateTimeService dateTimeService;
      
      /**
       * This method retrieves a UniversityDate object using today's date to create the instance.
       * 
       * @return A UniversityDate instance representing today's date.
       * 
       * @see org.kuali.ole.sys.service.UniversityDateService#getCurrentUniversityDate()
       */
      @Override
      public UniversityDate getCurrentUniversityDate() {
          java.util.Date now = dateTimeService.getCurrentDate();
          return SpringContext.getBean(BusinessObjectService.class).findBySinglePrimaryKey(UniversityDate.class, new java.sql.Date( KfsDateUtils.clearTimeFields(now).getTime() ));
      }
  
      /**
       * This method retrieves the current fiscal year using today's date.
       * 
       * @return The current fiscal year as an Integer.
       * 
       * @see org.kuali.rice.core.api.datetime.DateTimeService#getCurrentFiscalYear()
       */
      @Override
      public Integer getCurrentFiscalYear() {
          java.util.Date now = dateTimeService.getCurrentDate();
  
          return getFiscalYear(KfsDateUtils.clearTimeFields(now));
      }
      
      /**
       * This method retrieves the fiscal year associated with the date provided.
       * 
       * @param date The date to be used for retrieving the associated fiscal year.
       * @return The fiscal year that the date provided falls within.
       * 
       * @see org.kuali.rice.core.api.datetime.DateTimeService#getFiscalYear(java.util.Date)
       */
      @Override
      @Cacheable(value=UniversityDate.CACHE_NAME, key="'{FiscalYear}'+#p0")
      public Integer getFiscalYear(java.util.Date date) {
          if (date == null) {
              throw new IllegalArgumentException("invalid (null) date");
          }
          UniversityDate uDate = SpringContext.getBean(BusinessObjectService.class).findBySinglePrimaryKey(UniversityDate.class, new java.sql.Date( KfsDateUtils.clearTimeFields(date).getTime() ) );
          return (uDate == null) ? null : uDate.getUniversityFiscalYear();
      }
  
      /**
       * This method retrieves the first date of the fiscal year provided.
       * 
       * @param fiscalYear The fiscal year to retrieve the first date for.
       * @return A Date object representing the first date of the fiscal year given.
       * 
       * @see org.kuali.ole.sys.service.UniversityDateService#getFirstDateOfFiscalYear(java.lang.Integer)
       */
      @Override
      @Cacheable(value=UniversityDate.CACHE_NAME, key="'{FirstDateOfFiscalYear}'+#p0")
      public java.util.Date getFirstDateOfFiscalYear(Integer fiscalYear) {
          UniversityDate uDate = universityDateDao.getFirstFiscalYearDate(fiscalYear);
          return (uDate == null) ? null : uDate.getUniversityDate();
     }
 
     /**
      * This method retrieves the last date of the fiscal year provided.
      * 
      * @param fiscalYear The fiscal year to retrieve the last date for.
      * @return A Date object representing the last date of the fiscal year given.
      * 
      * @see org.kuali.ole.sys.service.UniversityDateService#getLastDateOfFiscalYear(java.lang.Integer)
      */
     @Override
     @Cacheable(value=UniversityDate.CACHE_NAME, key="'{LastDateOfFiscalYear}'+#p0")
     public java.util.Date getLastDateOfFiscalYear(Integer fiscalYear) {
         UniversityDate uDate = universityDateDao.getLastFiscalYearDate(fiscalYear);
         return (uDate == null) ? null : uDate.getUniversityDate();
     }
     
     public void setUniversityDateDao(UniversityDateDao universityDateDao) {
         this.universityDateDao = universityDateDao;
     }
     public void setDateTimeService(DateTimeService dateTimeService) {
         this.dateTimeService = dateTimeService;
     }
     
 }