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.dataaccess;
17
18 import java.util.List;
19 import java.util.Map;
20
21 import org.kuali.ole.sys.businessobject.SystemOptions;
22 import org.kuali.ole.sys.businessobject.UniversityDate;
23
24 /**
25 * An interface to methods needed to calculate Balance By Consolidation Balance inquiries to query the database
26 */
27 public interface AccountBalanceConsolidationDao {
28
29 /**
30 * Returns account balance information that qualifies, based on the inquiry formed out of the parameters
31 *
32 * @param objectTypes the object types of account balances to include in the inquiry
33 * @param universityFiscalYear the fiscal year of account balances to include in the inquiry
34 * @param chartOfAccountsCode the chart of accounts of account balances to include in the inquiry
35 * @param accountNumber the account number of account balances to include in the inquiry
36 * @param isExcludeCostShare whether to exclude cost share entries from this inquiry or not
37 * @param isConsolidated whether the results of the inquiry should be consolidated
38 * @param pendingEntriesCode whether the inquiry should also report results based on no pending entries, approved pending
39 * entries, or all pending entries
40 * @param options system options
41 * @param today current university date
42 * @return a List of Maps with the report information from this inquiry
43 */
44 public List<Map<String, Object>> findAccountBalanceByConsolidationObjectTypes(String[] objectTypes, Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, boolean isExcludeCostShare, boolean isConsolidated, int pendingEntriesCode, SystemOptions options, UniversityDate today);
45 }