001    /*
002     * Copyright 2007 The Kuali Foundation
003     *
004     * Licensed under the Educational Community License, Version 1.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     *
008     * http://www.opensource.org/licenses/ecl1.php
009     *
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    
017    package org.kuali.student.r2.lum.lrc.infc;
018    
019    /**
020     * Captures the legal value range for a numeric result.
021     * 
022     * @author Kuali Student Team (Kamal)
023     */
024    public interface ResultValueRange {
025    
026        /**
027         * Min Result Value string Lower end of the value range. Typically
028         * corresponds with the short coded form of the result(ex. "1.0",
029         * "25.0" etc.) Should the data resultTypeKey of values (min/max)
030         * be numbers and not Strings in the value range?
031         * 
032         * @name Min Value
033         * @return a floating point decimal as a string
034         */
035        public String getMinValue();
036    
037        /**
038         * Max Result Value string Upper end of the value range. Typically
039         * corresponds with the short coded form of the result(ex. "3.0",
040         * "100.0" etc.). Upper end can be left empty to indicate
041         * unbounded upper end.
042         * 
043         * @name Max Value
044         * @return a floating point decimal as a string
045         */
046        public String getMaxValue();
047    
048        /**
049         * Increment number Legal increments in the result values. This
050         * has to be a decimal e.g 0.5)
051         * 
052         * @name Increment
053         * @return a floating point decimal as a string
054         */
055        public String getIncrement();
056    }