001/*
002 * Copyright 2007 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 */
016package org.kuali.ole.gl.dataaccess;
017
018import java.util.List;
019
020import org.kuali.ole.sys.businessobject.SystemOptions;
021import org.kuali.ole.sys.businessobject.UniversityDate;
022
023/**
024 * A DAO interface that declares the methods necessary to query the database for the the account balance by object inquiry
025 */
026public interface AccountBalanceObjectDao {
027
028    /**
029     * Returns a collection of report data for the account balance by object inquiry
030     * 
031     * @param universityFiscalYear the university fiscal year of reported on account balances
032     * @param chartOfAccountsCode the chart of accounts code of reported on account balances
033     * @param accountNumber the account number of reported on account balances
034     * @param financialObjectLevelCode the object level code of reported on account balances
035     * @param financialReportingSortCode the sort code for reported results
036     * @param isCostShareExcluded whether cost share account balances should be excluded from the query or not
037     * @param isConsolidated whether the results of the query should be consolidated
038     * @param pendingEntriesCode whether this query should account for no pending entries, approved pending entries, or all pending
039     *        entries
040     * @return a List of Maps with the results of the query
041     */
042    public List findAccountBalanceByObject(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String financialObjectLevelCode, String financialReportingSortCode, boolean isCostShareExcluded, boolean isConsolidated, int pendingEntriesCode, UniversityDate today, SystemOptions options);
043}