01: /*
02: * Copyright 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.Map;
19: import java.util.Set;
20:
21: /**
22: * An interface that declares methods needed for error reporting by the year end jobs
23: */
24: public interface YearEndDao {
25:
26: /**
27: * Returns the keys (Chart Code and Account Number) of PriorYearAccounts that are missing for the balances associated with the
28: * given fiscal year
29: *
30: * @param balanceFiscalYear a fiscal year to find balances for
31: * @return a set of the missing primary keys
32: */
33: public Set<Map<String, String>> findKeysOfMissingPriorYearAccountsForBalances(
34: Integer balanceFiscalYear);
35:
36: /**
37: * Returns a set of the keys (chartOfAccountsCode and accountNumber) of PriorYearAccounts that are missing for the open
38: * encumbrances of a given fiscal year
39: *
40: * @param balanceFiscalYear a fiscal year to find open encumbrances for
41: * @return a set of the missing primary keys
42: */
43: public Set<Map<String, String>> findKeysOfMissingPriorYearAccountsForOpenEncumbrances(
44: Integer encumbranceFiscalYear);
45:
46: /**
47: * Returns a set of the keys (subFundGroupCode) of sub fund groups that are missing for the prior year accounts associated with
48: * a fiscal year to find balances for
49: *
50: * @param balanceFiscalYear the fiscal year to find balances for
51: * @return a set of missing primary keys
52: */
53: public Set<Map<String, String>> findKeysOfMissingSubFundGroupsForBalances(
54: Integer balanceFiscalYear);
55:
56: /**
57: * Returns a set of the keys (subFundGroupCode) of sub fund groups that are missing for the prior year accounts associated with
58: * a fiscal year to find open encumbrances for
59: *
60: * @param encumbranceFiscalYear the fiscal year to find encumbrnaces for
61: * @return a set of missing primary keys
62: */
63: public Set<Map<String, String>> findKeysOfMissingSubFundGroupsForOpenEncumbrances(
64: Integer encumbranceFiscalYear);
65: }
|