001    /**
002     * Copyright 2004-2013 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl2.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.hr.lm.leaveplan.service;
017    
018    import java.sql.Date;
019    import java.util.List;
020    
021    import org.joda.time.DateTime;
022    import org.kuali.hr.lm.leaveplan.LeavePlan;
023    import org.kuali.hr.time.calendar.CalendarEntries;
024    import org.springframework.cache.annotation.Cacheable;
025    
026    public interface LeavePlanService {
027        
028        /**
029         * Fetch LeavePlan by id
030         * @param lmLeavePlanId
031         * @return
032         */
033        @Cacheable(value= LeavePlan.CACHE_NAME, key="'lmLeavePlanId=' + #p0")
034        public LeavePlan getLeavePlan(String lmLeavePlanId);
035    
036        @Cacheable(value= LeavePlan.CACHE_NAME, key="'leavePlan=' + #p0 + '|' + 'asOfDate=' + #p1")
037        public LeavePlan getLeavePlan(String leavePlan, Date asOfDate);
038        
039        public boolean isValidLeavePlan(String leavePlan);
040        
041        public List<LeavePlan> getAllActiveLeavePlan(String leavePlan, Date asOfDate);
042        
043        public List<LeavePlan> getAllInActiveLeavePlan(String leavePlan, Date asOfDate);
044    
045        List<LeavePlan> getLeavePlans(String leavePlan, String calendarYearStart, String descr, String planningMonths,
046                                      Date fromEffdt, Date toEffdt, String active, String showHistory);
047        
048        boolean isFirstCalendarPeriodOfLeavePlan(CalendarEntries calendarEntry, String leavePlan, Date asOfDate);
049        
050        boolean isLastCalendarPeriodOfLeavePlan(CalendarEntries calendarEntry, String leavePlan, Date asOfDate);
051        
052        public List<LeavePlan> getLeavePlansNeedsCarryOverScheduled(int thresholdDays, Date asOfDate);
053    
054        public DateTime getFirstDayOfLeavePlan(String leavePlan, java.util.Date date);
055        public DateTime getRolloverDayOfLeavePlan(String leavePlan, java.util.Date asOfDate);
056    }