View Javadoc

1   /**
2    * Copyright 2010 The Kuali Foundation Licensed under the
3    * Educational Community License, Version 2.0 (the "License"); you may
4    * not use this file except in compliance with the License. You may
5    * obtain a copy of the License at
6    *
7    * http://www.osedu.org/licenses/ECL-2.0
8    *
9    * Unless required by applicable law or agreed to in writing,
10   * software distributed under the License is distributed on an "AS IS"
11   * BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express
12   * or implied. See the License for the specific language governing
13   * permissions and limitations under the License.
14   */
15  
16  package org.kuali.student.enrollment.academicrecord.infc;
17  
18  import org.kuali.student.r2.common.infc.IdNamelessEntity;
19  
20  /**
21   * Information about a GPA.
22   *
23   * @author tom
24   * @since Tue Sep 06 14:22:34 EDT 2011
25   */ 
26  
27  public interface GPA
28      extends IdNamelessEntity {
29  
30      /**
31       * The GPA value.
32       *
33       * @return a string representing a floating point decimal number
34       * @name Value
35       * @readOnly
36       * @required
37       */
38      public String getValue();
39  
40      /**
41       * The calculation Type key.
42       *
43       * @name Calculation Type Key
44       * @readOnly
45       * @required
46       */
47      public String getCalculationTypeKey();
48  
49      /**
50       * The key of the scale.
51       *
52       * @name Scale Key
53       * @readOnly
54       */
55      public String getScaleKey();
56  }