001    /*
002     * Copyright 2011 The Kuali Foundation.
003     * 
004     * Licensed under the Educational Community License, Version 2.0 (the "License");
005     * you may not use this file except in compliance with the License.
006     * You may obtain a copy of the License at
007     * 
008     * http://www.opensource.org/licenses/ecl2.php
009     * 
010     * Unless required by applicable law or agreed to in writing, software
011     * distributed under the License is distributed on an "AS IS" BASIS,
012     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013     * See the License for the specific language governing permissions and
014     * limitations under the License.
015     */
016    package org.kuali.kfs.gl.batch.dataaccess;
017    
018    import java.util.Map;
019    import java.util.Set;
020    
021    /**
022     * An interface that declares methods needed for error reporting by the year end jobs
023     */
024    public interface YearEndDao {
025        
026        /**
027         * Returns the keys (Chart Code and Account Number) of PriorYearAccounts that are missing for the balances associated with the
028         * given fiscal year
029         * 
030         * @param balanceFiscalYear a fiscal year to find balances for
031         * @return a set of the missing primary keys
032         */
033        public Set<Map<String, String>> findKeysOfMissingPriorYearAccountsForBalances(Integer balanceFiscalYear);
034    
035        /**
036         * Returns a set of the keys (chartOfAccountsCode and accountNumber) of PriorYearAccounts that are missing for the open
037         * encumbrances of a given fiscal year
038         * 
039         * @param balanceFiscalYear a fiscal year to find open encumbrances for
040         * @return a set of the missing primary keys
041         */
042        public Set<Map<String, String>> findKeysOfMissingPriorYearAccountsForOpenEncumbrances(Integer encumbranceFiscalYear);
043    
044        /**
045         * Returns a set of the keys (subFundGroupCode) of sub fund groups that are missing for the prior year accounts associated with
046         * a fiscal year to find balances for
047         * 
048         * @param balanceFiscalYear the fiscal year to find balances for
049         * @return a set of missing primary keys
050         */
051        public Set<Map<String, String>> findKeysOfMissingSubFundGroupsForBalances(Integer balanceFiscalYear);
052    
053        /**
054         * Returns a set of the keys (subFundGroupCode) of sub fund groups that are missing for the prior year accounts associated with
055         * a fiscal year to find open encumbrances for
056         * 
057         * @param encumbranceFiscalYear the fiscal year to find encumbrnaces for
058         * @return a set of missing primary keys
059         */
060        public Set<Map<String, String>> findKeysOfMissingSubFundGroupsForOpenEncumbrances(Integer encumbranceFiscalYear);
061    }