1 /**
2 * Copyright 2004-2015 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.leave.accrual.bucket;
17
18 import java.math.BigDecimal;
19
20 import org.kuali.kpme.core.api.accrualcategory.AccrualCategoryContract;
21
22 /**
23 * <p>LeaveBalanceContract interface</p>
24 *
25 */
26 public interface LeaveBalanceContract {
27
28 /**
29 * The balance type associated with the LeaveBalance
30 *
31 * <p>
32 * This is an abstract method that gets overridden in sub classes
33 * <p>
34 *
35 * @return
36 */
37 public abstract String getBalanceType();
38
39 /**
40 * The AccuralCategory object associated with the LeaveBalance
41 *
42 * <p>
43 * balance of a LeaveBalance
44 * <p>
45 *
46 * @return balance for LeaveBalance
47 */
48 public BigDecimal getBalance();
49
50 /**
51 * The AccuralCategory object associated with the LeaveBalance
52 *
53 * <p>
54 * accrualCategory of a LeaveBalance
55 * <p>
56 *
57 * @return accrualCategory for LeaveBalance
58 */
59 public AccrualCategoryContract getAccrualCategory();
60 }