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.leave.block;
17
18 import java.sql.Timestamp;
19
20
21 /**
22 * <p>LeaveBlockHistoryContract interface</p>
23 *
24 */
25 public interface LeaveBlockHistoryContract extends LeaveBlockContract {
26
27 /**
28 * The primary key of a LeaveBlockHistory entry saved in a database
29 *
30 * <p>
31 * lmLeaveBlockHistoryId of a LeaveBlockHistory
32 * <p>
33 *
34 * @return lmLeaveBlockHistoryId for LeaveBlockHistory
35 */
36 public String getLmLeaveBlockHistoryId();
37
38 /**
39 * The action associated with the LeaveBlockHistory
40 *
41 * <p>
42 * action of a LeaveBlockHistory
43 * <p>
44 *
45 * @return action for LeaveBlockHistory
46 */
47 public String getAction();
48
49 /**
50 * TODO: Put a better comment
51 * The principalIdDeleted associated with the LeaveBlockHistory
52 *
53 * <p>
54 * principalIdDeleted of a LeaveBlockHistory
55 * <p>
56 *
57 * @return principalIdDeleted for LeaveBlockHistory
58 */
59 public String getPrincipalIdDeleted();
60
61 /**
62 * TODO: Put a better comment
63 * The timestampDeleted associated with the LeaveBlockHistory
64 *
65 * <p>
66 * timestampDeleted of a LeaveBlockHistory
67 * <p>
68 *
69 * @return timestampDeleted for LeaveBlockHistory
70 */
71 public Timestamp getTimestampDeleted();
72
73 /**
74 * The assignment title associated with the LeaveBlockHistory
75 *
76 * <p>
77 * If the leave block associated with the LeaveBlockHistory is not null, it checks its work area. If the work area is not null,
78 * it gets its description and its task. If the task is not null and not the default task, it gets the task description.
79 * <p>
80 *
81 * @return "work area description - task description" for LeaveBlockHistory
82 */
83 public String getAssignmentTitle();
84 }