org.apache.commons.workflow.core
Class GotoStep

java.lang.Object
  org.apache.commons.workflow.base.BaseStep
      org.apache.commons.workflow.base.DescriptorStep
          org.apache.commons.workflow.core.GotoStep

All Implemented Interfaces:

org.apache.commons.workflow.Descriptors, org.apache.commons.workflow.Step

Direct Known Subclasses:

AndStep, NotAndStep, NotOrStep, OrStep

public class GotoStep

extends DescriptorStep

Unconditionally transfer control to the specified step.

Supported Attributes:

• step - Identifier of the Step to which control should be transferred.

Version:

$Revision: 1.8 $ $Date: 2004/02/28 03:35:54 $

Field Summary

protected java.lang.String

step The identifier of the Step to which control should be transferred.

Fields inherited from class org.apache.commons.workflow.base.DescriptorStep

descriptors

Fields inherited from class org.apache.commons.workflow.base.BaseStep

id, nextStep, owner, previousStep

Constructor Summary

GotoStep()
Construct a default instance of this Step.

GotoStep(java.lang.String id)
Construct an instance of this Step with the specified identifier.

GotoStep(java.lang.String id, java.lang.String step)
Construct a fully configured instance of this Step.

Method Summary

void	execute(org.apache.commons.workflow.Context context) Perform the executable actions related to this Step, in the context of the specified Context.
java.lang.String	getStep()
void	setStep(java.lang.String step)
java.lang.String	toString() Render a string representation of this Step.

Methods inherited from class org.apache.commons.workflow.base.DescriptorStep

addDescriptor, findDescriptors, removeDescriptor

Methods inherited from class org.apache.commons.workflow.base.BaseStep

getId, getNextStep, getOwner, getPreviousStep, setId, setNextStep, setOwner, setPreviousStep

Methods inherited from class java.lang.Object

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

Field Detail

step

protected java.lang.String step

The identifier of the Step to which control should be transferred.

Constructor Detail

GotoStep

public GotoStep()

Construct a default instance of this Step.

GotoStep

public GotoStep(java.lang.String id)

Construct an instance of this Step with the specified identifier.

Parameters:

id - Step identifier

GotoStep

public GotoStep(java.lang.String id,
                java.lang.String step)

Construct a fully configured instance of this Step.

Parameters:

id - Step identifier of this step

step - Step identifier to which control should be redirected

Method Detail

getStep

public java.lang.String getStep()

setStep

public void setStep(java.lang.String step)

execute

public void execute(org.apache.commons.workflow.Context context)
             throws org.apache.commons.workflow.StepException

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

Specified by:

execute in interface org.apache.commons.workflow.Step

Specified by:

execute in class BaseStep

Parameters:

context - The Context that is tracking our execution state

Throws:

org.apache.commons.workflow.StepException - if a processing error has occurred

toString

public java.lang.String toString()

Render a string representation of this Step.