org.kuali.kfs.gl.batch
Class PurgeEncumbranceStep

java.lang.Object
  org.kuali.kfs.sys.batch.AbstractStep
      org.kuali.kfs.gl.batch.PurgeEncumbranceStep

All Implemented Interfaces:

Step, org.springframework.beans.factory.BeanNameAware

public class PurgeEncumbranceStep
extends AbstractStep

A step to remove old encumbrances from the database.

Constructor Summary

PurgeEncumbranceStep()

Method Summary

boolean	execute(String jobName, Date jobRunDate) This step will purge data from the gl_encumbrance_t table older than a specified year.
void	setChartService(ChartService chartService) Sets the chartService attribute, allowing the injection of an implementation of the service.
void	setEncumbranceService(EncumbranceService encumbranceService) Sets the encumbranceService attribute, allowing the injection of an implementation of the service.

Methods inherited from class org.kuali.kfs.sys.batch.AbstractStep

getDateTimeService, getName, getParameterService, interrupt, isInterrupted, setBeanName, setDateTimeService, setInterrupted, setParameterService

Methods inherited from class java.lang.Object

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

Constructor Detail

PurgeEncumbranceStep

public PurgeEncumbranceStep()

Method Detail

execute

public boolean execute(String jobName,
                       Date jobRunDate)

This step will purge data from the gl_encumbrance_t table older than a specified year. It purges the data one chart at a time each within their own transaction so database transaction logs don't get completely filled up when doing this. This step class should NOT be transactional.

Parameters:

jobName - the name of the job this step is being run as part of

jobRunDate - the time/date the job was started

Returns:

true if the step completed successfully, false if otherwise

See Also:

Step.execute(String, java.util.Date)

setEncumbranceService

public void setEncumbranceService(EncumbranceService encumbranceService)

Sets the encumbranceService attribute, allowing the injection of an implementation of the service.

Parameters:

encumbranceService - the encumbranceService implementation to set

See Also:

EncumbranceService

setChartService

public void setChartService(ChartService chartService)

Sets the chartService attribute, allowing the injection of an implementation of the service.

Parameters:

chartService - the chartService implementation to set

See Also:

ChartService