org.kuali.ole.coa.service.impl

Class AccountingPeriodServiceImpl

java.lang.Object

org.kuali.ole.coa.service.impl.AccountingPeriodServiceImpl

All Implemented Interfaces:

AccountingPeriodService

public class AccountingPeriodServiceImpl
extends Object
implements AccountingPeriodService

This service implementation is the default implementation of the AccountingPeriod service that is delivered with Kuali.

Field Summary

Fields

Modifier and Type	Field and Description
protected static Set<String>	_invalidPeriodCodes
protected org.kuali.rice.krad.service.BusinessObjectService	businessObjectService
protected org.kuali.rice.core.api.datetime.DateTimeService	dateTimeService

Constructor Summary

Constructors

Constructor and Description
AccountingPeriodServiceImpl()

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCache()
int	compareAccountingPeriodsByDate(AccountingPeriod tweedleDee, AccountingPeriod tweedleDum) This method compares two accounting periods, hopefully by comparing their closing dates.
Collection<AccountingPeriod>	getAllAccountingPeriods() The default implementation.
AccountingPeriod	getByDate(Date date) This method is a helper method to get the current period.
AccountingPeriod	getByPeriod(String periodCode, Integer fiscalYear) This method is a helper method to easily grab an accounting period by looking up it's period and fiscal year
AccountingPeriod	getByStringDate(String dateString) This method allows for AccountingPeriod retrieval via String date.
Collection<AccountingPeriod>	getOpenAccountingPeriods() Implements by choosing only accounting periods that are active.
protected boolean	isInvalidPeriodCode(AccountingPeriod period) This checks to see if the period code is empty or invalid ("13", "AB", "BB", "CB")
void	setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)
void	setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)

Methods inherited from class java.lang.Object

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

Field Detail

businessObjectService

protected org.kuali.rice.krad.service.BusinessObjectService businessObjectService

dateTimeService

protected org.kuali.rice.core.api.datetime.DateTimeService dateTimeService

_invalidPeriodCodes

protected static final Set<String> _invalidPeriodCodes

Constructor Detail

AccountingPeriodServiceImpl

public AccountingPeriodServiceImpl()

Method Detail

getAllAccountingPeriods

@Cacheable(value="OLE/AccountingPeriod",
           key="\'{getAllAccountingPeriods}\'")
public Collection<AccountingPeriod> getAllAccountingPeriods()

The default implementation.

Specified by:

getAllAccountingPeriods in interface AccountingPeriodService

Returns:

A list of accounting periods in Kuali.

See Also:

AccountingPeriodService.getAllAccountingPeriods()

getOpenAccountingPeriods

@Cacheable(value="OLE/AccountingPeriod",
           key="\'{getOpenAccountingPeriods}\'")
public Collection<AccountingPeriod> getOpenAccountingPeriods()

Implements by choosing only accounting periods that are active.

Specified by:

getOpenAccountingPeriods in interface AccountingPeriodService

Returns:

See Also:

AccountingPeriodService.getOpenAccountingPeriods()

getByPeriod

@Cacheable(value="OLE/AccountingPeriod",
           key="#p0+\'-\'+#p1")
public AccountingPeriod getByPeriod(String periodCode,
                                     Integer fiscalYear)

This method is a helper method to easily grab an accounting period by looking up it's period and fiscal year

Specified by:

getByPeriod in interface AccountingPeriodService

Parameters:

periodCode -

fiscalYear -

Returns:

an accounting period

getByStringDate

public AccountingPeriod getByStringDate(String dateString)

This method allows for AccountingPeriod retrieval via String date.

Specified by:

getByStringDate in interface AccountingPeriodService

Parameters:

String -

getByDate

@Cacheable(value="OLE/AccountingPeriod",
           key="\'date=\'+#p0")
public AccountingPeriod getByDate(Date date)

This method is a helper method to get the current period.

Specified by:

getByDate in interface AccountingPeriodService

Returns:

period that matches the date

See Also:

AccountingPeriodService.getByDate(java.sql.Date)

isInvalidPeriodCode

protected boolean isInvalidPeriodCode(AccountingPeriod period)

This checks to see if the period code is empty or invalid ("13", "AB", "BB", "CB")

Parameters:

period -

Returns:

compareAccountingPeriodsByDate

public int compareAccountingPeriodsByDate(AccountingPeriod tweedleDee,
                                 AccountingPeriod tweedleDum)

Description copied from interface: AccountingPeriodService

This method compares two accounting periods, hopefully by comparing their closing dates. If a is earlier than b, it should return a negative number; if a is later, it should return a positive number; and if the closing dates are equal, it should return a 0.

Specified by:

compareAccountingPeriodsByDate in interface AccountingPeriodService

Parameters:

tweedleDee - the first accounting period to compare

tweedleDum - the second accounting period to compare

Returns:

an integer representing which is earlier or later, or if they occur simultaneously

See Also:

AccountingPeriodService.compareAccountingPeriodsByDate(org.kuali.ole.coa.businessobject.AccountingPeriod, org.kuali.ole.coa.businessobject.AccountingPeriod)

clearCache

@CacheEvict(value="OLE/AccountingPeriod",
            allEntries=true)
public void clearCache()

Specified by:

clearCache in interface AccountingPeriodService

setBusinessObjectService

public void setBusinessObjectService(org.kuali.rice.krad.service.BusinessObjectService businessObjectService)

setDateTimeService

public void setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService)