Summer.Batch.Core.IJob Interface Reference

A Job's contract. More...

Inheritance diagram for Summer.Batch.Core.IJob:
Summer.Batch.Core.Job.AbstractJob Summer.Batch.Core.Job.Flow.FlowJob Summer.Batch.Core.Job.SimpleJob

Public Member Functions

void Execute (JobExecution execution)
 Runs the JobExecutionand update the meta information like status and statistics as necessary. This method should not throw any exceptions for failed execution. Clients should be careful to inspect the JobExecution status to determine success or failure. More...
 

Properties

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

Detailed Description

A Job's contract.

Member Function Documentation

void Summer.Batch.Core.IJob.Execute ( JobExecution  execution)

Runs the JobExecutionand update the meta information like status and statistics as necessary. This method should not throw any exceptions for failed execution. Clients should be careful to inspect the JobExecution status to determine success or failure.

Parameters
execution

Implemented in Summer.Batch.Core.Job.AbstractJob.

Property Documentation

IJobParametersIncrementer Summer.Batch.Core.IJob.JobParametersIncrementer
getset

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.

Returns
an incrementer to be used for creating new parameters
IJobParametersValidator Summer.Batch.Core.IJob.JobParametersValidator
getset

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.

Returns
a validator that can be used to check parameter values (never null)
string Summer.Batch.Core.IJob.Name
getset

Name.

Returns
bool Summer.Batch.Core.IJob.Restartable
getset

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

Returns

The documentation for this interface was generated from the following file:
  • Summer.Batch.Core/Core/IJob.cs