1 /*
2 * The Kuali Financial System, a comprehensive financial management system for higher education.
3 *
4 * Copyright 2005-2014 The Kuali Foundation
5 *
6 * This program is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU Affero General Public License as
8 * published by the Free Software Foundation, either version 3 of the
9 * License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU Affero General Public License for more details.
15 *
16 * You should have received a copy of the GNU Affero General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19 package org.kuali.kfs.gl.dataaccess;
20
21 import java.util.Collection;
22
23 /**
24 * A DAO interface declaring methods needed to help SufficientFundBalance records interact with the database
25 */
26 public interface SufficientFundBalancesDao {
27 /**
28 * Fetches sufficient fund balances based on given keys of fiscal year, chart code, and object code
29 *
30 * @param universityFiscalYear the university fiscal year of sufficient fund balances to find
31 * @param chartOfAccountsCode the chart of accounts code of sufficient fund balances to find
32 * @param financialObjectCode the object code of sufficient fund balances to find
33 * @return a Collection of sufficient fund balances, qualified by the parameter values
34 */
35 public Collection getByObjectCode(Integer universityFiscalYear, String chartOfAccountsCode, String financialObjectCode);
36
37 /**
38 * Deletes sufficient fund balances associated with a given year, chart, and account number
39 *
40 * @param universityFiscalYear the university fiscal year of sufficient fund balances to delete
41 * @param chartOfAccountsCode the chart code of sufficient fund balances to delete
42 * @param accountNumber the account number of sufficient fund balances to delete
43 * @return the number of records deleted
44 */
45 public int deleteByAccountNumber(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber);
46
47 /**
48 * 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
49 * sace for production.
50 *
51 * @return a Collection with all sufficient funds balances in the database
52 */
53 public Collection testingGetAllEntries();
54 }