Classes in this File | Line Coverage | Branch Coverage | Complexity | ||||
Version |
|
| 1.0;1 |
1 | /* | |
2 | * Copyright 2011 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.osedu.org/licenses/ECL-2.0 | |
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.student.r2.common.infc; | |
17 | ||
18 | import java.util.Date; | |
19 | ||
20 | public interface Version { | |
21 | ||
22 | /** | |
23 | * Version independent Id that remains the same across all versions | |
24 | * @name Version Independent Id | |
25 | * @readOnly | |
26 | * @required | |
27 | */ | |
28 | public String getVersionIndId(); | |
29 | /** | |
30 | * The sequence number of the version | |
31 | * @name Sequence Number | |
32 | * @readOnly | |
33 | * @required | |
34 | */ | |
35 | public Long getSequenceNumber(); | |
36 | ||
37 | /** | |
38 | * The date and time this version became current. | |
39 | * @name Current Version Start Date | |
40 | * @required | |
41 | */ | |
42 | public Date getCurrentVersionStart(); | |
43 | ||
44 | /** | |
45 | * The date and time when this version stopped being current. | |
46 | * @name Current Version End Date | |
47 | */ | |
48 | public Date getCurrentVersionEnd(); | |
49 | ||
50 | /** | |
51 | * Comments associated with the version | |
52 | * @name Version Comment | |
53 | */ | |
54 | public String getVersionComment(); | |
55 | ||
56 | /** | |
57 | * Versioned From Id | |
58 | * | |
59 | * TODO: Understand and document what is really is | |
60 | * @name Versioned From Id | |
61 | */ | |
62 | public String getVersionedFromId(); | |
63 | } | |
64 |