Batch domain object representation the execution of a step. Unlike JobExecution, there are additional properties related the processing of items such as commit count, etc. More...

Inheritance diagram for Summer.Batch.Core.StepExecution:

Public Member Functions
void	SetTerminateOnly ()
	Terminate only flag; setter. More...

	StepExecution (string stepName, JobExecution jobExecution, long id)
	Constructor with mandatory properties. More...

	StepExecution (string stepName, JobExecution jobExecution)
	Constructor that substitues in null for execution id. More...

void	UpgradeStatus (BatchStatus status)
	Upgrade the status field if the provided value is greater than the existing one. Clients using this method to set the status can be sure that they don't overwrite a failed status with an successful one. More...

long	GetJobExecutionId ()
	Returns the owning job execution id. More...

StepContribution	CreateStepContribution ()
	Factory method for StepContribution. More...

void	Apply (StepContribution contribution)
	On successful execution just before a chunk commit, this method should be called. Synchronizes access to the StepExecution so that changes are atomic. Synchronized method. More...

void	IncrementRollbackCount ()
	On unsuccessful execution after a chunk has rolled back. Synchronized method. More...

void	IncrementCommitCount ()
	Increments the number of commits More...

JobParameters	GetJobParameters ()
	Convenience method to get the current job parameters. More...

ICollection< Exception >	GetFailureExceptions ()
	Returns the failure exceptions collection. More...

void	AddFailureException (Exception exception)
	Adds exception to failure exceptions collection. More...

override bool	Equals (Object obj)
	Equals override. More...

override int	GetHashCode ()
	GetHashCode override. More...

override string	ToString ()
	ToString override. More...

string	GetSummary ()
	GetSummary More...

Public Member Functions inherited from Summer.Batch.Core.Entity
	Entity ()
	Default constructor. More...

	Entity (long?id)
	Custom constructor with id. More...

void	IncrementVersion ()
	Increments the version number. More...

override string	ToString ()
	ToString override. More...

override bool	Equals (Object other)
	Equals override. More...

override int	GetHashCode ()
	Use ID if it exists to establish hash code, otherwise fall back to a call og GetHashCode on the result of the ToString method. More...

Properties
JobExecution	JobExecution `[get]`
	Owning Job execution. More...

string	StepName `[get]`
	Step name. More...

BatchStatus	BatchStatus `[get, set]`
	Batch status. More...

int	ReadCount `[get, set]`
	Read count. More...

int	WriteCount `[get, set]`
	Write count. More...

int	CommitCount `[get, set]`
	Commit count. More...

int	RollbackCount `[get, set]`
	Rollback count. More...

int	ReadSkipCount `[get, set]`
	Read skip count. More...

int	SkipCount `[get]`
	Skip count calculation. More...

int	ProcessSkipCount `[get, set]`
	Process skip count. More...

int	WriteSkipCount `[get, set]`
	Write skip count. More...

DateTime	StartTime `[get, set]`
	Start time. More...

DateTime	EndTime `[get, set]`
	End time. More...

DateTime	LastUpdated `[get, set]`
	Last updated time. More...

ExecutionContext	ExecutionContext `[get, set]`
	Execution context. More...

ExitStatus	ExitStatus `[get, set]`
	Exit status. More...

bool	TerminateOnly `[get]`
	Terminate only flag; getter. More...

int	FilterCount `[get, set]`
	Filter count. More...

Properties inherited from Summer.Batch.Core.Entity
long	Id `[get, set]`
	Id. More...

int	Version `[get, set]`
	Version. More...

Detailed Description

Batch domain object representation the execution of a step. Unlike JobExecution, there are additional properties related the processing of items such as commit count, etc.

Constructor & Destructor Documentation

Summer.Batch.Core.StepExecution.StepExecution	(	string	stepName,
		JobExecution	jobExecution,
		long	id
	)

Constructor with mandatory properties.

Parameters

stepName
jobExecution
id

Summer.Batch.Core.StepExecution.StepExecution	(	string	stepName,
		JobExecution	jobExecution
	)

Constructor that substitues in null for execution id.

Parameters

stepName
jobExecution

Member Function Documentation

void Summer.Batch.Core.StepExecution.AddFailureException ( Exception exception )

Adds exception to failure exceptions collection.

Parameters

exception

void Summer.Batch.Core.StepExecution.Apply ( StepContribution contribution )

On successful execution just before a chunk commit, this method should be called. Synchronizes access to the StepExecution so that changes are atomic. Synchronized method.

Parameters

contribution

StepContribution Summer.Batch.Core.StepExecution.CreateStepContribution ( )

Factory method for StepContribution.

Returns

override bool Summer.Batch.Core.StepExecution.Equals ( Object obj )

Equals override.

Parameters

obj

Returns

ICollection<Exception> Summer.Batch.Core.StepExecution.GetFailureExceptions ( )

Returns the failure exceptions collection.

Returns

override int Summer.Batch.Core.StepExecution.GetHashCode ( )

GetHashCode override.

Returns

long Summer.Batch.Core.StepExecution.GetJobExecutionId ( )

Returns the owning job execution id.

Returns

JobParameters Summer.Batch.Core.StepExecution.GetJobParameters ( )

Convenience method to get the current job parameters.

Returns

string Summer.Batch.Core.StepExecution.GetSummary ( )

GetSummary

Returns

void Summer.Batch.Core.StepExecution.IncrementCommitCount ( )

Increments the number of commits

void Summer.Batch.Core.StepExecution.IncrementRollbackCount ( )

On unsuccessful execution after a chunk has rolled back. Synchronized method.

void Summer.Batch.Core.StepExecution.SetTerminateOnly ( )

Terminate only flag; setter.

override string Summer.Batch.Core.StepExecution.ToString ( )

ToString override.

Returns

void Summer.Batch.Core.StepExecution.UpgradeStatus ( BatchStatus status )

Upgrade the status field if the provided value is greater than the existing one. Clients using this method to set the status can be sure that they don't overwrite a failed status with an successful one.

Parameters

status

Property Documentation

BatchStatus Summer.Batch.Core.StepExecution.BatchStatus

getset

Batch status.

int Summer.Batch.Core.StepExecution.CommitCount

getset

Commit count.

DateTime Summer.Batch.Core.StepExecution.EndTime

getset

End time.

ExecutionContext Summer.Batch.Core.StepExecution.ExecutionContext

getset

Execution context.

ExitStatus Summer.Batch.Core.StepExecution.ExitStatus

getset

Exit status.

int Summer.Batch.Core.StepExecution.FilterCount

getset

Filter count.

JobExecution Summer.Batch.Core.StepExecution.JobExecution

get

Owning Job execution.

DateTime Summer.Batch.Core.StepExecution.LastUpdated

getset

Last updated time.

int Summer.Batch.Core.StepExecution.ProcessSkipCount

getset

Process skip count.

int Summer.Batch.Core.StepExecution.ReadCount

getset

Read count.

int Summer.Batch.Core.StepExecution.ReadSkipCount

getset

Read skip count.

int Summer.Batch.Core.StepExecution.RollbackCount

getset

Rollback count.

int Summer.Batch.Core.StepExecution.SkipCount

get

Skip count calculation.

DateTime Summer.Batch.Core.StepExecution.StartTime

getset

Start time.

string Summer.Batch.Core.StepExecution.StepName

get

Step name.

bool Summer.Batch.Core.StepExecution.TerminateOnly

get

Terminate only flag; getter.

int Summer.Batch.Core.StepExecution.WriteCount

getset

Write count.

int Summer.Batch.Core.StepExecution.WriteSkipCount

getset

Write skip count.

The documentation for this class was generated from the following file:

Summer.Batch.Core/Core/StepExecution.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation