org.kuali.ole.gl.batch

Class PurgeEntryStep

java.lang.Object

org.kuali.ole.sys.batch.InitiateDirectoryBase

org.kuali.ole.sys.batch.AbstractStep

org.kuali.ole.gl.batch.PurgeEntryStep

All Implemented Interfaces:

InitiateDirectory, Step, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

public class PurgeEntryStep
extends AbstractStep

A step to remove old general ledger entries from the database.

Field Summary

Fields inherited from class org.kuali.ole.sys.batch.AbstractStep

batchInputFileType, dateTimeService, interrupted, name, parameterService

Constructor Summary

Constructors

Constructor and Description
PurgeEntryStep()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute(String jobName, Date jobRunDate) This step will purge data from the gl_entry_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	setEntryService(EntryService entryService) Sets the entryService attribute, allowing the injection of an implementation of the service.

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

afterPropertiesSet, getBatchInputFileType, getDateTimeService, getName, getParameterService, getRequiredDirectoryNames, interrupt, isInterrupted, setBatchInputFileType, setBeanName, setDateTimeService, setInterrupted, setParameterService

Methods inherited from class org.kuali.ole.sys.batch.InitiateDirectoryBase

prepareDirectories

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kuali.ole.sys.batch.InitiateDirectory

prepareDirectories

Constructor Detail

PurgeEntryStep

public PurgeEntryStep()

Method Detail

execute

public boolean execute(String jobName,
              Date jobRunDate)

This step will purge data from the gl_entry_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 job completed successfully, false if otherwise

See Also:

Step.execute(String, Date)

setEntryService

public void setEntryService(EntryService entryService)

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

Parameters:

entryService - the entryService implementation to set

See Also:

EntryService

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