org.jberet.job.model

Class Step

java.lang.Object

org.jberet.job.model.InheritableJobElement

org.jberet.job.model.Step

All Implemented Interfaces:

Serializable, JobElement, PropertiesHolder

public final class Step
extends InheritableJobElement
implements PropertiesHolder

Corresponds to jsl:Step job element type in job XML.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
void	addTransitionElement(Transition transition) Adds a org.jberet.job.model.Transition to the list of transition elements of this job element.
String	getAllowStartIfComplete() Gets the step's allow-start-if-complete attribute value.
boolean	getAllowStartIfCompleteBoolean() Gets the step's allow-start-if-complete attribute value as boolean.
String	getAttributeNext() Gets the value of the next attribute, which specifies the next job element after this step completes.
RefArtifact	getBatchlet() Gets the step's batchlet as a RefArtifact.
Chunk	getChunk() Gets the step's chunk element.
String	getId() Gets the id of this job element.
Partition	getPartition() Gets the step's partition element.
Properties	getProperties() Gets the org.jberet.job.model.Properties contained in this job element.
String	getStartLimit() Gets the step's start-limit attribute value as string.
int	getStartLimitInt() Gets the step's start-limit attribute value as int.
List<Transition>	getTransitionElements() Gets the list of transition elements, such as Transition.End, Transition.Fail, Transition.Next, Transition.Stop.
void	setProperties(Properties properties) Sets the org.jberet.job.model.Properties contained in this job element.

Methods inherited from class org.jberet.job.model.InheritableJobElement

getListeners, isAbstract, setListeners

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.jberet.job.model.PropertiesHolder

getProperties, setProperties

Method Detail

getStartLimit

public String getStartLimit()

Gets the step's start-limit attribute value as string.

Returns:

the step's start-limit attribute value as string

getStartLimitInt

public int getStartLimitInt()

Gets the step's start-limit attribute value as int.

Returns:

the step's start-limit attribute value as int

getAllowStartIfComplete

public String getAllowStartIfComplete()

Gets the step's allow-start-if-complete attribute value.

Returns:

the step's allow-start-if-complete attribute value as string

getAllowStartIfCompleteBoolean

public boolean getAllowStartIfCompleteBoolean()

Gets the step's allow-start-if-complete attribute value as boolean.

Returns:

the step's allow-start-if-complete attribute value as boolean

getAttributeNext

public String getAttributeNext()

Gets the value of the next attribute, which specifies the next job element after this step completes.

Returns:

next attribute value (name of the next job element)

getBatchlet

public RefArtifact getBatchlet()

Gets the step's batchlet as a RefArtifact. For chunk-type step, this method returns null.

Returns:

the step's batchlet

getChunk

public Chunk getChunk()

Gets the step's chunk element. For batchlet-type step, this method returns null.

Returns:

the step's chunk element

getPartition

public Partition getPartition()

Gets the step's partition element.

Returns:

the step's partition element

getId

public final String getId()

Description copied from interface: JobElement

Gets the id of this job element.

Specified by:

getId in interface JobElement

Returns:

id of this job element

getTransitionElements

public List<Transition> getTransitionElements()

Description copied from interface: JobElement

Gets the list of transition elements, such as Transition.End, Transition.Fail, Transition.Next, Transition.Stop.

Specified by:

getTransitionElements in interface JobElement

Returns:

list of transition elements

addTransitionElement

public void addTransitionElement(Transition transition)

Description copied from interface: JobElement

Adds a org.jberet.job.model.Transition to the list of transition elements of this job element.

Specified by:

addTransitionElement in interface JobElement

Parameters:

transition - a org.jberet.job.model.Transition

getProperties

public Properties getProperties()

Gets the org.jberet.job.model.Properties contained in this job element.

Returns:

the org.jberet.job.model.Properties contained in this job element

setProperties

public void setProperties(Properties properties)

Sets the org.jberet.job.model.Properties contained in this job element.

Parameters:

properties - org.jberet.job.model.Properties for this job element