Summer.Batch.Core.Job.Flow.Support.State.EndState Class Reference

IState implementation for ending a job if it is in progress and continuing if just starting. More...

Inheritance diagram for Summer.Batch.Core.Job.Flow.Support.State.EndState:

Public Member Functions
	EndState (string name)
	Custom constructor using a name. More...
	EndState (FlowExecutionStatus status, string name)
	Custom constructor using a status and a name. More...
	EndState (FlowExecutionStatus status, string code, string name)
	Custom constructor using a status, a code and a name. More...
	EndState (FlowExecutionStatus status, string code, string name, bool abandon)
	Custom constructor using a status, a code, a name and an abandon flag. More...
override FlowExecutionStatus	Handle (IFlowExecutor executor)
	Returns the FlowExecutionStatus stored. More...
override bool	IsEndState ()
override string	ToString ()
	ToString override. More...
Public Member Functions inherited from Summer.Batch.Core.Job.Flow.Support.State.AbstractState
string	GetName ()
override string	ToString ()
	ToString override. More...

Protected Member Functions
void	SetExitStatus (IFlowExecutor executor, string code)
	Performs any logic to update the exit status for the current flow. More...
Protected Member Functions inherited from Summer.Batch.Core.Job.Flow.Support.State.AbstractState
	AbstractState (string name)
	Custom constructor using a name. More...

Properties
FlowExecutionStatus	Status [get]
	Status. More...
bool	Abandon [get]
	Abandon flag. More...
string	Code [get]
	Code. More...

Detailed Description

IState implementation for ending a job if it is in progress and continuing if just starting.

Constructor & Destructor Documentation

Summer.Batch.Core.Job.Flow.Support.State.EndState.EndState

(

string

name

)

Custom constructor using a name.

Parameters

name

Summer.Batch.Core.Job.Flow.Support.State.EndState.EndState	(	FlowExecutionStatus	status,
		string	name
	)

Custom constructor using a status and a name.

Parameters

status	The FlowExecutionStatus to end with
name	The name of the state

Summer.Batch.Core.Job.Flow.Support.State.EndState.EndState	(	FlowExecutionStatus	status,
		string	code,
		string	name
	)

Custom constructor using a status, a code and a name.

Parameters

status	The FlowExecutionStatus to end with
code
name	The name of the state

Summer.Batch.Core.Job.Flow.Support.State.EndState.EndState	(	FlowExecutionStatus	status,
		string	code,
		string	name,
		bool	abandon
	)

Custom constructor using a status, a code, a name and an abandon flag.

Parameters

status	The FlowExecutionStatus to end with
code
name	The name of the state
abandon	flag to indicate that previous step execution can be marked as abandoned (if there is one)

Member Function Documentation

override FlowExecutionStatus Summer.Batch.Core.Job.Flow.Support.State.EndState.Handle ( IFlowExecutor  executor )

virtual

Returns the FlowExecutionStatus stored.

See also

IState::Handle

Parameters

executor

Returns

Exceptions

Exception

Implements Summer.Batch.Core.Job.Flow.Support.State.AbstractState.

override bool Summer.Batch.Core.Job.Flow.Support.State.EndState.IsEndState ( )

virtual

See also

IState::IsEndState .

Returns

Implements Summer.Batch.Core.Job.Flow.Support.State.AbstractState.

void Summer.Batch.Core.Job.Flow.Support.State.EndState.SetExitStatus ( IFlowExecutor  executor, string  code  )

protected

Performs any logic to update the exit status for the current flow.

Parameters

executor	FlowExecutor for the current flow
code	The exit status to save

override string Summer.Batch.Core.Job.Flow.Support.State.EndState.ToString

(

)

ToString override.

Returns

Property Documentation

bool Summer.Batch.Core.Job.Flow.Support.State.EndState.Abandon

getprotected

Abandon flag.

string Summer.Batch.Core.Job.Flow.Support.State.EndState.Code

getprotected

Code.

FlowExecutionStatus Summer.Batch.Core.Job.Flow.Support.State.EndState.Status

getprotected

Status.

---

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

• Summer.Batch.Core/Core/Job/Flow/Support/State/EndState.cs