1 /*
2 * Copyright 2006 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.ole.gl.dataaccess;
17
18 import java.util.Collection;
19
20 /**
21 * A DAO interface declaring methods needed to help SufficientFundBalance records interact with the database
22 */
23 public interface SufficientFundBalancesDao {
24 /**
25 * Fetches sufficient fund balances based on given keys of fiscal year, chart code, and object code
26 *
27 * @param universityFiscalYear the university fiscal year of sufficient fund balances to find
28 * @param chartOfAccountsCode the chart of accounts code of sufficient fund balances to find
29 * @param financialObjectCode the object code of sufficient fund balances to find
30 * @return a Collection of sufficient fund balances, qualified by the parameter values
31 */
32 public Collection getByObjectCode(Integer universityFiscalYear, String chartOfAccountsCode, String financialObjectCode);
33
34 /**
35 * Deletes sufficient fund balances associated with a given year, chart, and account number
36 *
37 * @param universityFiscalYear the university fiscal year of sufficient fund balances to delete
38 * @param chartOfAccountsCode the chart code of sufficient fund balances to delete
39 * @param accountNumber the account number of sufficient fund balances to delete
40 * @return the number of records deleted
41 */
42 public int deleteByAccountNumber(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber);
43
44 /**
45 * This method should only be used in unit tests. It loads all the gl_sf_balances_t rows in memory into a collection. This won't
46 * sace for production.
47 *
48 * @return a Collection with all sufficient funds balances in the database
49 */
50 public Collection testingGetAllEntries();
51 }