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
17 package org.kuali.student.r2.lum.lrc.infc;
18
19 /**
20 * Captures the legal value range for a numeric result.
21 *
22 * @author Kuali Student Team (Kamal)
23 */
24 public interface ResultValueRange {
25
26 /**
27 * Min Result Value string Lower end of the value range. Typically
28 * corresponds with the short coded form of the result(ex. "1.0",
29 * "25.0" etc.) Should the data resultTypeKey of values (min/max)
30 * be numbers and not Strings in the value range?
31 *
32 * @name Min Value
33 * @return a floating point decimal as a string
34 */
35 public String getMinValue();
36
37 /**
38 * Max Result Value string Upper end of the value range. Typically
39 * corresponds with the short coded form of the result(ex. "3.0",
40 * "100.0" etc.). Upper end can be left empty to indicate
41 * unbounded upper end.
42 *
43 * @name Max Value
44 * @return a floating point decimal as a string
45 */
46 public String getMaxValue();
47
48 /**
49 * Increment number Legal increments in the result values. This
50 * has to be a decimal e.g 0.5)
51 *
52 * @name Increment
53 * @return a floating point decimal as a string
54 */
55 public String getIncrement();
56 }