Uses of Interface
org.apache.commons.workflow.Step

Packages that use Step

org.apache.commons.workflow	This package contains the core interfaces and classes that define the major components of the workflow management system.
org.apache.commons.workflow.base	Basic implementations and base classes for Workflow Management System applications.
org.apache.commons.workflow.core	Implementations of Steps in the core library.
org.apache.commons.workflow.io	Implementations of Steps in the io library.
org.apache.commons.workflow.util	General purpose utility classes required by the Workflow Management System.
org.apache.commons.workflow.web	Implementations of Steps in the web library.

Uses of Step in org.apache.commons.workflow

Subinterfaces of Step in org.apache.commons.workflow

interface	Block A Block is a Step that can include nested Steps.
interface	Iterator An Iterator is a Block that conditionally repeats the nested Steps associated with the Block more than once (such as a Block that implements "while" or "for" functionality).

Fields in org.apache.commons.workflow declared as Step

protected Step	StepException.step The Step that was being executed when the problem occurred.
protected Step	ContextEvent.step The Step upon which this event occurred.

Methods in org.apache.commons.workflow that return Step

Step	Owner.findStep(String id) Return the identified Step from our current Activity or Block, if it exists.
Step	Owner.getFirstStep() Return the first Step associated with this Activity or Block.
Step	Owner.getLastStep() Return the last Step associated with this Activity or Block.
Step	Step.getNextStep() Return the next Step in our associated Activity or Block.
Step	Context.getNextStep() Return the Step that will be executed the next time that execute() is called, if any.
Step	Step.getPreviousStep() Return the previous Step in our associated Activity or Block.
Step	StepException.getStep()
Step	ContextEvent.getStep()
Step[]	Owner.getSteps() Return the set of Steps associated with this Activity or Block.

Methods in org.apache.commons.workflow with parameters of type Step

void	Owner.addStep(Step step) Add a new Step to the end of the sequence of Steps associated with this Activity or Block.
void	Step.setNextStep(Step nextStep) Set the next Step in our associated Activity or Block.
void	Context.setNextStep(Step nextStep) Set the Step that will be executed the next time that execute() is called.
void	Step.setPreviousStep(Step previousStep) Set the previous Step in our associated Activity or Block.
void	Owner.setSteps(Step[] steps) Set the set of Steps associated with this Activity or Block, replacing any existing ones.

Constructors in org.apache.commons.workflow with parameters of type Step

ContextEvent(Context context, Step step)
Construct a new immutable ContextEvent.

ContextEvent(Context context, Step step, StepException exception)
Construct a new immutable ContextEvent.

StepException(Step step)
Construct an empty StepException occurring with the specified Step.

StepException(String message, Step step)
Construct a StepException with the specified message occurring with the specified Step.

StepException(String message, Throwable cause, Step step)
Construct a StepException with the specified message and underlying cause, occurring in the specified Step.

StepException(Throwable cause, Step step)
Construct a StepException with the specified underlying cause, occurring in the specified Step.

Uses of Step in org.apache.commons.workflow.base

Classes in org.apache.commons.workflow.base that implement Step

class	BaseBlock BaseBlock is a convenient base class for more sophisticated Block implementations.
class	BaseStep BaseStep is a convenient base class for more sophisticated Step implementations.
class	DescriptorStep DescriptorStep is a convenient base class for more sophisticated Step implementations that already support the APIs provided by BaseStep, and also implement the Descriptors interafce.

Fields in org.apache.commons.workflow.base declared as Step

protected Step	BaseBlock.firstStep The first Step associated with this Block.
protected Step	BaseActivity.firstStep The first Step associated with this Activity.
protected Step	BaseBlock.lastStep The last Step associated with this Block.
protected Step	BaseActivity.lastStep The last Step associated with this Activity.
protected Step	BaseStep.nextStep The next Step in our associated Activity.
protected Step	BaseContext.nextStep The Step that will be executed first the next time that execute() is called.
protected Step	BaseStep.previousStep The previous Step in our associated Activity.

Methods in org.apache.commons.workflow.base that return Step

Step	BaseBlock.findStep(String id) Return the identified Step from this Block, if it exists.
Step	BaseActivity.findStep(String id) Return the identified Step from this Activity, if it exists.
Step[]	BaseContext.getCalls() Return the set of pending Step executions that are pending because of calls to subordinate Activities have occurred.
Step	BaseBlock.getFirstStep() Return the first Step associated with this Block.
Step	BaseActivity.getFirstStep() Return the first Step associated with this Activity.
Step	BaseBlock.getLastStep() Return the last Step associated with this Activity.
Step	BaseActivity.getLastStep() Return the last Step associated with this Activity.
Step	BaseStep.getNextStep() Return the next Step in our associated Activity or Block.
Step	BaseContext.getNextStep() Return the Step that will be executed the next time that execute() is called, if any.
Step	BaseStep.getPreviousStep() Return the previous Step in our associated Activity or Block.
Step[]	BaseBlock.getSteps() Return the set of Steps associated with this Block.
Step[]	BaseActivity.getSteps() Return the set of Steps associated with this Activity.

Methods in org.apache.commons.workflow.base with parameters of type Step

void	BaseBlock.addStep(Step step) Add a new Step to the end of the sequence of Steps associated with this Block.
void	BaseActivity.addStep(Step step) Add a new Step to the end of the sequence of Steps associated with this Activity.
void	BaseStep.setNextStep(Step nextStep) Set the next Step in our associated Activity or Block.
void	BaseContext.setNextStep(Step nextStep) Set the Step that will be executed the next time that execute() is called.
void	BaseStep.setPreviousStep(Step previousStep) Set the previous Step in our associated Activity or Block.
void	BaseBlock.setSteps(Step[] steps) Set the set of Steps associated with this Block, replacing any existing ones.
void	BaseActivity.setSteps(Step[] steps) Set the set of Steps associated with this Activity, replacing any existing ones.

Uses of Step in org.apache.commons.workflow.core

Classes in org.apache.commons.workflow.core that implement Step

class	AndStep Evaluate properties specified by the associated Descriptors, and transfer control to the specified step if ALL of them are true (if boolean) or not null (if Object).
class	BreakStep Locate the closest surrounding Iterator, set the nesting control to false, and transfer control to the Iterator.
class	CallStep Pop the top value from the evaluation stack, which must be an Activity, and initiate a "subroutine call" to execute this Activity before resuming the current one.
class	ConstructStep Create a new object of the specified class, using the constructor that accepts the arguments specified by the associated Descriptor objects.
class	ContinueStep Locate the closest surrounding Iterator, set the nesting control to true, and transfer control to the Iterator.
class	DuplicateStep Push a new copy of the top item on the evaluation stack onto the stack.
class	ExitStep Signal our Context that we have completed the current Activity.
class	GetStep For each associated Descriptor, make a copy of the specified Java object and push it on to the evaluation stack, in the order that descriptors are listed.
class	GotoStep Unconditionally transfer control to the specified step.
class	IfAnyStep Evaluate properties specified by the associated Descriptors, and execute the nested Steps if and only if ANY of them evaluate to a positive result.
class	IfNotAnyStep Evaluate properties specified by the associated Descriptors, and execute the nested Steps if and only if ALL of them evaluate to a negative result.
class	IfNotStep Evaluate properties specified by the associated Descriptors, and execute the nested Steps if and only if ANY of them evaluate to a negative result.
class	IfStep Evaluate properties specified by the associated Descriptors, and execute the nested Steps if and only if they ALL evaluate to a positive result.
class	InvokeStep Call the specified method of the specified bean in the specified scope, passing arguments as specified by associated Descriptor objects.
class	LoadStep Load a class with the specified name from the specified class loader, and push the corresponding java.lang.Class object onto the evaluation stack.
class	NotAndStep Evaluate properties specified by the associated Descriptors, and transfer control to the specified step if ALL of them are false (if boolean) or null (if Object).
class	NotOrStep Evaluate properties specified by the associated Descriptors, and transfer control to the specified step if ANY of them are false (if boolean) or null (if Object).
class	OrStep Evaluate properties specified by the associated Descriptors, and transfer control to the specified step if ANY of them are true (if boolean) or not null (if Object).
class	PopStep Pop the top value from the evaluation stack and throw it away.
class	PutStep For each associated Descriptor, pop the top value from the evaluation stack, and store it as specified by that Descriptor, in the order that descriptors are listed.
class	RemoveStep For each associated Descriptor, remove the corresponding Java object from our Context, in the order that descriptors are listed.
class	StringStep Push the specified String value onto the top of the evaluation stack.
class	SuspendStep Signal our Context to suspend execution until control is returned.
class	SwapStep Swap the positions of the top two values on the evaluation stack.
class	WhileAnyStep Repeatedly evaluate the properties specified by the associated Descriptors, and execute the nested Steps if and only if ANY of them evaluate to a positive result.
class	WhileNotAnyStep Repeatedly evaluate the properties specified by the associated Descriptors, and execute the nested Steps if and only if ALL of them evaluate to a negative result.
class	WhileNotStep Repeatedly evaluate the properties specified by the associated Descriptors, and execute the nested Steps if and only if ANY of them evaluate to a negative result.
class	WhileStep Repeatedly evaluate the properties specified by the associated Descriptors, and execute the nested Steps if and only if ALL of them evaluate to a positive result.

Uses of Step in org.apache.commons.workflow.io

Classes in org.apache.commons.workflow.io that implement Step

class	DisplayStep For each associated Descriptor, print the value of the specified Java object to standard output.
class	PeekStep Write the top value from the evaluation stack to standard output, without removing it.
class	ReadStep Read the contents of the specified file from the filesystem, and push the contents as a String object onto the evaluation stack.
class	WriteStep Pop the top value from the evaluation stack, and write its contents as a string to the specified file in the filesystem (replacing any previous contents in that file).

Uses of Step in org.apache.commons.workflow.util

Methods in org.apache.commons.workflow.util with parameters of type Step

void	ContextSupport.fireAfterActivity(Step step) Fire a afterActivity event to all registered listeners.
void	ContextSupport.fireAfterActivity(Step step, StepException exception) Fire a afterActivity event to all registered listeners.
void	ContextSupport.fireAfterStep(Step step) Fire a afterStep event to all registered listeners.
void	ContextSupport.fireAfterStep(Step step, StepException exception) Fire a afterStep event to all registered listeners.
void	ContextSupport.fireBeforeActivity(Step step) Fire a beforeActivity event to all registered listeners.
void	ContextSupport.fireBeforeStep(Step step) Fire a beforeStep event to all registered listeners.

Uses of Step in org.apache.commons.workflow.web

Classes in org.apache.commons.workflow.web that implement Step

class	ForwardStep Perform a RequestDispatcher.forward() operation on the specified context relative path, and tell our Context to suspend execution until control is returned.
class	IncludeStep23 Perform a RequestDispatcher.include() operation on the specified context relative path, and push the response data (as a String onto the evaluation stack.
class	PopulateStep For each associated Descriptor, populate the properties of the bean specified by that descriptor from the request parameters of the current request.