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.service;
17:
18: import java.util.Collection;
19:
20: import org.kuali.module.gl.bo.SufficientFundRebuild;
21:
22: /**
23: * An interface which declares methods needed to rebuild sufficient funds balances
24: */
25: public interface SufficientFundRebuildService {
26: /**
27: * Returns all sufficient funds records in the persistence store
28: *
29: * @return a Collection of all sufficient fund rebuild records
30: */
31: public Collection getAll();
32:
33: /**
34: * Returns all sufficient fund rebuild records using account numbers
35: *
36: * @return a Collection of sufficient fund rebuild records
37: */
38: public Collection getAllAccountEntries();
39:
40: /**
41: * Returns all sufficient fund rebuild records using object codes
42: *
43: * @return a Collection of sufficient fund rebuild records
44: */
45: public Collection getAllObjectEntries();
46:
47: /**
48: * Returns a sufficient fund rebuild record given the parameters as keys
49: *
50: * @param chartOfAccountsCode the chart of the record to return
51: * @param accountNumberFinancialObjectCode either an account number or an object code of the sufficient fund rebuild record to return
52: * @return the qualifying sufficient fund rebuild record, or null if not found
53: */
54: public SufficientFundRebuild getByAccount(
55: String chartOfAccountsCode,
56: String accountNumberFinancialObjectCode);
57:
58: /**
59: * Returns a sufficient fund rebuild record, based on the given keys
60: *
61: * @param chartOfAccountsCode the chart of the sufficient fund rebuild record to return
62: * @param accountFinancialObjectTypeCode if the record has an object code, the object code of the sufficient fund rebuild record to return
63: * @param accountNumberFinancialObjectCode if the record has an account number, the account number of the sufficient fund rebuild record to return
64: * @return the qualifying sufficient fund rebuild record, or null if not found
65: */
66: public SufficientFundRebuild get(String chartOfAccountsCode,
67: String accountFinancialObjectTypeCode,
68: String accountNumberFinancialObjectCode);
69:
70: /**
71: * Saves a sufficient fund rebuild record to the persistence store
72: *
73: * @param sfrb the sufficient fund rebuild record to save
74: */
75: public void save(SufficientFundRebuild sfrb);
76:
77: /**
78: * Deletes a SufficientFundRebuild record from the persistence store
79: *
80: * @param sfrb the sufficient fund rebuild record to delete
81: */
82: public void delete(SufficientFundRebuild sfrb);
83: }
|