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

An IStep implementation that delegates to an IFlow. Useful for logical grouping of steps, and especially for partitioning with multiple steps per execution. If the flow has steps then when the FlowStep executes, all steps including the parent FlowStep will have executions in the Summer.Batch.Core.Repository.IJobRepository (one for the parent and one each for the flow steps). More...

Inheritance diagram for Summer.Batch.Core.Job.Flow.FlowStep:
Summer.Batch.Core.Step.AbstractStep Summer.Batch.Core.IStep Summer.Batch.Common.Factory.IInitializationPostOperations

Public Member Functions

 FlowStep ()
 Default constructor convenient for configuration purposes. More...
 
 FlowStep (IFlow flow)
 Constructor for a FlowStep that sets the flow and of the step explicitly. More...
 
 FlowStep (string name)
 Custom constructor with a name. More...
 
override void AfterPropertiesSet ()
 Post-init. checks. More...
 
- Public Member Functions inherited from Summer.Batch.Core.Step.AbstractStep
void Execute (StepExecution stepExecution)
 Template method for step execution logic - calls abstract methods for resource initialization ( Open), execution Logic (DoExecute) and resource closing (Close). More...
 
void RegisterStepExecutionListener (IStepExecutionListener listener)
 Registers step execution listener. More...
 
void SetStepExecutionListeners (IStepExecutionListener[] listeners)
 Registers an array of step execution listeners. More...
 
override string ToString ()
 ToString override. More...
 

Protected Member Functions

override void DoExecute (StepExecution stepExecution)
 Delegates to the flow provided for the execution of the step. More...
 
- Protected Member Functions inherited from Summer.Batch.Core.Step.AbstractStep
 AbstractStep (string name)
 Custom constructor with name. More...
 
 AbstractStep ()
 Default constructor. More...
 
virtual void Open (ExecutionContext ctx)
 Extension point for subclasses to provide callbacks to their collaborators at the beginning of a step, to open or acquire resources. Does nothing by default. More...
 
virtual void Close (ExecutionContext ctx)
 Extension point for subclasses to provide callbacks to their collaborators at the end of a step, to close or release resources. Does nothing by default. More...
 
void DoExecutionRelease ()
 Releases the most recent StepExecution More...
 
void DoExecutionRegistration (StepExecution stepExecution)
 Registers the StepExecution for property resolution via StepScope More...
 

Properties

IFlow Flow [set]
 Flow property. More...
 
- Properties inherited from Summer.Batch.Core.Step.AbstractStep
string Name [get, set]
 Name property. More...
 
bool AllowStartIfComplete [get, set]
 Allow start if complete flag property. More...
 
int StartLimit [get, set]
 Start limit for this step. More...
 
IJobRepository JobRepository [get, set]
 Job repository property. More...
 
- Properties inherited from Summer.Batch.Core.IStep
string Name [get]
 Name. More...
 
bool AllowStartIfComplete [get, set]
 Allow start if complete flag. More...
 
int StartLimit [get, set]
 Start limit. More...
 

Detailed Description

An IStep implementation that delegates to an IFlow. Useful for logical grouping of steps, and especially for partitioning with multiple steps per execution. If the flow has steps then when the FlowStep executes, all steps including the parent FlowStep will have executions in the Summer.Batch.Core.Repository.IJobRepository (one for the parent and one each for the flow steps).

Constructor & Destructor Documentation

Summer.Batch.Core.Job.Flow.FlowStep.FlowStep ( )

Default constructor convenient for configuration purposes.

Summer.Batch.Core.Job.Flow.FlowStep.FlowStep ( IFlow  flow)

Constructor for a FlowStep that sets the flow and of the step explicitly.

Parameters
flow
Summer.Batch.Core.Job.Flow.FlowStep.FlowStep ( string  name)

Custom constructor with a name.

Parameters
name

Member Function Documentation

override void Summer.Batch.Core.Job.Flow.FlowStep.AfterPropertiesSet ( )
virtual

Post-init. checks.

See also
IInitializationPostOperations::AfterPropertiesSet.

Reimplemented from Summer.Batch.Core.Step.AbstractStep.

override void Summer.Batch.Core.Job.Flow.FlowStep.DoExecute ( StepExecution  stepExecution)
protectedvirtual

Delegates to the flow provided for the execution of the step.

Parameters
stepExecution
Exceptions
System.Exception

Implements Summer.Batch.Core.Step.AbstractStep.

Property Documentation

IFlow Summer.Batch.Core.Job.Flow.FlowStep.Flow
set

Flow property.


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