View Javadoc
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   * A DAO inteface that declares methods necessary to query the database for the account balance by level inquiry
26   */
27  public interface AccountBalanceLevelDao {
28  
29      /**
30       * Returns a collection of report data for the account balance by level inquiry
31       * 
32       * @param universityFiscalYear the university fiscal year of reported on account balances
33       * @param chartOfAccountsCode the chart of accounts code of reported on account balances
34       * @param accountNumber the account number of reported on account balances
35       * @param financialConsolidationObjectCode the consolidation code of reported on account balances
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       * @param today the current university date
41       * @param options system options
42       * @return a List of Maps with appropriate report data
43       */
44      public List<Map<String, Object>> findAccountBalanceByLevel(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String financialConsolidationObjectCode, boolean isCostShareExcluded, boolean isConsolidated, int pendingEntriesCode, UniversityDate today, SystemOptions options);
45  }