View Javadoc

1   /**
2    * Copyright 2004-2013 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.hr.time.principal.service;
17  
18  import java.util.Date;
19  import java.util.List;
20  import org.kuali.hr.time.principal.PrincipalHRAttributes;
21  import org.springframework.cache.annotation.Cacheable;
22  
23  public interface PrincipalHRAttributesService {
24  	/**
25  	 * Fetch PrincipalCalendar object at a particular date
26  	 * @param principalId
27  	 * @param asOfDate
28  	 * @return
29  	 */
30      @Cacheable(value= PrincipalHRAttributes.CACHE_NAME, key="'principalId=' + #p0 + '|' + 'asOfDate=' + #p1")
31  	public PrincipalHRAttributes getPrincipalCalendar(String principalId, Date asOfDate);
32  
33  	/**
34  	 * Fetch inactive PrincipalHRAttributes object at a particular date
35  	 * @param principalId
36  	 * @param asOfDate
37  	 * @return
38  	 */
39      public PrincipalHRAttributes getInactivePrincipalHRAttributes(String principalId, Date asOfDate);
40  	/**
41  	 * Fetch PrincipalHRAttributes object with given id
42  	 * @param hrPrincipalAttributeId
43  	 * @return
44  	 */
45      public PrincipalHRAttributes getPrincipalHRAttributes(String hrPrincipalAttributeId);
46      
47      public List<PrincipalHRAttributes> getAllActivePrincipalHrAttributesForPrincipalId(String principalId, Date asOfDate);
48      
49      public List<PrincipalHRAttributes> getAllInActivePrincipalHrAttributesForPrincipalId(String principalId, Date asOfDate);
50      
51      public PrincipalHRAttributes getMaxTimeStampPrincipalHRAttributes(String principalId);
52      
53      /*
54       * Fetch list of PrincipalHRAttributes that become active for given principalId and date range
55       */
56      public List<PrincipalHRAttributes> getActivePrincipalHrAttributesForRange(String principalId, Date startDate, Date endDate);
57      /*
58       * Fetch list of PrincipalHRAttributes that become inactive for given principalId and date range
59       */
60      public List<PrincipalHRAttributes> getInactivePrincipalHRAttributesForRange(String principalId, Date startDate, Date endDate);  
61      /**
62       * Fetch list of PrincipalHRAttributes using given parameters
63       * @param principalId
64       * @param fromEffdt
65       * @param toEffdt
66       * @param active
67       * @param showHistory
68       * @return
69       */
70      public List<PrincipalHRAttributes> getPrincipalHrAtributes(String principalId, java.sql.Date fromEffdt, java.sql.Date toEffdt,String active, String showHistory);
71  }