Batch domain object representing the execution of a job. More...

Inheritance diagram for Summer.Batch.Core.JobExecution:

Public Member Functions
	JobExecution (JobExecution original)
	Custom constructor using JobExecution. More...

	JobExecution (JobInstance job, long?id, JobParameters jobParameters, string jobConfigurationName)
	Because a JobExecution isn't valid unless the job is set, this constructor is the only valid one from a modeling point of view. More...

	JobExecution (JobInstance job, JobParameters jobParameters, string jobConfigurationName)
	Custom constructor using a JobInstance, JobParameters and a Job configuration name. More...

	JobExecution (long id, JobParameters jobParameters, string jobConfigurationName)
	Custom constructor using an id, JobParameters and a job configuration name. More...

	JobExecution (JobInstance job, JobParameters jobParameters)
	Constructor for transient (unsaved) instances. More...

	JobExecution (long id, JobParameters jobParameters)
	Custom constructor using an id and JobParameters. More...

	JobExecution (long id)
	Custom constructor using an 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	GetJobId ()
	Convenience getter for for the id of the enclosing job. Useful for DAO implementations. More...

StepExecution	CreateStepExecution (string stepName)
	Registers a step execution with the current job execution. More...

bool	IsRunning ()
	Tests if this JobExecution indicates that it is running. It should be noted that this does not necessarily mean that it has been persisted as such yet. More...

bool	IsStopping ()
	Tests if this JobExecution indicates that it has been signalled to stop. More...

void	Stop ()
	Signals the JobExecution to stop. Iterates through the associated StepExecutions, calling StepExecution::SetTerminateOnly(). More...

void	AddStepExecution (StepExecution stepExecution)
	Method for re-constituting the step executions from existing instances. More...

void	AddFailureException (Exception t)
	Add the provided exception to the failure exception list. More...

List< Exception >	GetAllFailureExceptions ()
	Return all failure causing exceptions for this JobExecution, including step executions. More...

void	AddStepExecutions (IList< StepExecution > stepExecutions)
	Add some step executions. For internal use only. More...

override string	ToString ()
	ToString override. 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
JobParameters	JobParameters `[get]`
	Job parameters. More...

JobInstance	JobInstance `[get, set]`
	Job instance. More...

ICollection< StepExecution >	StepExecutions `[get]`
	Step executions. More...

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

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

DateTime	CreateTime `[get, set]`
	Create time. More...

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

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

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

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

ICollection< Exception >	FailureExceptions `[get]`
	Failure exceptions. More...

string	JobConfigurationName `[get]`
	Job configuration name. 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 representing the execution of a job.

Constructor & Destructor Documentation

Summer.Batch.Core.JobExecution.JobExecution ( JobExecution original )

Custom constructor using JobExecution.

Parameters

original

Summer.Batch.Core.JobExecution.JobExecution	(	JobInstance	job,
		long?	id,
		JobParameters	jobParameters,
		string	jobConfigurationName
	)

Because a JobExecution isn't valid unless the job is set, this constructor is the only valid one from a modeling point of view.

Parameters

job
id
jobParameters
jobConfigurationName

Summer.Batch.Core.JobExecution.JobExecution	(	JobInstance	job,
		JobParameters	jobParameters,
		string	jobConfigurationName
	)

Custom constructor using a JobInstance, JobParameters and a Job configuration name.

Parameters

job
jobParameters
jobConfigurationName

Summer.Batch.Core.JobExecution.JobExecution	(	long	id,
		JobParameters	jobParameters,
		string	jobConfigurationName
	)

Custom constructor using an id, JobParameters and a job configuration name.

Parameters

id
jobParameters
jobConfigurationName

Summer.Batch.Core.JobExecution.JobExecution	(	JobInstance	job,
		JobParameters	jobParameters
	)

Constructor for transient (unsaved) instances.

Parameters

job
jobParameters

Summer.Batch.Core.JobExecution.JobExecution	(	long	id,
		JobParameters	jobParameters
	)

Custom constructor using an id and JobParameters.

Parameters

id
jobParameters

Summer.Batch.Core.JobExecution.JobExecution ( long id )

Custom constructor using an id.

Parameters

id

Member Function Documentation

void Summer.Batch.Core.JobExecution.AddFailureException ( Exception t )

Add the provided exception to the failure exception list.

Parameters

t

void Summer.Batch.Core.JobExecution.AddStepExecution ( StepExecution stepExecution )

Method for re-constituting the step executions from existing instances.

Parameters

stepExecution

void Summer.Batch.Core.JobExecution.AddStepExecutions ( IList< StepExecution > stepExecutions )

Add some step executions. For internal use only.

Parameters

stepExecutions step executions to add to the current list

StepExecution Summer.Batch.Core.JobExecution.CreateStepExecution ( string stepName )

Registers a step execution with the current job execution.

Parameters

stepName

Returns: the name of the step the new execution is associated with

List<Exception> Summer.Batch.Core.JobExecution.GetAllFailureExceptions ( )

Return all failure causing exceptions for this JobExecution, including step executions.

Returns

long Summer.Batch.Core.JobExecution.GetJobId ( )

Convenience getter for for the id of the enclosing job. Useful for DAO implementations.

Returns

bool Summer.Batch.Core.JobExecution.IsRunning ( )

Tests if this JobExecution indicates that it is running. It should be noted that this does not necessarily mean that it has been persisted as such yet.

Returns: true if the job is running

bool Summer.Batch.Core.JobExecution.IsStopping ( )

Tests if this JobExecution indicates that it has been signalled to stop.

Returns: true if the status is BatchStatus::STOPPING

void Summer.Batch.Core.JobExecution.Stop ( )

Signals the JobExecution to stop. Iterates through the associated StepExecutions, calling StepExecution::SetTerminateOnly().

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

ToString override.

Returns

void Summer.Batch.Core.JobExecution.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

DateTime Summer.Batch.Core.JobExecution.CreateTime

getset

Create time.

DateTime Summer.Batch.Core.JobExecution.EndTime

getset

End time.

ExecutionContext Summer.Batch.Core.JobExecution.ExecutionContext

getset

Execution context.

ExitStatus Summer.Batch.Core.JobExecution.ExitStatus

getset

Exit status.

ICollection<Exception> Summer.Batch.Core.JobExecution.FailureExceptions

get

Failure exceptions.

string Summer.Batch.Core.JobExecution.JobConfigurationName

get

Job configuration name.

JobInstance Summer.Batch.Core.JobExecution.JobInstance

getset

Job instance.

JobParameters Summer.Batch.Core.JobExecution.JobParameters

get

Job parameters.

DateTime Summer.Batch.Core.JobExecution.LastUpdated

getset

Last updated time.

DateTime Summer.Batch.Core.JobExecution.StartTime

getset

Start time.

BatchStatus Summer.Batch.Core.JobExecution.Status

getset

Batch status.

ICollection<StepExecution> Summer.Batch.Core.JobExecution.StepExecutions

get

Step executions.

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

Summer.Batch.Core/Core/JobExecution.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation