01: /*
02: * Copyright 2006 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.SufficientFundRebuild;
21:
22: /**
23: *
24: * This class...
25: */
26: public interface SufficientFundRebuildDao {
27: /**
28: * Returns all sufficient fund rebuild balances in the database
29: *
30: * @return a Collection with all sufficient fund rebuild balances
31: */
32: public Collection getAll();
33:
34: /**
35: * Returns all sufficient fund rebuild balances with a given object type code
36: *
37: * @param accountFinancialObjectTypeCode the object type code of sufficient fund balances to return
38: * @return a Collection of qualifying sufficient fund balances
39: */
40: public Collection getByType(String accountFinancialObjectTypeCode);
41:
42: /**
43: * Returns the sufficient fund rebuild balance by chart and account number/object code
44: *
45: * @param chartOfAccountsCode the chart of the rebuild balance to return
46: * @param accountNumberFinancialObjectCode the account number or object code of the rebuild balance to returnd
47: * @return a qualifying sufficient fund rebuild record if found in the database, or null
48: */
49: public SufficientFundRebuild getByAccount(
50: String chartOfAccountsCode,
51: String accountNumberFinancialObjectCode);
52:
53: /**
54: * Returns the sufficient fund rebuild balance with the primary key given by the parameters
55: *
56: * @param chartOfAccountsCode the chart of the rebuild balance to return
57: * @param accountFinancialObjectTypeCode the object type code of the rebuild balance to return
58: * @param accountNumberFinancialObjectCode the account number or fiscal object of the rebuild balance to return
59: * @return the qualifying rebuild balance, or null if not found in the database
60: */
61: public SufficientFundRebuild get(String chartOfAccountsCode,
62: String accountFinancialObjectTypeCode,
63: String accountNumberFinancialObjectCode);
64:
65: /**
66: * Saves a sufficient funds rebuild records to the database
67: *
68: * @param sfrb the sufficient fund rebuild balance to save
69: */
70: public void save(SufficientFundRebuild sfrb);
71:
72: /**
73: * Deletes a sufficient fund rebuild balance
74: * @param sfrb the sufficient fund rebuild balance to delete
75: */
76: public void delete(SufficientFundRebuild sfrb);
77:
78: /**
79: * This method should only be used in unit tests. It loads all the gl_sf_rebuild_t rows in memory into a collection. This won't
80: * sace for production.
81: *
82: * @return a Collection of all sufficient fund rebuild balances in the database
83: */
84: public Collection testingGetAllEntries();
85: }
|