org.apache.commons.workflow.web
Class GotoStep

java.lang.Object
  org.apache.commons.workflow.base.BaseStep
      org.apache.commons.workflow.web.GotoStep

All Implemented Interfaces:

Step

public class GotoStep
extends BaseStep

Unconditionally transfer control to the step that is identified by a request parameter with the specified name.

Supported Attributes:

• step - Name of a request parameter, included on the current request, that contains the identifier of the Step (within the current Activity) to which control should be transferred. If not specified, a request parameter named step is used.

Version:

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

Author:

Craig R. McClanahan

Field Summary

protected String

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

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(String id)
Construct an instance of this Step with the specified identifier.

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

Method Summary

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

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 String step

The request parameter containing 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(String id)

Construct an instance of this Step with the specified identifier.

Parameters:

id - Step identifier

GotoStep

public GotoStep(String id,
                String step)

Construct a fully configured instance of this Step.

Parameters:

id - Step identifier

step - Request parameter name containing our step identifier

Method Detail

getStep

public String getStep()

setStep

public void setStep(String step)

execute

public void execute(Context context)
             throws StepException

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

Specified by:

execute in interface Step

Specified by:

execute in class BaseStep

Parameters:

context - The Context that is tracking our execution state

Throws:

StepException - if a processing error has occurred

toString

public String toString()

Render a string representation of this Step.

Overrides:

toString in class Object