org.kuali.kfs.coa.service
Interface ObjectCodeService

All Known Implementing Classes:

ObjectCodeServiceImpl

public interface ObjectCodeService

This interface defines methods that an ObjectCode Service must provide.

Method Summary

ObjectCode	getByPrimaryId(Integer universityFiscalYear, String chartOfAccountsCode, String financialObjectCode)
ObjectCode	getByPrimaryIdForCurrentYear(String chartOfAccountsCode, String financialObjectCode) This method returns an financial object code for the current fiscal year.
ObjectCode	getByPrimaryIdWithCaching(Integer universityFiscalYear, String chartOfAccountsCode, String financialObjectCode)
String	getObjectCodeNamesByCharts(Integer universityFiscalYear, String[] chartOfAccountCodes, String financialObjectCode) This method, written for use with DWR, returns a joined string representation of all of the names of the distinct object codes associated with each of the chart codes given.
List	getYearList(String chartOfAccountsCode, String financialObjectCode)

Method Detail

getByPrimaryId

ObjectCode getByPrimaryId(Integer universityFiscalYear,
                          String chartOfAccountsCode,
                          String financialObjectCode)

Parameters:

universityFiscalYear - - University Fiscal Year

chartOfAccountsCode - - Chart of Accounts Code

financialObjectCode - - Financial Object Code

Returns:

ObjectCode Retrieves an ObjectCode object based on primary key.

getByPrimaryIdWithCaching

ObjectCode getByPrimaryIdWithCaching(Integer universityFiscalYear,
                                     String chartOfAccountsCode,
                                     String financialObjectCode)

Parameters:

universityFiscalYear - - University Fiscal Year

chartOfAccountsCode - - Chart of Accounts Code

financialObjectCode - - Financial Object Code

Returns:

ObjectCode Retrieves an ObjectCode object based on primary key.

getByPrimaryIdForCurrentYear

ObjectCode getByPrimaryIdForCurrentYear(String chartOfAccountsCode,
                                        String financialObjectCode)

This method returns an financial object code for the current fiscal year.

Parameters:

chartOfAccountsCode - chart of accounts code for object code

financialObjectCode - financial object code

Returns:

the object code specified

getYearList

List getYearList(String chartOfAccountsCode,
                 String financialObjectCode)

Parameters:

chartOfAccountsCode - - Chart of Accounts Code

financialObjectCode - - Financial Object Code

Returns:

a list containing integer years, given object code. The list may be empty, but will not be null.

getObjectCodeNamesByCharts

String getObjectCodeNamesByCharts(Integer universityFiscalYear,
                                  String[] chartOfAccountCodes,
                                  String financialObjectCode)

This method, written for use with DWR, returns a joined string representation of all of the names of the distinct object codes associated with each of the chart codes given. In the best of all possible worlds, this will only ever return *one* object code name, as object codes will be shared across charts.

Parameters:

universityFiscalYear - the fiscal year of the financial object code to check.

chartOfAccountCodes - array of Chart of Accounts codes to

financialObjectCode - financial object code to look up

Returns:

a String representation of the distinct names of the object codes