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.timeblock;
17
18 import java.sql.Timestamp;
19 import java.util.List;
20
21 import org.kuali.rice.kim.api.identity.Person;
22
23
24 /**
25 * <p>TimeBlockHistoryContract interface</p>
26 *
27 */
28 public interface TimeBlockHistoryContract extends TimeBlockContract {
29
30 /**
31 * The primary key of a TimeBlockHistory entry saved in a database
32 *
33 * <p>
34 * tkTimeBlockHistoryId of a TimeBlockHistory
35 * <p>
36 *
37 * @return tkTimeBlockHistoryId for TimeBlockHistory
38 */
39 public String getTkTimeBlockHistoryId();
40
41 /**
42 * The action history associated with the TimeBlockHistory
43 *
44 * <p>
45 * actionHistory of a TimeBlockHistory
46 * <p>
47 *
48 * @return actionHistory for TimeBlockHistory
49 */
50 public String getActionHistory();
51
52 /**
53 * TODO: Put a better comment
54 * The modifiedByPrincipalId associated with the TimeBlockHistory
55 *
56 * <p>
57 * modifiedByPrincipalId of a TimeBlockHistory
58 * <p>
59 *
60 * @return modifiedByPrincipalId for TimeBlockHistory
61 */
62 public String getModifiedByPrincipalId();
63
64 /**
65 * The timestampModified associated with the TimeBlockHistory
66 *
67 * <p>
68 * timestampModified of a TimeBlockHistory
69 * <p>
70 *
71 * @return timestampModified for TimeBlockHistory
72 */
73 public Timestamp getTimestampModified();
74
75 /**
76 * The principal associated with the TimeBlockHistory
77 *
78 * <p>
79 * principal of a TimeBlockHistory
80 * <p>
81 *
82 * @return principal for TimeBlockHistory
83 */
84 public Person getPrincipal();
85
86 /**
87 * TODO: What's the difference between this field and principal??
88 * The userPrincipal associated with the TimeBlockHistory
89 *
90 * <p>
91 * userPrincipal of a TimeBlockHistory
92 * <p>
93 *
94 * @return userPrincipal for TimeBlockHistory
95 */
96 public Person getUserPrincipal();
97
98 /**
99 * The list of TimeBlockHistoryDetail objects associated with the TimeBlockHistory
100 *
101 * <p>
102 * timeBlockHistoryDetails of a TimeBlockHistory
103 * <p>
104 *
105 * @return timeBlockHistoryDetails for TimeBlockHistory
106 */
107 public List<? extends TimeBlockHistoryDetailContract> getTimeBlockHistoryDetails();
108
109 /**
110 * The TimeBlock object associated with the TimeBlockHistory
111 *
112 * <p>
113 * this.timeBlock of a TimeBlockHistory
114 * <p>
115 *
116 * @return this.timeBlock for TimeBlockHistory
117 */
118 public TimeBlockContract getTimeBlock();
119
120 }