org.kuali.ole.sys.batch

Class AbstractStep

java.lang.Object

org.kuali.ole.sys.batch.InitiateDirectoryBase

org.kuali.ole.sys.batch.AbstractStep

All Implemented Interfaces:

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

Direct Known Subclasses:

AbstractWrappedBatchStep, ApproveLineItemReceivingStep, AutoApprovePaymentRequestsStep, AutoClosePurchaseOrdersStep, AutoCloseRecurringOrdersStep, BatchContainerStep, CfdaBatchStep, ClearCacheStep, ClearPendingStep, ClearPendingTransactionsStep, CloseBatchStep, CreateBackupGroupStep, DailyEmailStep, DailyReportStep, DeleteAllExpenditureTransactionsStep, DownLoadFileViaHttpsStep, DvToPdpExtractStep, ElectronicInvoiceStep, ExtractAchPaymentsStep, ExtractCanceledChecksStep, ExtractChecksStep, ExtractPdpImmediatesStep, ExtractPdpStep, FaxPendingDocumentStep, FilePurgeStep, FileRenameStep, FiscalYearMakerStep, FlatFileSortStep, IcrSortStep, LoadEplsFileStep, LoadFederalReserveBankDataStep, LoadPaymentsStep, LockModuleStep, MarkPostableIcrGroupsAsUnpostableStep, MarkPostableScrubberValidGroupsAsUnpostableStep, MarkScrubbableBackupGroupsAsUnscrubbableStep, OleAccountTemporaryRestrictedStep, OLEBatchProcessAdhocStep, OLEBatchProcessEmailStep, OLEBatchProcessStep, ProcessPdPCancelsAndPaidStep, ProcurementCardAutoApproveDocumentsStep, ProcurementCardCreateDocumentsStep, ProcurementCardLoadStep, ProcurementCardRouteDocumentsStep, PurapMassRequisitionStep, PurgeAccountBalancesStep, PurgeBalanceStep, PurgeCollectorDetailStep, PurgeEncumbranceStep, PurgeEntryStep, PurgeOldLookupResultsStep, PurgePendingAttachmentsStep, PurgeSessionDocumentsStep, PurgeSufficientFundBalancesStep, PurgeTempFilesStep, ReceivingPaymentRequestStep, ReportAggregationStep, RequisitionLoadStep, ScheduleStep, SendAchAdviceNotificationsStep, StopBatchContainerStep, SufficientFundsFullRebuildStep, UpdatePriorYearDataStep, VendorMatchStep, VendorToOleExtractStep, WeeklyEmailStep

public abstract class AbstractStep
extends InitiateDirectoryBase
implements Step, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean, InitiateDirectory

Field Summary

Fields

Modifier and Type	Field and Description
protected BatchInputFileType	batchInputFileType
protected org.kuali.rice.core.api.datetime.DateTimeService	dateTimeService
protected boolean	interrupted
protected String	name
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	parameterService

Constructor Summary

Constructors

Constructor and Description
AbstractStep()

Method Summary

Methods

Modifier and Type	Method and Description
void	afterPropertiesSet() Initialization after bean properties are instantiate,
BatchInputFileType	getBatchInputFileType()
protected org.kuali.rice.core.api.datetime.DateTimeService	getDateTimeService() Gets the dateTimeService attribute.
String	getName() Gets the name attribute.
protected org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
List<String>	getRequiredDirectoryNames() By default it should use batchInpeutFile (single file) directory path as the required directory name.
void	interrupt() Initializes the interrupted flag
boolean	isInterrupted() Returns the boolean value of the interrupted flag
void	setBatchInputFileType(BatchInputFileType batchInputFileType)
void	setBeanName(String name) Sets the bean name
void	setDateTimeService(org.kuali.rice.core.api.datetime.DateTimeService dateTimeService) Sets the dateTimeService attribute value.
void	setInterrupted(boolean interrupted) Sets the interruped flag
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService)

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.Step

execute

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

prepareDirectories

Field Detail

name

protected String name

parameterService

protected org.kuali.rice.coreservice.framework.parameter.ParameterService parameterService

dateTimeService

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

batchInputFileType

protected BatchInputFileType batchInputFileType

interrupted

protected boolean interrupted

Constructor Detail

AbstractStep

public AbstractStep()

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

Initialization after bean properties are instantiate,

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception

See Also:

InitializingBean.afterPropertiesSet()

getRequiredDirectoryNames

public List<String> getRequiredDirectoryNames()

By default it should use batchInpeutFile (single file) directory path as the required directory name. Subclasses should override this function to provide any custom required directory list.

Specified by:

getRequiredDirectoryNames in interface InitiateDirectory

Specified by:

getRequiredDirectoryNames in class InitiateDirectoryBase

Returns:

See Also:

org.kuali.ole.sys.batch.service.InitiateDirectoryInterface#getRequiredDirectoryNames()

setBeanName

public void setBeanName(String name)

Sets the bean name

Specified by:

setBeanName in interface org.springframework.beans.factory.BeanNameAware

Parameters:

name - String that contains the bean name

See Also:

BeanNameAware.setBeanName(java.lang.String)

getName

public String getName()

Gets the name attribute.

Specified by:

getName in interface Step

Returns:

Returns the name.

getParameterService

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

setParameterService

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

getDateTimeService

protected org.kuali.rice.core.api.datetime.DateTimeService getDateTimeService()

Gets the dateTimeService attribute.

Returns:

Returns the dateTimeService.

setDateTimeService

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

Sets the dateTimeService attribute value.

Parameters:

dateTimeService - The dateTimeService to set.

isInterrupted

public boolean isInterrupted()

Returns the boolean value of the interrupted flag

Specified by:

isInterrupted in interface Step

Returns:

boolean

See Also:

Step.isInterrupted()

getBatchInputFileType

public BatchInputFileType getBatchInputFileType()

setBatchInputFileType

public void setBatchInputFileType(BatchInputFileType batchInputFileType)

setInterrupted

public void setInterrupted(boolean interrupted)

Sets the interruped flag

Specified by:

setInterrupted in interface Step

Parameters:

interrupted -

See Also:

Step.setInterrupted(boolean)

interrupt

public void interrupt()

Initializes the interrupted flag

Specified by:

interrupt in interface Step

See Also:

Step.interrupt()