Summer.Batch.Core.Job.Flow.FlowJob Class Reference

Implementation of the IJob interface that allows for complex flows of steps, rather than requiring sequential execution. In general, this job implementation was designed to be used behind a parser, allowing for a namespace to abstract away details. More...

Inheritance diagram for Summer.Batch.Core.Job.Flow.FlowJob:
Summer.Batch.Core.Job.AbstractJob Summer.Batch.Core.IJob Summer.Batch.Core.Step.IStepLocator Summer.Batch.Common.Factory.IInitializationPostOperations

Public Member Functions

 FlowJob (string name)
 Custom constructor with name. More...
 
override ICollection< string > GetStepNames ()
 
override IStep GetStep (string stepName)
 
- Public Member Functions inherited from Summer.Batch.Core.Job.AbstractJob
void Execute (JobExecution execution)
 Executes job. More...
 
override string ToString ()
 ToString override. More...
 
void AfterPropertiesSet ()
 Post-init. checks. More...
 
void SetJobExecutionListeners (IJobExecutionListener[] listeners)
 Public setter for injecting IJobExecutionListeners. They will all be given the listener callbacks at the appropriate point in the job. More...
 
void RegisterJobExecutionListener (IJobExecutionListener listener)
 Register a single listener for the IJobExecutionListener callbacks. More...
 

Protected Member Functions

override void DoExecute (JobExecution execution)
 
- Protected Member Functions inherited from Summer.Batch.Core.Job.AbstractJob
 AbstractJob ()
 Default constructor. More...
 
 AbstractJob (string name)
 Custom constructor with a name. More...
 
StepExecution HandleStep (IStep step, JobExecution execution)
 Convenience method for subclasses to delegate the handling of a specific step in the context of the current JobExecution . Clients of this method do not need access to the JobRepository, nor do they need to worry about populating the execution context on a restart, nor detecting the interrupted state (in job or step execution). More...
 
ExitStatus GetDefaultExitStatusForFailure (Exception ex, JobExecution execution)
 Computes exit status depending on exception. More...
 

Properties

IFlow Flow [protected get, set]
 Flow property. More...
 
- Properties inherited from Summer.Batch.Core.Job.AbstractJob
string Name [get, set]
 Name property. More...
 
bool Restartable [get, set]
 Restartable flag property. More...
 
IJobParametersIncrementer JobParametersIncrementer [get, set]
 job parameters incrementer property. More...
 
IJobParametersValidator JobParametersValidator [get, set]
 Job parameters validator property. More...
 
IJobRepository JobRepository [get, set]
 Job repository property. More...
 
- Properties inherited from Summer.Batch.Core.IJob
string Name [get, set]
 Name. More...
 
bool Restartable [get, set]
 Flag to indicate if this job can be restarted, at least in principle (Actual restartability is bound to the use of a persisted job repository). More...
 
IJobParametersIncrementer JobParametersIncrementer [get, set]
 If clients need to generate new parameters for the next execution in a sequence they can use this incrementer. The return value may be null, in the case that this job does not have a natural sequence. More...
 
IJobParametersValidator JobParametersValidator [get, set]
 A validator for the job parameters of a JobExecution. Clients of a Job may need to validate the parameters for a launch, before or during the execution. More...
 

Additional Inherited Members

- Static Protected Attributes inherited from Summer.Batch.Core.Job.AbstractJob
static readonly Logger Logger = LogManager.GetCurrentClassLogger()
 Logger. More...
 

Detailed Description

Implementation of the IJob interface that allows for complex flows of steps, rather than requiring sequential execution. In general, this job implementation was designed to be used behind a parser, allowing for a namespace to abstract away details.

Constructor & Destructor Documentation

Summer.Batch.Core.Job.Flow.FlowJob.FlowJob ( string  name)

Custom constructor with name.

Parameters
name

Member Function Documentation

override void Summer.Batch.Core.Job.Flow.FlowJob.DoExecute ( JobExecution  execution)
protectedvirtual

See also
AbstractJob::DoExecute .
Parameters
execution
Exceptions
JobExecutionException 

Implements Summer.Batch.Core.Job.AbstractJob.

override IStep Summer.Batch.Core.Job.Flow.FlowJob.GetStep ( string  stepName)
virtual

See also
AbstractJob::GetStep .
Parameters
stepName
Returns

Implements Summer.Batch.Core.Job.AbstractJob.

override ICollection<string> Summer.Batch.Core.Job.Flow.FlowJob.GetStepNames ( )
virtual

Property Documentation

IFlow Summer.Batch.Core.Job.Flow.FlowJob.Flow
protected getset

Flow property.


The documentation for this class was generated from the following file:
  • Summer.Batch.Core/Core/Job/Flow/FlowJob.cs