1 /**
2 * Copyright 2012 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the
5 * "License"); you may not use this file except in compliance with the
6 * License. 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
13 * implied. See the License for the specific language governing
14 * permissions and limitations under the License.
15 */
16
17 package org.kuali.student.enrollment.roster.infc;
18
19 import org.kuali.student.r2.common.infc.Relationship;
20
21
22 /**
23 * An Lpr Roster Entry relates an LPR to an LprRoster.
24 */
25
26 public interface LprRosterEntry
27 extends Relationship {
28
29 /**
30 * The LPR Roster Id to which this LPR roster entry belongs.
31 *
32 * @name LprRoster Id
33 * @readOnly
34 * @required
35 */
36 public String getLprRosterId();
37
38 /**
39 * The LPR Id of this entry.
40 *
41 * @name Lpr Id
42 * @readOnly
43 * @required
44 */
45 public String getLprId();
46
47 /**
48 * The position of this entry within an ordered LPR Roster.
49 *
50 * If not supplied when the entry is created the service should
51 * set it to the next sequential number available if needed for an
52 * ordered roster.
53 *
54 * The service does not have to guarantee uniqueness of this field
55 * within a roster.
56 *
57 * This field cannot be relied upon to determine exactly how many
58 * people are ahead of a person in the roster because the sequence
59 * may contain gaps (because of deletes) or duplicates. Moreover
60 * a particular roster may order entries using different
61 * algorithms, for example it may be FIFO or LIFO or it may take
62 * other factors into account, such as the state, to determine
63 * which entry process next.
64 *
65 * @name Position
66 */
67 public Integer getPosition();
68 }