org.kuali.kra.service.impl

Class AwardScheduleGenerationServiceImpl

java.lang.Object

org.kuali.kra.service.impl.AwardScheduleGenerationServiceImpl

All Implemented Interfaces:

AwardScheduleGenerationService

@Transactional
public class AwardScheduleGenerationServiceImpl
extends Object
implements AwardScheduleGenerationService

This is the AwardScheduleGenerationService class.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FREQUENCY_OBJECT_STRING
static String	ZERO_HOURS

Constructor Summary

Constructors

Constructor and Description
AwardScheduleGenerationServiceImpl() Constructs a AwardScheduleGenerationServiceImpl.java.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	addNumberOfMonthsToStartDate(Frequency frequency, Calendar calendar) If the frequency is x monthly, numberOfMonths field in Frequency BO specifies the same.
protected void	addOffSetPeriodToStartDate(Frequency frequency, Calendar calendar) numberOfDays,AdvanceNumberOfDays and AdvanceNumberOfMonths fields of Frequency BO represent any offset from the base date, if present.
protected boolean	canGenerateSchedules(AwardReportTerm awardReportTerm, boolean isThisNotPaymentPanel) This method determines if the schedules should be generated for the particular AwardReportTerm object.
List<Date>	generateSchedules(Award award, List<AwardReportTerm> awardReportTerms, boolean isThisNotPaymentPanel) This method generates a schedule of dates.
AwardAmountInfoService	getAwardAmountInfoService() Gets the awardAmountInfoService attribute.
protected List<Date>	getDates(AwardReportTerm awardReportTerm, Map<String,Date> mapOfDates, int index) This is a helper method.
protected Date	getEndDate(String frequencyBaseCode, Date startDate, Map<String,Date> mapOfDates) This method returns the end date based on start date and frequency base code.
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService() Gets the ParameterService attribute.
org.kuali.rice.krad.service.PersistenceService	getPersistenceService() Gets the persistenceService attribute.
ScheduleService	getScheduleService() Gets the scheduleService attribute.
protected Date	getStartDate(AwardReportTerm awardReportTerm, Map<String,Date> mapOfDates) This method determines and returns the start date based on the frequency base code.
protected Date	getStartDateFromTheBaseDate(Calendar calendar, Frequency frequency) This is a helper method that updates the base date based on frequency if required to get the start date.
protected void	initializeDatesForThisAward(Award award, Map<String,Date> mapOfDates) This method gathers all the relevant dates from Award and child objects and puts them in a map.
void	setAwardAmountInfoService(AwardAmountInfoService awardAmountInfoService) Sets the awardAmountInfoService attribute value.
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService) Sets the ParameterService attribute value.
void	setPersistenceService(org.kuali.rice.krad.service.PersistenceService persistenceService) Sets the persistenceService attribute value.
void	setScheduleService(ScheduleService scheduleService) Sets the scheduleService attribute value.

Methods inherited from class java.lang.Object

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

Field Detail

ZERO_HOURS

public static final String ZERO_HOURS

See Also:

Constant Field Values

FREQUENCY_OBJECT_STRING

public static final String FREQUENCY_OBJECT_STRING

See Also:

Constant Field Values

Constructor Detail

AwardScheduleGenerationServiceImpl

public AwardScheduleGenerationServiceImpl()

Constructs a AwardScheduleGenerationServiceImpl.java.

Method Detail

initializeDatesForThisAward

protected void initializeDatesForThisAward(Award award,
                               Map<String,Date> mapOfDates)

This method gathers all the relevant dates from Award and child objects and puts them in a map.

Parameters:

award -

generateSchedules

public List<Date> generateSchedules(Award award,
                           List<AwardReportTerm> awardReportTerms,
                           boolean isThisNotPaymentPanel)
                             throws ParseException

Description copied from interface: AwardScheduleGenerationService

This method generates a schedule of dates.

Specified by:

generateSchedules in interface AwardScheduleGenerationService

Returns:

Throws:

ParseException

See Also:

org.kuali.kra.service.AwardScheduleGenerationService#generateSchedules(org.kuali.kra.award.home.Award, java.util.List)

getDates

protected List<Date> getDates(AwardReportTerm awardReportTerm,
                  Map<String,Date> mapOfDates,
                  int index)
                       throws ParseException

This is a helper method. This method calls evaluates the frequency and frequency base and generates dates either by calling the scheduling service or without that.

Parameters:

awardReportTerm -

index - TODO

Returns:

Throws:

ParseException

canGenerateSchedules

protected boolean canGenerateSchedules(AwardReportTerm awardReportTerm,
                           boolean isThisNotPaymentPanel)

This method determines if the schedules should be generated for the particular AwardReportTerm object.

Parameters:

awardReportTerm -

isThisNotPaymentPanel - - if the method is being called for generating schedules on report panel, the value passed will be false; if the method is being called from payment panel, the value passed will be true. This is to filter the special report class for payment panel.

Returns:

getStartDate

protected Date getStartDate(AwardReportTerm awardReportTerm,
                Map<String,Date> mapOfDates)

This method determines and returns the start date based on the frequency base code.

Parameters:

awardReportTerm -

Returns:

getStartDateFromTheBaseDate

protected Date getStartDateFromTheBaseDate(Calendar calendar,
                               Frequency frequency)

This is a helper method that updates the base date based on frequency if required to get the start date.

Parameters:

startDate -

frequency -

Returns:

addOffSetPeriodToStartDate

protected void addOffSetPeriodToStartDate(Frequency frequency,
                              Calendar calendar)

numberOfDays,AdvanceNumberOfDays and AdvanceNumberOfMonths fields of Frequency BO represent any offset from the base date, if present. Only 1 out of the three can be not null for any frequency. This method determines it and adds the required offset to the base date.

Parameters:

frequency -

calendar -

addNumberOfMonthsToStartDate

protected void addNumberOfMonthsToStartDate(Frequency frequency,
                                Calendar calendar)

If the frequency is x monthly, numberOfMonths field in Frequency BO specifies the same. This method adds the number of months from Frequency BO to base date to get the first date.

Parameters:

frequency -

calendar -

getEndDate

protected Date getEndDate(String frequencyBaseCode,
              Date startDate,
              Map<String,Date> mapOfDates)

This method returns the end date based on start date and frequency base code. If frequency base code is 4(Final Expiration Date), it adds 1 year to the start date and returns it. otherwise it returns the final expiration date itself.

Parameters:

frequencyBaseCode -

startDate -

Returns:

getScheduleService

public ScheduleService getScheduleService()

Gets the scheduleService attribute.

Returns:

Returns the scheduleService.

setScheduleService

public void setScheduleService(ScheduleService scheduleService)

Sets the scheduleService attribute value.

Parameters:

scheduleService - The scheduleService to set.

getPersistenceService

public org.kuali.rice.krad.service.PersistenceService getPersistenceService()

Gets the persistenceService attribute.

Returns:

Returns the persistenceService.

setPersistenceService

public void setPersistenceService(org.kuali.rice.krad.service.PersistenceService persistenceService)

Sets the persistenceService attribute value.

Parameters:

persistenceService - The persistenceService to set.

getParameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

Gets the ParameterService attribute.

Returns:

Returns the ParameterService.

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

Sets the ParameterService attribute value.

Parameters:

parameterService - The ParameterService to set.

getAwardAmountInfoService

public AwardAmountInfoService getAwardAmountInfoService()

Gets the awardAmountInfoService attribute.

Returns:

Returns the awardAmountInfoService.

setAwardAmountInfoService

public void setAwardAmountInfoService(AwardAmountInfoService awardAmountInfoService)

Sets the awardAmountInfoService attribute value.

Parameters:

awardAmountInfoService - The awardAmountInfoService to set.