org.apache.commons.workflow
Interface Step

All Known Subinterfaces:

Block, Iterator

All Known Implementing Classes:

AndStep, BaseBlock, BaseStep, BreakStep, CallStep, ConstructStep, ContinueStep, DescriptorStep, DisplayStep, DuplicateStep, ExitStep, ForwardStep, GetStep, GetStep, GotoStep, GotoStep, IfAnyStep, IfNotAnyStep, IfNotStep, IfStep, IncludeStep23, InvokeStep, LoadStep, NotAndStep, NotOrStep, OrStep, PeekStep, PopStep, PopulateStep, PutStep, ReadStep, RemoveStep, StringStep, SuspendStep, SwapStep, WhileAnyStep, WhileNotAnyStep, WhileNotStep, WhileStep, WriteStep

public interface Step

A Step represents a single executable action that can occur during the completion of an Activity. The dynamic execution of the implementation of this Step happens within the execute() method -- everything else about a Step is part of its static definition, which is shared among all users of the owning Activity.

Version:

$Revision: 155475 $ $Date: 2005-02-26 13:31:11 +0000 (Sat, 26 Feb 2005) $

Author:

Craig R. McClanahan

Method Summary

void	execute(Context context) Perform the executable actions related to this Step, in the context of the specified Context.
String	getId() Return the unique identifier (within this Activity) of this Step.
Step	getNextStep() Return the next Step in our associated Activity or Block.
Owner	getOwner() Return the Activity or Block that owns this Step.
Step	getPreviousStep() Return the previous Step in our associated Activity or Block.
void	setId(String id) Set the unique identifier (within this Activity) of this Step.
void	setNextStep(Step nextStep) Set the next Step in our associated Activity or Block.
void	setOwner(Owner owner) Set the Activity or Block that owns this Step.
void	setPreviousStep(Step previousStep) Set the previous Step in our associated Activity or Block.

Method Detail

getId

String getId()

Return the unique identifier (within this Activity) of this Step.

setId

void setId(String id)

Set the unique identifier (within this Activity) of this Step.

Parameters:

id - The new unique identifier

getNextStep

Step getNextStep()

Return the next Step in our associated Activity or Block.

setNextStep

void setNextStep(Step nextStep)

Set the next Step in our associated Activity or Block.

Parameters:

nextStep - The new next Step

getOwner

Owner getOwner()

Return the Activity or Block that owns this Step.

setOwner

void setOwner(Owner owner)

Set the Activity or Block that owns this Step.

Parameters:

owner - The new owning Activity or Block

getPreviousStep

Step getPreviousStep()

Return the previous Step in our associated Activity or Block.

setPreviousStep

void setPreviousStep(Step previousStep)

Set the previous Step in our associated Activity or Block.

Parameters:

previousStep - The new previous Step

execute

void execute(Context context)
             throws StepException

Perform the executable actions related to this Step, in the context of the specified Context.

Parameters:

context - The Context that is tracking our execution state

Throws:

StepException - if a processing error has occurred