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.tklm.api.time.missedpunch;
17
18
19 import java.util.List;
20
21 public interface MissedPunchService {
22 /**
23 * Get a list of Missed Punches by Timesheet document ids.
24 *
25 * @param timesheetDocumentId The Timesheet document id to look up
26 *
27 * @return a list of Missed Punch Documents associated with the given Timesheet document id
28 */
29 List<MissedPunch> getMissedPunchByTimesheetDocumentId(String timesheetDocumentId);
30
31 /**
32 * Get a Missed Punch by its unique Clock Log id.
33 *
34 * @param clockLogId The Clock Log id to look up
35 *
36 * @return the Missed Punch associated with the given Clock Log id
37 */
38 public MissedPunch getMissedPunchByClockLogId(String clockLogId);
39
40 /**
41 * Add a Clock Log to the specified Missed Punch
42 *
43 * @param missedPunch The Missed Punch to add the Clock Log to
44 * @param ipAddress The IP address of the user
45 */
46 public MissedPunch addClockLog(MissedPunch missedPunch, String ipAddress);
47
48 /**
49 * Update the Clock Log (and any Time Blocks if necessary) for the given Missed Punch.
50 *
51 * @param missedPunch The Missed Punch to update the Clock Logs for
52 * @param ipAddress The IP address of the user
53 */
54 public MissedPunch updateClockLog(MissedPunch missedPunch, String ipAddress);
55 }