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
20 import org.kuali.ole.sys.businessobject.SystemOptions;
21 import org.kuali.ole.sys.businessobject.UniversityDate;
22
23 /**
24 * A DAO interface that declares the methods necessary to query the database for the the account balance by object inquiry
25 */
26 public interface AccountBalanceObjectDao {
27
28 /**
29 * Returns a collection of report data for the account balance by object inquiry
30 *
31 * @param universityFiscalYear the university fiscal year of reported on account balances
32 * @param chartOfAccountsCode the chart of accounts code of reported on account balances
33 * @param accountNumber the account number of reported on account balances
34 * @param financialObjectLevelCode the object level code of reported on account balances
35 * @param financialReportingSortCode the sort code for reported results
36 * @param isCostShareExcluded whether cost share account balances should be excluded from the query or not
37 * @param isConsolidated whether the results of the query should be consolidated
38 * @param pendingEntriesCode whether this query should account for no pending entries, approved pending entries, or all pending
39 * entries
40 * @return a List of Maps with the results of the query
41 */
42 public List findAccountBalanceByObject(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String financialObjectLevelCode, String financialReportingSortCode, boolean isCostShareExcluded, boolean isConsolidated, int pendingEntriesCode, UniversityDate today, SystemOptions options);
43 }