org.kuali.ole.coa.service.impl

Class ObjectCodeServiceImpl

java.lang.Object

org.kuali.ole.coa.service.impl.ObjectCodeServiceImpl

All Implemented Interfaces:

ObjectCodeService

public class ObjectCodeServiceImpl
extends Object
implements ObjectCodeService

This class is the service implementation for the ObjectCode structure. This is the default implementation, that is delivered with Kuali.

Field Summary

Fields

Modifier and Type	Field and Description
protected ObjectCodeDao	objectCodeDao
protected UniversityDateService	universityDateService

Constructor Summary

Constructors

Constructor and Description
ObjectCodeServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
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)
void	setObjectCodeDao(ObjectCodeDao objectCodeDao)
void	setUniversityDateService(UniversityDateService universityDateService)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

objectCodeDao

protected ObjectCodeDao objectCodeDao

universityDateService

protected UniversityDateService universityDateService

Constructor Detail

ObjectCodeServiceImpl

public ObjectCodeServiceImpl()

Method Detail

getByPrimaryId

@Cacheable(value="OLE/ObjectCode",
           key="#p0+\'-\'+#p1+\'-\'+#p2")
public ObjectCode getByPrimaryId(Integer universityFiscalYear,
                                  String chartOfAccountsCode,
                                  String financialObjectCode)

Specified by:

getByPrimaryId in interface ObjectCodeService

Parameters:

universityFiscalYear - - University Fiscal Year

chartOfAccountsCode - - Chart of Accounts Code

financialObjectCode - - Financial Object Code

Returns:

ObjectCode Retrieves an ObjectCode object based on primary key.

See Also:

ObjectCodeService.getByPrimaryId(java.lang.Integer, java.lang.String, java.lang.String)

getByPrimaryIdWithCaching

@Cacheable(value="OLE/ObjectCode",
           key="#p0+\'-\'+#p1+\'-\'+#p2")
public ObjectCode getByPrimaryIdWithCaching(Integer universityFiscalYear,
                                             String chartOfAccountsCode,
                                             String financialObjectCode)

Specified by:

getByPrimaryIdWithCaching in interface ObjectCodeService

Parameters:

universityFiscalYear - - University Fiscal Year

chartOfAccountsCode - - Chart of Accounts Code

financialObjectCode - - Financial Object Code

Returns:

ObjectCode Retrieves an ObjectCode object based on primary key.

See Also:

ObjectCodeService.getByPrimaryIdWithCaching(java.lang.Integer, java.lang.String, java.lang.String)

setObjectCodeDao

public void setObjectCodeDao(ObjectCodeDao objectCodeDao)

setUniversityDateService

public void setUniversityDateService(UniversityDateService universityDateService)

getYearList

public List getYearList(String chartOfAccountsCode,
               String financialObjectCode)

Specified by:

getYearList in interface ObjectCodeService

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.

See Also:

ObjectCodeService.getYearList(java.lang.String, java.lang.String)

getObjectCodeNamesByCharts

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

Description copied from interface: ObjectCodeService

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.

Specified by:

getObjectCodeNamesByCharts in interface ObjectCodeService

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

See Also:

ObjectCodeService.getObjectCodeNamesByCharts(java.lang.Integer, java.lang.String[], java.lang.String)

getByPrimaryIdForCurrentYear

@Cacheable(value="OLE/ObjectCode",
           key="\'CurrentFY\'+\'-\'+#p0+\'-\'+#p1")
public ObjectCode getByPrimaryIdForCurrentYear(String chartOfAccountsCode,
                                                String financialObjectCode)

Description copied from interface: ObjectCodeService

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

Specified by:

getByPrimaryIdForCurrentYear in interface ObjectCodeService

Parameters:

chartOfAccountsCode - chart of accounts code for object code

financialObjectCode - financial object code

Returns:

the object code specified

See Also:

ObjectCodeService.getByPrimaryIdForCurrentYear(java.lang.String, java.lang.String)