1 /*
2 * Copyright 2007 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 1.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/ecl1.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.student.r2.lum.lrc.infc;
17
18 import org.kuali.student.r2.common.infc.KeyEntity;
19 import org.kuali.student.r2.common.infc.HasEffectiveDates;
20
21 /**
22 * A Result Value.
23 */
24
25 public interface ResultValue extends KeyEntity, HasEffectiveDates {
26
27 /**
28 * Identifier of the scale for this result value.
29 *
30 * @name Result Scale Key
31 */
32 public String getResultScaleKey();
33
34 /**
35 * A numeric value used to ranking or order this result value
36 * within the scale.
37 *
38 * For Grades it holds the quality points, i.e. A=4.0, B=3.0. For
39 * credits it holds the actual numeric credits. For degrees it is
40 * used to indicate perhaps how many years of study it typically
41 * takes to achieve that degree.
42 *
43 * @name Numeric Value
44 * @return a floating point decimal as a string
45 */
46 public String getNumericValue();
47
48 /**
49 * Result Value string Value of the result. Typically corresponds
50 * with the short coded form of the result (ex. "A", "4.0",
51 * "97.0", "B.S" etc.) scaleKey Scale Identifier scaleKey.
52 *
53 * @name Result value
54 */
55 public String getValue();
56 }