Interface JobProcessorContext

All Known Implementing Classes:

JobProcessorContextImpl

public interface JobProcessorContext

The context used in the JobProcessor. It holds the job phase and the job entity.

Author:

Guy Brand

See Also:

• JobProcessorContext.Phase

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	JobProcessorContext.Phase	The job phases.

Method Summary

Modifier and Type	Method	Description
AbstractJobEntity	getJobEntity()	Get the job entity.
JobProcessorContext.Phase	getPhase()	Get the job phase.
boolean	isInPhase(JobProcessorContext.Phase phase)	Returns true if the JobProcessorContext is in the specified phase, false otherwise.

Method Details

getPhase

JobProcessorContext.Phase getPhase()

Get the job phase.

Returns:

the job phase

getJobEntity

AbstractJobEntity getJobEntity()

Get the job entity.

Returns:

the job entity

isInPhase

boolean isInPhase(JobProcessorContext.Phase phase)

Returns true if the JobProcessorContext is in the specified phase, false otherwise.

Parameters:

phase - the phase to check

Returns:

true if the JobProcessorContext is in the specified phase, false otherwise.