View Javadoc
1   /**
2    * Copyright 2004-2014 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.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/ecl2.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.kpme.tklm.api.time.timesummary;
17  
18  import java.math.BigDecimal;
19  import java.util.List;
20  import java.util.Map;
21  
22  
23  
24  /**
25   * <p>EarnGroupSectionContract interface</p>
26   *
27   */
28  public interface EarnGroupSectionContract {
29  
30  	/**
31  	 * The EarnGroup name associated with the EarnGroupSection
32  	 * 
33  	 * <p>
34  	 * earnGroup for an EarnGroupSection
35  	 * <p>
36  	 * 
37  	 * @return earnGroup for EarnGroupSection
38  	 */
39  	public String getEarnGroup(); 
40  	
41  	/**
42  	 * The map of totals associated with the EarnGroupSection
43  	 * 
44  	 * <p>
45  	 * totals for an EarnGroupSection
46  	 * <p>
47  	 * 
48  	 * @return totals for EarnGroupSection
49  	 */
50  	public Map<Integer, BigDecimal> getTotals();
51  	
52  	/**
53  	 * The map of EarnCode to EarnCodeSection object associated with the EarnGroupSection
54  	 * 
55  	 * <p>
56  	 * earnCodeToEarnCodeSectionMap for an EarnGroupSection
57  	 * <p>
58  	 * 
59  	 * @return earnCodeToEarnCodeSectionMap for EarnGroupSection
60  	 */
61  	public Map<String, ? extends EarnCodeSectionContract> getEarnCodeToEarnCodeSectionMap();
62  	
63  	/**
64  	 * The list of EarnCodeSection objects associated with the EarnGroupSection
65  	 * 
66  	 * <p>
67  	 * earnCodeSections for an EarnGroupSection
68  	 * <p>
69  	 * 
70  	 * @return earnCodeSections for EarnGroupSection
71  	 */
72  	public List<? extends EarnCodeSectionContract> getEarnCodeSections();
73  
74      BigDecimal getEarnGroupTotalMinutes();
75  
76      BigDecimal getEarnGroupTotalConverted();
77  }