1 /*
2 * Copyright 2011 The Kuali Foundation Licensed under the Educational Community
3 * License, Version 2.0 (the "License"); you may not use this file except in
4 * compliance with the License. You may obtain a copy of the License at
5 * http://www.osedu.org/licenses/ECL-2.0 Unless required by applicable law or
6 * agreed to in writing, software distributed under the License is distributed
7 * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
8 * express or implied. See the License for the specific language governing
9 * permissions and limitations under the License.
10 */
11 package org.kuali.student.enrollment.lpr.infc;
12
13 import java.util.List;
14
15 import org.kuali.student.r2.common.infc.Relationship;
16
17 /**
18 * Detailed information about a single LUI to Person Relation. This is used to
19 * link together a learning unit instance and a person in such widely defined
20 * domains as a student registering in a course or an instructor being assigned
21 * to advise students in a particular program.
22 *
23 */
24 public interface Lpr extends Relationship {
25
26 /**
27 * Unique identifier for a Learning Unit Instance (LUI).
28 *
29 * @name LUI Id
30 * @required
31 */
32 public String getLuiId();
33
34 /**
35 * Unique identifier for a person record.
36 *
37 * @name Person Id
38 * @required
39 */
40 public String getPersonId();
41
42 /**
43 * Commitment percentage for the person in the LUI
44 *
45 * Valid range should be between 0 and 100.00 inclusive.
46 *
47 * @name Commitment Percent
48 * @impl Although this is a string it is expected to be parsable as a floating point number because it is stored in the database as a number so it can be easily queried This was done because of the rounding problems with many Floating implementations
49 */
50 public String getCommitmentPercent();
51
52 /**
53 * The keys of the result values groups to be applied to this LPR
54 *
55 * For example, setting the grading option to pass/fail or the credits to 3
56 * for this course.
57 *
58 * @name Result Values Group Keys
59 */
60 public List<String> getResultValuesGroupKeys();
61 }