/*
* The Kuali Financial System, a comprehensive financial management system for higher education.
*
* Copyright 2005-2014 The Kuali Foundation
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.kuali.kfs.gl.service;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import org.kuali.kfs.gl.businessobject.AccountBalance;
/**
* This interface delcares methods useful for dealing with AccountBalance objects.
*/
public interface AccountBalanceService {
public final int PENDING_NONE = 1;
public final int PENDING_APPROVED = 2;
public final int PENDING_ALL = 3;
/**
* This method finds the available account balances according to input fields and values
*
* @param fieldValues the input fields and values
* @return the summary records of account balance entries
*/
public Iterator findConsolidatedAvailableAccountBalance(Map fieldValues);
/**
* This method gets the number of the available account balances according to input fields and values
*
* @param fieldValues the input fields and values
* @param isConsolidated determine whether the search results are consolidated
* @return the number of the available account balances
*/
public Integer getAvailableAccountBalanceCount(Map fieldValues, boolean isConsolidated);
/**
* This method finds the available account balances according to input fields and values
*
* @param fieldValues the input fields and values
* @param isConsolidated determine whether the search results are consolidated
* @return a collection of account balance entries
*/
public Iterator findAvailableAccountBalance(Map fieldValues);
/**
* This method finds the available account balances according to input fields and values
*
* @param universityFiscalYear the fiscal year account to find account balances for
* @param chartOfAccountsCode the chart of accounts code to find account balances for
* @param accountNumber the account number to find account balances for
* @param subAccountNumber the sub account number to find account balances for
* @param isCostShareExcluded should account balances found have cost share information excluded?
* @param isConsolidated should account balances found be consolidated?
* @param pendingEntryCode should pending entries be included in the query?
* @return a List of qualifying account balance records
*/
public List findAccountBalanceByConsolidation(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String subAccountNumber, boolean isCostShareExcluded, boolean isConsolidated, int pendingEntryCode);
/**
* This method finds the available account balances according to input fields and values
*
* @param universityFiscalYear the fiscal year account to find account balances for
* @param chartOfAccountsCode the chart of accounts code to find account balances for
* @param accountNumber the account number to find account balances for
* @param subAccountNumber the sub account number to find account balances for
* @param financialConsolidationCode the consolidation code to find account balances for
* @param isCostShareExcluded should account balances found have cost share information excluded?
* @param isConsolidated should account balances found be consolidated?
* @param pendingEntryCode should pending entries be included in the query?
* @return a List of qualifying account balance records
*/
public List findAccountBalanceByLevel(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String subAccountNumber, String financialConsolidationObjectCode, boolean isCostShareExcluded, boolean isConsolidated, int pendingEntryCode);
/**
* This method finds the available account balances according to input fields and values
*
* @param universityFiscalYear the fiscal year account to find account balances for
* @param chartOfAccountsCode the chart of accounts code to find account balances for
* @param accountNumber the account number to find account balances for
* @param subAccountNumber the sub account number to find account balances for
* @param financialObjectLevelCode the financial object level code to find account balances for
* @param financialReportingSortCode the reporting sort code to sort account balances by
* @param isCostShareExcluded should account balances found have cost share information excluded?
* @param isConsolidated should account balances found be consolidated?
* @param pendingEntryCode should pending entries be included in the query?
* @return a List of qualifying account balance records
*/
public List findAccountBalanceByObject(Integer universityFiscalYear, String chartOfAccountsCode, String accountNumber, String subAccountNumber, String financialObjectLevelCode, String financialReportingSortCode, boolean isCostShareExcluded, boolean isConsolidated, int pendingEntryCode);
/**
* Save an account balance
*
* @param ab account balance record to save
*/
public void save(AccountBalance ab);
/**
* Purge an entire fiscal year for a single chart.
*
* @param chartOfAccountsCode the chart of accounts to purge account balance records from
* @param year the fiscal year to purge account balance records of
*/
public void purgeYearByChart(String chartOfAccountsCode, int year);
}