org.kuali.kfs.sys.batch
Interface Step

All Known Implementing Classes:

AbstractStep, AbstractWrappedBatchStep, AccrualProcessingStep, ApproveLineItemReceivingStep, AssetDepreciationStep, AutoApprovePaymentRequestsStep, AutoClosePurchaseOrdersStep, AutoCloseRecurringOrdersStep, AutoDisapproveDocumentsStep, AvailableCashUpdateStep, BalanceForwardStep, BudgetConstructionGeneralLedgerLoadBatchStep, BudgetConstructionUpdateBatchStep, CfdaBatchStep, ClearCacheStep, ClearLaborGLEntryStep, ClearLaborPendingStep, ClearPendingStep, ClearPendingTransactionsStep, CloseBatchStep, CollectorScrubberStep, CollectorStep, CorrectionProcessScrubberStep, CreateAccrualTransactionsStep, CreateAutomatedCashInvestmentTransactionsStep, CreateBackupGroupStep, CreateCashSweepTransactionsStep, CreateGainLossDistributionTransactionsStep, CreateLaborBackupGroupStep, CreateRecurringCashTransferTransactionsStep, CurrentTaxLotBalanceUpdateStep, CustomerInvoiceDocumentBatchStep, CustomerInvoiceWriteoffBatchStep, CustomerLoadStep, DailyEmailStep, DailyReportStep, DeleteAllExpenditureTransactionsStep, DemergerSortStep, DemergerStep, DvToPdpExtractStep, EffortCertificationCreateStep, EffortCertificationExtractStep, ElectronicInvoiceStep, EncumbranceForwardStep, EndowmenteDocPostingStep, EnterpriseFeedStep, ExtractAchPaymentsStep, ExtractCanceledChecksStep, ExtractChecksStep, ExtractGlTransactionsStep, ExtractPdpImmediatesStep, ExtractPdpStep, ExtractStep, FaxPendingDocumentStep, FilePurgeStep, FileRenameStep, FiscalYearMakerStep, GeneralLedgerInterfaceBatchProcessStep, GenesisBatchStep, HoldingHistoryMarketValuesStep, IcrSortStep, IncomeDistributionForPooledFundStep, InvoiceRecurrenceStep, LaborBalanceSummaryStep, LaborBalancingHistorySyncStep, LaborBalancingStep, LaborCorrectionProcessScrubberStep, LaborDemergerSortStep, LaborDemergerStep, LaborEnterpriseFeedStep, LaborFeedStep, LaborFileRenameStep, LaborNightlyOutStep, LaborPosterSortStep, LaborPosterStep, LaborPreScrubberStep, LaborPurgeBalanceStep, LaborPurgeEntryStep, LaborScrubberSortStep, LaborScrubberStep, LaborYearEndBalanceForwardStep, LoadFederalReserveBankDataStep, LoadPaymentsStep, LockboxStep, MarkPostableIcrGroupsAsUnpostableStep, MarkPostableScrubberValidGroupsAsUnpostableStep, MarkScrubbableBackupGroupsAsUnscrubbableStep, NightlyOutStep, NominalActivityClosingStep, OrganizationReversionCurrentYearAccountStep, OrganizationReversionPriorYearAccountStep, PooledFundControlTransactionsStep, PostDataLoadEncryptionStep, PosterBalancingHistorySyncStep, PosterBalancingStep, PosterEntriesStep, PosterIcrGenerationStep, PosterIndirectCostRecoveryEntriesStep, PosterReversalStep, PosterSortStep, PosterSummaryReportStep, PreAssetTaggingStep, PreScrubberStep, ProcessFeeTransactionsStep, ProcessPdPCancelsAndPaidStep, ProcurementCardAutoApproveDocumentsStep, ProcurementCardCreateDocumentsStep, ProcurementCardLoadStep, ProcurementCardRouteDocumentsStep, PurapMassRequisitionStep, PurgeAccountBalancesStep, PurgeBalanceStep, PurgeCollectorDetailStep, PurgeEncumbranceStep, PurgeEntryStep, PurgeOldLookupResultsStep, PurgePendingAttachmentsStep, PurgeSessionDocumentsStep, PurgeSufficientFundBalancesStep, PurgeTempFilesStep, ReceivingPaymentRequestStep, ReportAggregationStep, RollFrequencyDatesStep, RollProcessDateStep, ScheduleStep, ScrubberSortStep, ScrubberStep, SendAchAdviceNotificationsStep, SufficientFundsAccountUpdateStep, SufficientFundsFullRebuildStep, TicklerDeliveryStep, UpdateCorpusStep, UpdateHistoryCashStep, UpdateHoldingHistoryStep, UpdatePriorYearDataStep, WeeklyEmailStep

public interface Step

Method Summary

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)