/**
    * Copyright 2004-2013 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.hr.time.earncode.service;
  
  import org.kuali.hr.time.assignment.Assignment;
  import org.kuali.hr.time.earncode.EarnCode;
  import org.springframework.cache.annotation.Cacheable;
  
  import java.math.BigDecimal;
  import java.sql.Date;
  import java.util.List;
  import java.util.Map;
  
  public interface EarnCodeService {
      /**
       * Fetch a list of earn codes for Leave usage and Time usage, for a particular assignment as of a particular date
       * @param a
       * @param asOfDate
       * @param isLeavePlanningCalendar
       * @return
       */
      @Cacheable(value=EarnCode.CACHE_NAME, key="'{getEarnCodesForLeaveAndTime}' + 'principalId=' + T(org.kuali.hr.time.util.TKContext).getPrincipalId() + '|' + 'targetId=' + T(org.kuali.hr.time.util.TKContext).getTargetPrincipalId() + '|' + 'a=' + #p0.getTkAssignmentId() + '|' + 'asOfDate=' + #p1 + '|' + 'isLeavePlanningCalendar=' +#p2")
      public List<EarnCode> getEarnCodesForLeaveAndTime(Assignment a, Date asOfDate, boolean isLeavePlanningCalendar);
  
      /**
       * Fetch a list of earn codes for Time usage, for a particular assignment as of a particular date
       * @param a
       * @param asOfDate
       * @return
       */
      @Cacheable(value=EarnCode.CACHE_NAME, key="'{getEarnCodesForTime}' + 'principalId=' + T(org.kuali.hr.time.util.TKContext).getPrincipalId() + '|' + 'targetId=' + T(org.kuali.hr.time.util.TKContext).getTargetPrincipalId() + '|' + 'a=' + #p0.getTkAssignmentId() + '|' + 'asOfDate=' + #p1 + '|' + 'includeRegularEarnCode=' + false")
      public List<EarnCode> getEarnCodesForTime(Assignment a, Date asOfDate);
  
      /**
       * Fetch a list of earn codes for Time usage, for a particular assignment as of a particular date
       * @param a
       * @param asOfDate
       * @return
       */
      @Cacheable(value=EarnCode.CACHE_NAME, key="'{getEarnCodesForTime}' + 'principalId=' + T(org.kuali.hr.time.util.TKContext).getPrincipalId() + '|' + 'targetId=' + T(org.kuali.hr.time.util.TKContext).getTargetPrincipalId() + '|' + 'a=' + #p0.getTkAssignmentId() + '|' + 'asOfDate=' + #p1 + '|' + 'includeRegularEarnCode=' + #p2")
      public List<EarnCode> getEarnCodesForTime(Assignment a, Date asOfDate, boolean includeRegularEarnCode);
  
  	/**
  	 * Fetch a list of earn codes for Leave usage, for a particular assignment as of a particular date
       * @param a
       * @param asOfDate
       * @param isLeavePlanningCalendar
  	 * @return
  	 */
      @Cacheable(value=EarnCode.CACHE_NAME, key="'{getEarnCodesForLeave}' + 'principalId=' + T(org.kuali.hr.time.util.TKContext).getPrincipalId() + '|' + 'targetId=' + T(org.kuali.hr.time.util.TKContext).getTargetPrincipalId() + '|' + 'a=' + #p0.getTkAssignmentId() + '|' + 'asOfDate=' + #p1 + '|' + 'isLeavePlanningCalendar=' +#p2")
      public List<EarnCode> getEarnCodesForLeave(Assignment a, Date asOfDate, boolean isLeavePlanningCalendar);
  
      /**
       * Fetch a list of earn codes based on principal ID as of a particular date
       * @param principalId
       * @param asOfDate
       * @param isLeavePlanningCalendar
       * @return
       */
      @Cacheable(value=EarnCode.CACHE_NAME, key="'principalId=' + #p0 + '|' + 'asOfDate=' + #p1 + '|' + 'isLeavePlanningCalendar=' +#p2")
      public List<EarnCode> getEarnCodesForPrincipal(String principalId, Date asOfDate, boolean isLeavePlanningCalendar);
  
      /**
       * Fetch an EarnCode as of a particular date
       * @param earnCode
       * @param asOfDate
       * @return
       */
      @Cacheable(value=EarnCode.CACHE_NAME, key="'earnCode=' + #p0 + '|' + 'asOfDate=' + #p1")
  	public EarnCode getEarnCode(String earnCode, Date asOfDate);
  
      /**
       * Fetch the earn code type for a particular date
       * @param earnCode
       * @param asOfDate
       * @return
       */
      @Cacheable(value=EarnCode.CACHE_NAME, key="'{getEarnCodeType}' + 'earnCode=' + #p0 + '|' + 'asOfDate=' + #p1")
      String getEarnCodeType(String earnCode, Date asOfDate);
      
      /**
       * Fetch earn code by id
       * @param earnCodeId
       * @return
       */
      @Cacheable(value=EarnCode.CACHE_NAME, key="'earnCodeId=' + #p0")
     public EarnCode getEarnCodeById(String earnCodeId);
     
     /**
      * Fetch list of system defined overtime earn codes
      * @param asOfDate
      * @return
      */
     @Cacheable(value=EarnCode.CACHE_NAME, key="'{getOvertimeEarnCodes}' + 'asOfDate=' + #p0")
     public List<EarnCode> getOvertimeEarnCodes(Date asOfDate);
 
 
     /**
      * Fetch list of system defined overtime earn codes as strings
      * @param asOfDate
      * @return
      */
     @Cacheable(value=EarnCode.CACHE_NAME, key="'{getOvertimeEarnCodesStrs}' + 'asOfDate=' + #p0")
     public List<String> getOvertimeEarnCodesStrs(Date asOfDate);
 
     /**
 	 * get count of earn code with give earnCode
 	 * @param earnCode
 	 * @return int
 	 */
     public int getEarnCodeCount(String earnCode);
 
     /**
 	 * get count of newer version of earn code with give earnCode and date
 	 * @param earnCode
 	 * @param effdt
 	 * @return int
 	 */
     public int getNewerEarnCodeCount(String earnCode, Date effdt);
     
     /**
      * roundHrsWithLEarnCode
      * @param hours
      * @param earnCode
      * @return
      */
     public BigDecimal roundHrsWithEarnCode(BigDecimal hours, EarnCode earnCode);
 
     /**
      * @param principalId
      * @param isLeavePlanningCalendar
      * @return
      */
     @Cacheable(value= EarnCode.CACHE_NAME, key="'{getEarnCodesForDisplay}' + 'principalId=' + #p0 + '|' + 'isLeavePlanningCalendar=' +#p1")
     public Map<String, String> getEarnCodesForDisplay(String principalId, boolean isLeavePlanningCalendar);
 
     /**
      * @param principalId
      * @param asOfDate
      * @return
      */
     @Cacheable(value= EarnCode.CACHE_NAME, key="'{getEarnCodesForDisplayWithEffectiveDate}' + 'principalId=' + #p0 + '|' + 'asOfDate=' + #p1 + '|' + 'isLeavePlanningCalendar=' +#p2")
     public Map<String, String> getEarnCodesForDisplayWithEffectiveDate(String principalId, Date asOfDate, boolean isLeavePlanningCalendar);
 
     List<EarnCode> getEarnCodes(String earnCode, String ovtEarnCode, String leavePlan, String accrualCategory, String descr, Date fromEffdt, Date toEffdt, String active, String showHist);
 }