1 /*
2 * Copyright 2011 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the
5 * "License"); you may not use this file except in compliance with the
6 * License. You may obtain a copy of the License at
7 *
8 * http://www.osedu.org/licenses/ECL-2.0
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
13 * implied. See the License for the specific language governing
14 * permissions and limitations under the License.
15 */
16
17 package org.kuali.student.r2.common.infc;
18
19 /**
20 * An amount.
21 *
22 * @author Kuali Student Team (sambitpa@kuali.org)
23 */
24
25 public interface Amount {
26
27 /**
28 * The kind of units associated with the quantity, such as
29 * hours/week. It is expected that in usage in other structures,
30 * this value will always be enumerated based on that context.
31 * Key
32 *
33 * @name Unit Type Key
34 * @required
35 */
36 public String getUnitTypeKey();
37
38 /**
39 * The amount of units. Allowed values consist of numeric values
40 * as well as the string "unbounded".
41 *
42 * @name Unit Quantity
43 * @required
44 */
45 public String getUnitQuantity();
46
47
48 // Compatibility
49
50 /**
51 * Use getUnitTypeKey() instead.
52 */
53
54 }