01: /*
02: * Copyright 2006-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.gl.dao;
17:
18: import java.util.Collection;
19:
20: import org.kuali.module.gl.bo.SufficientFundBalances;
21:
22: /**
23: * A DAO interface declaring methods needed to help SufficientFundBalance records interact with the database
24: */
25: public interface SufficientFundBalancesDao {
26: /**
27: * Fetches sufficient fund balances based on given keys of fiscal year, chart code, and object code
28: *
29: * @param universityFiscalYear the university fiscal year of sufficient fund balances to find
30: * @param chartOfAccountsCode the chart of accounts code of sufficient fund balances to find
31: * @param financialObjectCode the object code of sufficient fund balances to find
32: * @return a Collection of sufficient fund balances, qualified by the parameter values
33: */
34: public Collection getByObjectCode(Integer universityFiscalYear,
35: 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: */
44: public void deleteByAccountNumber(Integer universityFiscalYear,
45: String chartOfAccountsCode, String accountNumber);
46:
47: /**
48: * Returns a sufficient fund balance by its primary key values
49: *
50: * @param universityFiscalYear the university fiscal year of the sufficient funds balance to return
51: * @param chartOfAccountsCode the chart of accounts code of the sufficient funds balance to return
52: * @param accountNumber the account number of the sufficient funds balance to return
53: * @param financialObjectCode the object code of the sufficient funds balance to return
54: * @return the qualifying sufficient funds balance record, or null no suitable record can be found
55: */
56: public SufficientFundBalances getByPrimaryId(
57: Integer universityFiscalYear, String chartOfAccountsCode,
58: String accountNumber, String financialObjectCode);
59:
60: /**
61: * Save a sufficient funds balance
62: *
63: * @param sfb the sufficient funds balance to save
64: */
65: public void save(SufficientFundBalances sfb);
66:
67: /**
68: * 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
69: * sace for production.
70: *
71: * @return a Collection with all sufficient funds balances in the database
72: */
73: public Collection testingGetAllEntries();
74: }
|