1 package org.kuali.kpme.edo.api.supplemental;
2
3 import org.joda.time.DateTime;
4 import org.kuali.kpme.core.api.mo.KpmeDataTransferObject;
5
6 /**
7 * <p>EdoSupplementalTrackingContract interface</p>
8 *
9 */
10 public interface EdoSupplementalTrackingContract extends KpmeDataTransferObject {
11
12 /**
13 * The identifier of the EdoSupplementalTracking
14 *
15 * <p>
16 * edoSupplementalTrackingId of the EdoSupplementalTracking
17 * <p>
18 *
19 * @return edoSupplementalTrackingId for EdoSupplementalTracking
20 */
21 public String getEdoSupplementalTrackingId();
22
23 /**
24 * The dossier id that the EdoSupplementalTracking is associated with
25 *
26 * <p>
27 * edoDossierId of the EdoSupplementalTracking
28 * <p>
29 *
30 * @return edoDossierId for EdoSupplementalTracking
31 */
32 public String getEdoDossierId();
33
34 /**
35 * The review level of the EdoSupplementalTracking
36 *
37 * <p>
38 * reviewLevel of the EdoSupplementalTracking
39 * <p>
40 *
41 * @return reviewLevel for EdoSupplementalTracking
42 */
43 public int getReviewLevel();
44
45 /**
46 * TODO Put a better comment
47 * Indicates whehter the EdoSupplementalTracking is acknowledged or not
48 *
49 * <p>
50 * acknowledged of the EdoSupplementalTracking
51 * <p>
52 *
53 * @return Y for Yes, N for No
54 */
55 public boolean isAcknowledged();
56
57 /**
58 * The user principal id who takes action on the EdoItem
59 *
60 * <p>
61 * userPrincipalId of the EdoItem
62 * <p>
63 *
64 * @return userPrincipalId for EdoItem
65 */
66 public String getUserPrincipalId();
67
68 /**
69 * The actionTimestamp (DateTime) the EdoItem is associated with
70 *
71 * <p>
72 * actionTimestamp of the EdoItem
73 * <p>
74 *
75 * @return actionTimestamp wrapped in a DateTime object
76 */
77 public DateTime getActionFullDateTime() ;
78
79 }