View Javadoc

1   /**
2    * Copyright 2004-2014 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.assignment.dao;
17  
18  import java.util.List;
19  
20  import org.joda.time.LocalDate;
21  import org.kuali.kpme.core.assignment.Assignment;
22  
23  public interface AssignmentDao {
24  
25  	/**
26  	 * Returns all assignments for the provided principalId that are valid as of
27  	 * the specified payPeriodEndDate.
28  	 *
29  	 * @param principalId
30  	 * @param asOfDate
31  	 * @return
32  	 */
33  	public List<Assignment> findAssignments(String principalId, LocalDate asOfDate);
34  	/**
35  	 * Save or update the given assignment
36  	 * @param assignment
37  	 */
38  	public void saveOrUpdate(Assignment assignment);
39  	/**
40  	 * Save of update the given list of assignments
41  	 * @param assignments
42  	 */
43  	public void saveOrUpdate(List<Assignment> assignments);
44  
45  	/**
46  	 * Delete an assignment
47  	 * @param assignment
48  	 */
49  	public void delete(Assignment assignment);
50  
51  	/**
52  	 * Get list of active assignments in a given work area as of a particular date
53  	 * @param workArea
54  	 * @param asOfDate
55  	 * @return
56  	 */
57  	public List<Assignment> getActiveAssignmentsInWorkArea(Long workArea, LocalDate asOfDate);
58  
59      public List<Assignment> getActiveAssignmentsInWorkAreas(List<Long> workAreas, LocalDate asOfDate);
60  
61  	public Assignment getAssignment(String tkAssignmentId);
62  
63      public Assignment getAssignmentForTargetPrincipal(Long job, Long workArea, Long task, LocalDate asOfDate);
64  
65  	public List<Assignment> getActiveAssignments(LocalDate asOfDate);
66  	
67  	public Assignment getAssignment(String principalId, Long jobNumber, Long workArea, Long task, LocalDate asOfDate);
68  	
69  	/**
70  	 * KPME-1129
71  	 * Get a list of active assignments based on principalId and jobNumber as of a particular date 
72  	 * @param principalId
73  	 * @param jobNumber
74  	 * @param asOfDate
75  	 * @return
76  	 */
77  	public List<Assignment> getActiveAssignmentsForJob(String principalId, Long jobNumber, LocalDate asOfDate);
78  
79      List<Assignment> findAssignmentsWithinPeriod(String principalId, LocalDate startDate, LocalDate endDate);
80  
81      List<Assignment> searchAssignments(LocalDate fromEffdt, LocalDate toEffdt, String principalId, String jobNumber,
82                                      String dept, String workArea, String active, String showHistory);
83      
84      public Assignment getMaxTimestampAssignment(String principalId);
85      
86      public List<String> getPrincipalIds(List<String> workAreaList, LocalDate effdt, LocalDate startDate, LocalDate endDate);
87      
88      public List<Assignment> getAssignments(List<String> workAreaList, LocalDate effdt, LocalDate startDate, LocalDate endDate);
89  }