View Javadoc
1   /**
2    * Copyright 2004-2015 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.kpme.core.calendar.service;
17  
18  import java.util.List;
19  
20  import org.joda.time.LocalDate;
21  import org.kuali.kpme.core.calendar.Calendar;
22  import org.springframework.cache.annotation.Cacheable;
23  
24  public interface CalendarService {
25  	/**
26  	 * Fetch a pay calendar with the given id
27  	 * @param hrCalendarId
28  	 * @return
29  	 */
30      @Cacheable(value= Calendar.CACHE_NAME, key="'hrCalendarId=' + #p0")
31  	public Calendar getCalendar(String hrCalendarId);
32  
33  	/**
34  	 * Fetch a pay calendar by group
35  	 * @param calendarName
36  	 * @return
37  	 */
38      @Cacheable(value= Calendar.CACHE_NAME, key="'calendarName=' + #p0")
39  	public Calendar getCalendarByGroup(String calendarName);
40  
41  	
42  	/**
43  	 * Fetch a pay calendar with the given principalId and date, returns null if none found
44  	 * @param principalId
45  	 * @param asOfDate
46  	 * @return
47  	 */
48  	public Calendar getCalendarByPrincipalIdAndDate(String principalId, LocalDate asOfDate, boolean findLeaveCal);
49  
50      /**
51       * Fetch a pay calendar with the given principalId, begin and end date, returns null if none found
52       * @param principalId
53       * @param beginDate
54       * @param endDate
55       * @return
56       */
57      public Calendar getCalendarByPrincipalIdAndDate(String principalId, LocalDate beginDate, LocalDate endDate, boolean findLeaveCal);
58  
59      public Calendar getCalendarByName(String calendarName);
60  
61      public List<Calendar> getCalendars(String calendarName, String calendarTypes, String flsaBeginDay, String flsaBeginTime);
62  
63  }