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.dataaccess;
017    
018    import java.util.List;
019    import java.util.Map;
020    
021    /**
022     * An interface to methods needed to calculate Balance By Consolidation Balance inquiries to query the database
023     */
024    public interface AccountBalanceConsolidationDao {
025    
026        /**
027         * Returns account balance information that qualifies, based on the inquiry formed out of the parameters
028         * 
029         * @param objectTypes the object types of account balances to include in the inquiry
030         * @param universityFiscalYear the fiscal year of account balances to include in the inquiry
031         * @param chartOfAccountsCode the chart of accounts of account balances to include in the inquiry
032         * @param accountNumber the account number of account balances to include in the inquiry
033         * @param isExcludeCostShare whether to exclude cost share entries from this inquiry or not
034         * @param isConsolidated whether the results of the inquiry should be consolidated
035         * @param pendingEntriesCode whether the inquiry should also report results based on no pending entries, approved pending entries, or all pending entries
036         * @return a List of Maps with the report information from this inquiry
037         */
038        public List<Map<String, Object>> findAccountBalanceByConsolidationObjectTypes(String[] objectTypes, Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, boolean isExcludeCostShare, boolean isConsolidated, int pendingEntriesCode);
039    }