01: /*
02: * Copyright 2005-2007 The Kuali Foundation.
03: *
04: * Licensed under the Educational Community License, Version 1.0 (the "License");
05: * you may not use this file except in compliance with the License.
06: * You may obtain a copy of the License at
07: *
08: * http://www.opensource.org/licenses/ecl1.php
09: *
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.module.chart.service;
17:
18: import java.util.Collection;
19: import java.util.List;
20:
21: import org.kuali.module.chart.bo.codes.BalanceTyp;
22:
23: /**
24: * This service interface defines methods necessary for retrieving fully populated BalanceType business objects from the database
25: * that are necessary for transaction processing in the application. This interface defines methods for each balance type that is
26: * needed by the application. TODO - Continue to update this with new balance type as they are needed.
27: */
28: public interface BalanceTypService {
29: /**
30: * This method retrieves a full instance of the appropriate BalanceType instance - Actual.
31: *
32: * @return
33: */
34: public BalanceTyp getActualBalanceTyp();
35:
36: /**
37: * This method retrieves all valid balance types in the system.
38: *
39: * @return A list of active balance types in Kuali.
40: */
41: public Collection getAllBalanceTyps();
42:
43: /**
44: * Get encumbrance balance TYPES
45: *
46: * @return
47: */
48: public Collection getEncumbranceBalanceTypes();
49:
50: /**
51: * This method retrieves a BalanceTyp instance from the Kuali database by its primary key - the balance typ's code.
52: *
53: * @param code The primary key in the database for this data type.
54: * @return A fully populated object instance.
55: */
56: public BalanceTyp getBalanceTypByCode(String code);
57:
58: /**
59: * Returns the list of encumbrance-related balance types from options table for a given university fiscal year
60: *
61: * @param universityFiscalYear
62: * @return
63: */
64: public List<String> getEncumbranceBalanceTypes(
65: Integer universityFiscalYear);
66:
67: /**
68: * Returns the cost share encumbrance balance type from options table for a given university fiscal year
69: *
70: * @param universityFiscalYear
71: * @return
72: */
73: public String getCostShareEncumbranceBalanceType(
74: Integer universityFiscalYear);
75:
76: /**
77: * Returns the list of encumbrance-related balance types from options table for the current university fiscal year
78: *
79: * @param universityFiscalYear
80: * @return
81: */
82: public List<String> getCurrentYearEncumbranceBalanceTypes();
83:
84: /**
85: * Returns the cost share encumbrance balance type from options table for the current university fiscal year
86: *
87: * @param universityFiscalYear
88: * @return
89: */
90: public String getCurrentYearCostShareEncumbranceBalanceType();
91:
92: public List<String> getContinuationAccountBypassBalanceTypeCodes(
93: Integer universityFiscalYear);
94: }
|