org.apache.commons.workflow.core
Class RemoveStep

java.lang.Object
  extended by org.apache.commons.workflow.base.BaseStep
      extended by org.apache.commons.workflow.base.DescriptorStep
          extended by org.apache.commons.workflow.core.RemoveStep
All Implemented Interfaces:
Descriptors, Step

public class RemoveStep
extends DescriptorStep

For each associated Descriptor, remove the corresponding Java object from our Context, in the order that descriptors are listed.

Version:
$Revision: 155475 $ $Date: 2005-02-26 13:31:11 +0000 (Sat, 26 Feb 2005) $
Author:
Craig R. McClanahan

Field Summary
 
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
RemoveStep()
          Construct a default instance of this Step.
RemoveStep(String id)
          Construct an instance of this Step with the specified identifier.
RemoveStep(String id, Descriptor descriptor)
          Construct an instance of this Step with the specified identifier and associated Descriptor.
 
Method Summary
 void execute(Context context)
          Perform the executable actions related to this Step, in the context of the specified Context.
 
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, toString, wait, wait, wait
 

Constructor Detail

RemoveStep

public RemoveStep()
Construct a default instance of this Step.


RemoveStep

public RemoveStep(String id)
Construct an instance of this Step with the specified identifier.

Parameters:
id - Step identifier

RemoveStep

public RemoveStep(String id,
                  Descriptor descriptor)
Construct an instance of this Step with the specified identifier and associated Descriptor.

Parameters:
id - Step identifier
descriptor - Initial descriptor
Method Detail

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


Copyright © 2001-2010 The Apache Software Foundation. All Rights Reserved.