1 /*
2 * Copyright 2007 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
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.ole.gl.batch.dataaccess;
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(Integer balanceFiscalYear);
34
35 /**
36 * Returns a set of the keys (chartOfAccountsCode and accountNumber) of PriorYearAccounts that are missing for the open
37 * encumbrances of a given fiscal year
38 *
39 * @param balanceFiscalYear a fiscal year to find open encumbrances for
40 * @return a set of the missing primary keys
41 */
42 public Set<Map<String, String>> findKeysOfMissingPriorYearAccountsForOpenEncumbrances(Integer encumbranceFiscalYear);
43
44 /**
45 * Returns a set of the keys (subFundGroupCode) of sub fund groups that are missing for the prior year accounts associated with
46 * a fiscal year to find balances for
47 *
48 * @param balanceFiscalYear the fiscal year to find balances for
49 * @return a set of missing primary keys
50 */
51 public Set<Map<String, String>> findKeysOfMissingSubFundGroupsForBalances(Integer balanceFiscalYear);
52
53 /**
54 * Returns a set of the keys (subFundGroupCode) of sub fund groups that are missing for the prior year accounts associated with
55 * a fiscal year to find open encumbrances for
56 *
57 * @param encumbranceFiscalYear the fiscal year to find encumbrnaces for
58 * @return a set of missing primary keys
59 */
60 public Set<Map<String, String>> findKeysOfMissingSubFundGroupsForOpenEncumbrances(Integer encumbranceFiscalYear);
61 }