Summer.Batch.Core.Job.Builder.JobBuilderHelper Class Reference

A base class and utility for other job builders providing access to common properties like job repository. More...

Inheritance diagram for Summer.Batch.Core.Job.Builder.JobBuilderHelper:
Summer.Batch.Core.Job.Builder.FlowJobBuilder Summer.Batch.Core.Job.Builder.JobBuilder Summer.Batch.Core.Job.Builder.SimpleJobBuilder

Classes

class  CommonJobProperties
 common job properties. More...
 

Public Member Functions

JobBuilderHelper Repository (IJobRepository jobRepository)
 Sets the job repository for the job. More...
 
JobBuilderHelper Incrementer (IJobParametersIncrementer jobParametersIncrementer)
 Add a job parameters incrementer. More...
 
JobBuilderHelper Validator (IJobParametersValidator jobParametersValidator)
 Add a job parameters validator. More...
 
JobBuilderHelper Listener (IJobExecutionListener listener)
 Register a job execution listener. More...
 
JobBuilderHelper PreventRestart ()
 Set a flag to prevent restart an execution of this job even if it has failed. More...
 

Protected Member Functions

 JobBuilderHelper (string name)
 Custom constructor using a name. More...
 
 JobBuilderHelper (JobBuilderHelper parent)
 Create a new builder initialized with any properties in the parent. The parent is copied, so it can be re-used More...
 
IJobRepository GetJobRepository ()
 Returns the job repository. More...
 
bool IsRestartable ()
 Returns the restartable flag. More...
 
void Enhance (IJob target)
 Enhances the given job with incrementer, validator and job execution listeners, if provided. More...
 

Protected Attributes

readonly Logger Logger = LogManager.GetCurrentClassLogger()
 Logger More...
 
readonly CommonJobProperties Properties
 Common job properties. More...
 

Detailed Description

A base class and utility for other job builders providing access to common properties like job repository.

Constructor & Destructor Documentation

Summer.Batch.Core.Job.Builder.JobBuilderHelper.JobBuilderHelper ( string  name)
protected

Custom constructor using a name.

Parameters
name
Summer.Batch.Core.Job.Builder.JobBuilderHelper.JobBuilderHelper ( JobBuilderHelper  parent)
protected

Create a new builder initialized with any properties in the parent. The parent is copied, so it can be re-used

Parameters
parent

Member Function Documentation

void Summer.Batch.Core.Job.Builder.JobBuilderHelper.Enhance ( IJob  target)
protected

Enhances the given job with incrementer, validator and job execution listeners, if provided.

Parameters
target
IJobRepository Summer.Batch.Core.Job.Builder.JobBuilderHelper.GetJobRepository ( )
protected

Returns the job repository.

Returns
JobBuilderHelper Summer.Batch.Core.Job.Builder.JobBuilderHelper.Incrementer ( IJobParametersIncrementer  jobParametersIncrementer)

Add a job parameters incrementer.

Parameters
jobParametersIncrementer
Returns
bool Summer.Batch.Core.Job.Builder.JobBuilderHelper.IsRestartable ( )
protected

Returns the restartable flag.

Returns
JobBuilderHelper Summer.Batch.Core.Job.Builder.JobBuilderHelper.Listener ( IJobExecutionListener  listener)

Register a job execution listener.

Parameters
listener
Returns
JobBuilderHelper Summer.Batch.Core.Job.Builder.JobBuilderHelper.PreventRestart ( )

Set a flag to prevent restart an execution of this job even if it has failed.

Returns
JobBuilderHelper Summer.Batch.Core.Job.Builder.JobBuilderHelper.Repository ( IJobRepository  jobRepository)

Sets the job repository for the job.

Parameters
jobRepository
Returns
JobBuilderHelper Summer.Batch.Core.Job.Builder.JobBuilderHelper.Validator ( IJobParametersValidator  jobParametersValidator)

Add a job parameters validator.

Parameters
jobParametersValidator
Returns

Member Data Documentation

readonly Logger Summer.Batch.Core.Job.Builder.JobBuilderHelper.Logger = LogManager.GetCurrentClassLogger()
protected

Logger

readonly CommonJobProperties Summer.Batch.Core.Job.Builder.JobBuilderHelper.Properties
protected

Common job properties.


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