1 /*
2 * Copyright 2011 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.clu.infc;
17
18 import org.kuali.student.r2.common.infc.CurrencyAmount;
19 import org.kuali.student.r2.common.infc.HasAttributesAndMeta;
20 import org.kuali.student.r2.common.infc.HasKey;
21 import org.kuali.student.r2.common.infc.RichText;
22
23 import java.util.List;
24
25 /**
26 * Information about a fee related to an learning unit
27 */
28 public interface Fee extends HasKey, HasAttributesAndMeta {
29
30 /**
31 * A code that identifies the type of the fee. For example: Lab Fee or
32 * Tuition Fee or CMF for Course Materials Fee. From a program perspective
33 * it may be an application fee.
34 *
35 * @name: Fee Type
36 */
37 public String getFeeType();
38
39 /**
40 * Indicates the structure and interpretation of the fee amounts, i.e.
41 * Fixed, Variable, Multiple.
42 *
43 * @name Rate Type
44 */
45 public String getRateType();
46
47 /**
48 * The amount or amounts associated with the fee. The number fee amounts and
49 * interpretation depends on the rate type.
50 *
51 * @name Fee Amounts
52 */
53 public List<? extends CurrencyAmount> getFeeAmounts();
54
55 /**
56 * Narrative description of the Fee.
57 *
58 * @name Description
59 */
60 public RichText getDescr();
61 }