org.kuali.ole.sys.batch

Interface Step

All Known Implementing Classes:

AbstractStep, AbstractWrappedBatchStep, AddPriorYearAccountsStep, ApproveLineItemReceivingStep, AutoApprovePaymentRequestsStep, AutoClosePurchaseOrdersStep, AutoCloseRecurringOrdersStep, AutoDisapproveDocumentsStep, BalanceForwardStep, BatchContainerStep, CfdaBatchStep, ClearCacheStep, ClearPendingStep, ClearPendingTransactionsStep, CloseBatchStep, CollectorScrubberStep, CollectorStep, CorrectionProcessScrubberStep, CreateBackupGroupStep, DailyEmailStep, DailyReportStep, DeleteAllExpenditureTransactionsStep, DemergerStep, DownLoadFileViaHttpsStep, DvToPdpExtractStep, ElectronicInvoiceStep, EncumbranceForwardStep, EnterpriseFeedStep, ExtractAchPaymentsStep, ExtractCanceledChecksStep, ExtractChecksStep, ExtractGlTransactionsStep, ExtractPdpImmediatesStep, ExtractPdpStep, FaxPendingDocumentStep, FilePurgeStep, FileRenameStep, FiscalYearMakerStep, FlatFileSortStep, IcrSortStep, InactivatePayeeAchAccountsStep, LoadEplsFileStep, LoadFederalReserveBankDataStep, LoadPaymentsStep, LockModuleStep, MarkPostableIcrGroupsAsUnpostableStep, MarkPostableScrubberValidGroupsAsUnpostableStep, MarkScrubbableBackupGroupsAsUnscrubbableStep, MigratePurapStatCodeToWorkflowDocumentStep, NightlyOutStep, NominalActivityClosingStep, OleAccountTemporaryRestrictedStep, OLEBatchProcessAdhocStep, OLEBatchProcessEmailStep, OLEBatchProcessStep, OrganizationReversionCurrentYearAccountStep, OrganizationReversionPriorYearAccountStep, PosterBalancingHistorySyncStep, PosterBalancingStep, PosterEntriesStep, PosterIcrGenerationStep, PosterIndirectCostRecoveryEntriesStep, PosterReversalStep, PosterSummaryReportStep, PreScrubberStep, ProcessPdPCancelsAndPaidStep, ProcurementCardAutoApproveDocumentsStep, ProcurementCardCreateDocumentsStep, ProcurementCardLoadStep, ProcurementCardRouteDocumentsStep, PurapMassRequisitionStep, PurgeAccountBalancesStep, PurgeBalanceStep, PurgeCollectorDetailStep, PurgeEncumbranceStep, PurgeEntryStep, PurgeOldLookupResultsStep, PurgePendingAttachmentsStep, PurgeSessionDocumentsStep, PurgeSufficientFundBalancesStep, PurgeTempFilesStep, ReceivingPaymentRequestStep, ReportAggregationStep, RequisitionLoadStep, ScheduleStep, ScrubberStep, SendAchAdviceNotificationsStep, StopBatchContainerStep, SufficientFundsAccountUpdateStep, SufficientFundsFullRebuildStep, UpdatePriorYearDataStep, VendorMatchStep, VendorToOleExtractStep, WeeklyEmailStep

public interface Step

Method Summary

Methods

Modifier and Type	Method and Description
boolean	execute(String jobName, Date jobRunDate) Perform this step of a batch job.
String	getName() Return id of this step spring bean.
void	interrupt() Call to attempt to interrupt a step in the middle of processing.
boolean	isInterrupted()
void	setInterrupted(boolean interrupted)

Method Detail

execute

boolean execute(String jobName,
              Date jobRunDate)
                throws InterruptedException

Perform this step of a batch job.

Parameters:

jobName - the name of the job running the step

jobRunDate - the time/date the job is executed

Returns:

true if successful and continue the job, false if successful and stop the job

Throws:

Throwable - if unsuccessful

InterruptedException

getName

String getName()

Return id of this step spring bean.

Returns:

The name of this step.

interrupt

void interrupt()

Call to attempt to interrupt a step in the middle of processing. Note that this only has an effect if the step in question checks its interrupted status.

isInterrupted

boolean isInterrupted()

setInterrupted

void setInterrupted(boolean interrupted)