A B C D E F G H I K L M N O P R S T U V W X

A

activities - Variable in class org.apache.commons.workflow.base.BaseRegistry

The set of Activity instances registered with this Registry, keyed by identifier.

Activity - Interface in org.apache.commons.workflow

An Activity represents an ordered sequence of Steps that comprise the executable actions necessary to accomplish a business task.

activity - Variable in class org.apache.commons.workflow.base.BaseContext

The Activity that we are associated with and executing Steps from (if any).

activity - Variable in class org.apache.commons.workflow.demo.Main

The Activity constructed by our Digester.

ActivityServlet - Class in org.apache.commons.workflow.web

Demonstration servlet that illustrates one way that workflow support can be integrated into web applications (or web services) without any dependency on application frameworks.

ActivityServlet() - Constructor for class org.apache.commons.workflow.web.ActivityServlet

addActivity(Activity) - Method in class org.apache.commons.workflow.base.BaseRegistry

Add a new Activity to the set of Activity instances known to this Registry.

addActivity(Activity) - Method in interface org.apache.commons.workflow.Registry

Add a new Activity to the set of Activity instances known to this Registry.

addContextListener(ContextListener) - Method in class org.apache.commons.workflow.base.BaseContext

Add a listener that is notified each time beans are added, replaced, or removed in this context.

addContextListener(ContextListener) - Method in interface org.apache.commons.workflow.Context

Add a listener that is notified each time beans are added, replaced, or removed in this context.

addContextListener(ContextListener) - Method in class org.apache.commons.workflow.util.ContextSupport

Add a listener that is notified each time beans are added, replaced, or removed in this context.

addDescriptor(Descriptor) - Method in class org.apache.commons.workflow.base.DescriptorStep

Add a new Descriptor to the set associated with this object.

addDescriptor(Descriptor) - Method in interface org.apache.commons.workflow.Descriptors

Add a new Descriptor to the set associated with this object.

addRuleInstances(Digester) - Method in class org.apache.commons.workflow.base.BaseRuleSet

Add the set of Rule instances defined in this RuleSet to the specified Digester instance, associating them with our namespace URI (if any).

addRuleInstances(Digester) - Method in class org.apache.commons.workflow.core.CoreRuleSet

Add the set of Rule instances defined in this RuleSet to the specified Digester instance, associating them with our namespace URI (if any).

addRuleInstances(Digester) - Method in class org.apache.commons.workflow.io.IoRuleSet

Add the set of Rule instances defined in this RuleSet to the specified Digester instance, associating them with our namespace URI (if any).

addRuleInstances(Digester) - Method in class org.apache.commons.workflow.web.WebRuleSet

Add the set of Rule instances defined in this RuleSet to the specified Digester instance, associating them with our namespace URI (if any).

addScope(int, String, Scope) - Method in class org.apache.commons.workflow.base.BaseContext

Register a Scope implementation under the specified identifier.

addScope(int, String, Scope) - Method in interface org.apache.commons.workflow.Context

Register a Scope implementation under the specified identifier.

addScopeListener(ScopeListener) - Method in class org.apache.commons.workflow.base.BaseScope

Add a listener that is notified each time beans are added, replaced, or removed in this scope.

addScopeListener(ScopeListener) - Method in interface org.apache.commons.workflow.Scope

Add a listener that is notified each time beans are added, replaced, or removed in this scope.

addScopeListener(ScopeListener) - Method in class org.apache.commons.workflow.util.ScopeSupport

Add a listener that is notified each time beans are added, replaced, or removed in this scope.

addStandardDescriptor(Digester, String) - Method in class org.apache.commons.workflow.base.BaseRuleSet

Add the standard set of rules for a new Descriptor that should be recognized.

addStandardStep(Digester, String, String) - Method in class org.apache.commons.workflow.base.BaseRuleSet

Add the standard set of rules for a new Step that should be recognized.

addStep(Step) - Method in class org.apache.commons.workflow.base.BaseActivity

Add a new Step to the end of the sequence of Steps associated with this Activity.

addStep(Step) - Method in class org.apache.commons.workflow.base.BaseBlock

Add a new Step to the end of the sequence of Steps associated with this Block.

addStep(Step) - Method in interface org.apache.commons.workflow.Owner

Add a new Step to the end of the sequence of Steps associated with this Activity or Block.

afterActivity(ContextEvent) - Method in interface org.apache.commons.workflow.ContextListener

Invoked immediately after execution of the related Activity has been completed normally, been suspended, or been aborted by the throwing of a StepException.

afterActivity(ContextEvent) - Method in class org.apache.commons.workflow.demo.Main

Invoked immediately after execution of the related Activity has been completed normally, been suspended, or been aborted by the throwing of a StepException.

afterActivity(ContextEvent) - Method in class org.apache.commons.workflow.web.ActivityServlet

Invoked immediately after execution of the related Activity has been completed normally, been suspended, or been aborted by the throwing of a StepException.

afterStep(ContextEvent) - Method in interface org.apache.commons.workflow.ContextListener

Invoked immediately after the specified Step was executed.

afterStep(ContextEvent) - Method in class org.apache.commons.workflow.demo.Main

Invoked immediately after the specified Step was executed.

afterStep(ContextEvent) - Method in class org.apache.commons.workflow.web.ActivityServlet

Invoked immediately after the specified Step was executed.

AndStep - Class in org.apache.commons.workflow.core

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).

AndStep() - Constructor for class org.apache.commons.workflow.core.AndStep

Construct a default instance of this Step.

AndStep(String) - Constructor for class org.apache.commons.workflow.core.AndStep

Construct an instance of this Step with the specified identifier.

AndStep(String, String) - Constructor for class org.apache.commons.workflow.core.AndStep

Construct a fully configured instance of this Step.

AndStep(String, String, Descriptor) - Constructor for class org.apache.commons.workflow.core.AndStep

Construct a fully configured instance of this Step.

APPLICATION_SCOPE - Static variable in class org.apache.commons.workflow.web.WebContext

The scope identifier for the scope associated with the current servlet context.

APPLICATION_SCOPE_NAME - Static variable in class org.apache.commons.workflow.web.WebContext

The scope name for the scope associated with the current servlet context.

B

baos - Variable in class org.apache.commons.workflow.web.IncludeResponse23

Accumulator for output that is generated via getOutputStream().

BaseActivity - Class in org.apache.commons.workflow.base

BaseActivity is a convenient base class for more sophisticated Activity implementations.

BaseActivity() - Constructor for class org.apache.commons.workflow.base.BaseActivity

BaseBlock - Class in org.apache.commons.workflow.base

BaseBlock is a convenient base class for more sophisticated Block implementations.

BaseBlock() - Constructor for class org.apache.commons.workflow.base.BaseBlock

BaseContext - Class in org.apache.commons.workflow.base

BaseContext is a basic Context implementation that can serve as a convenient base class for more sophisticated Context implementations.

BaseContext() - Constructor for class org.apache.commons.workflow.base.BaseContext

Construct a new BaseContext with all default values.

BaseContextBean - Class in org.apache.commons.workflow.base

Custom JavaBean representing the properties of a BaseContext that are made visible via JPath.

BaseContextBean(BaseContext) - Constructor for class org.apache.commons.workflow.base.BaseContextBean

BaseDescriptor - Class in org.apache.commons.workflow.base

Basic implementation of the Descriptor interface.

BaseDescriptor() - Constructor for class org.apache.commons.workflow.base.BaseDescriptor

Create an instance with default values.

BaseDescriptor(String) - Constructor for class org.apache.commons.workflow.base.BaseDescriptor

Create an instance with the specified values.

BaseDescriptor(String, Class) - Constructor for class org.apache.commons.workflow.base.BaseDescriptor

Create an instance with the specified values.

BaseDescriptor(String, String) - Constructor for class org.apache.commons.workflow.base.BaseDescriptor

Create an instance with the specified values.

BaseDescriptor(String, String, Class) - Constructor for class org.apache.commons.workflow.base.BaseDescriptor

Create an instance with the specified values.

BaseDescriptor(String, String, String, Class) - Constructor for class org.apache.commons.workflow.base.BaseDescriptor

Create an instance with the specified values.

BaseRegistry - Class in org.apache.commons.workflow.base

BaseRegistry is a convenient base class for more sophisticated Registry implementations.

BaseRegistry() - Constructor for class org.apache.commons.workflow.base.BaseRegistry

BaseRuleSet - Class in org.apache.commons.workflow.base

RuleSet for the basic Activity definitions of the Workflow Management System, typically associated with the base prefix.

BaseRuleSet() - Constructor for class org.apache.commons.workflow.base.BaseRuleSet

Construct a default instance of the RuleSet.

BaseScope - Class in org.apache.commons.workflow.base

BaseScope is a basic Scope implementation that maintains its bean collection in an in-memory HashMap.

BaseScope() - Constructor for class org.apache.commons.workflow.base.BaseScope

BaseStep - Class in org.apache.commons.workflow.base

BaseStep is a convenient base class for more sophisticated Step implementations.

BaseStep() - Constructor for class org.apache.commons.workflow.base.BaseStep

bean - Variable in class org.apache.commons.workflow.base.BaseContext

The bean representing the information about this Context made visible through JXPath.

beanAdded(ScopeEvent) - Method in interface org.apache.commons.workflow.ScopeListener

Invoked when a new bean was added to this scope.

beanRemoved(ScopeEvent) - Method in interface org.apache.commons.workflow.ScopeListener

Invoked when an existing bean was removed in this scope.

beanReplaced(ScopeEvent) - Method in interface org.apache.commons.workflow.ScopeListener

Invoked when an existing bean was replaced in this scope.

beforeActivity(ContextEvent) - Method in interface org.apache.commons.workflow.ContextListener

Invoked immediately before execution of the related Activity has started.

beforeActivity(ContextEvent) - Method in class org.apache.commons.workflow.demo.Main

Invoked immediately before execution of the related Activity has started.

beforeActivity(ContextEvent) - Method in class org.apache.commons.workflow.web.ActivityServlet

Invoked immediately before execution of the related Activity has started.

beforeStep(ContextEvent) - Method in interface org.apache.commons.workflow.ContextListener

Invoked immediately before the specified Step is executed.

beforeStep(ContextEvent) - Method in class org.apache.commons.workflow.demo.Main

Invoked immediately before the specified Step is executed.

beforeStep(ContextEvent) - Method in class org.apache.commons.workflow.web.ActivityServlet

Invoked immediately before the specified Step is executed.

Block - Interface in org.apache.commons.workflow

A Block is a Step that can include nested Steps.

block - Variable in class org.apache.commons.workflow.BlockState

The Block whose state is represented by this object.

BlockState - Class in org.apache.commons.workflow

BlockState represents the current dynamic execution state of a Block that is executing nested Steps.

BlockState(Block, boolean) - Constructor for class org.apache.commons.workflow.BlockState

Construct a new BlockState instance, associated with the specified block, and with the specified initial value for the nest property.

BreakStep - Class in org.apache.commons.workflow.core

Locate the closest surrounding Iterator, set the nesting control to false, and transfer control to the Iterator.

BreakStep() - Constructor for class org.apache.commons.workflow.core.BreakStep

Construct a default instance of this Step.

BreakStep(String) - Constructor for class org.apache.commons.workflow.core.BreakStep

Construct an instance of this Step with the specified identifier.

C

call(Activity) - Method in class org.apache.commons.workflow.base.BaseContext

Save the execution state (ie the currently assigned next step) of the Activity we are currently executing, and begin executing the specified Activity.

call(Activity) - Method in interface org.apache.commons.workflow.Context

Save the execution state (i.e.

calls - Variable in class org.apache.commons.workflow.base.BaseContext

The suspended "next step" Step for each in-progress Activity that has issued a call() to execute a subordinate Activity.

CallStep - Class in org.apache.commons.workflow.core

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.

CallStep() - Constructor for class org.apache.commons.workflow.core.CallStep

Construct a default instance of this Step.

CallStep(String) - Constructor for class org.apache.commons.workflow.core.CallStep

Construct an instance of this Step with the specified identifier.

cause - Variable in exception org.apache.commons.workflow.WorkflowException

The underlying cause exception (if any).

caw - Variable in class org.apache.commons.workflow.web.IncludeResponse23

Accumulator for output that is generated via getWriter().

clear() - Method in class org.apache.commons.workflow.base.BaseContext

Clear the evaluation stack.

clear() - Method in class org.apache.commons.workflow.base.BaseRegistry

Clear any existing Activity instances registered with this Registry.

clear() - Method in class org.apache.commons.workflow.base.BaseScope

Remove all beans from this Map and call scopeCleared() on all registered ScopeListeners.

clear() - Method in interface org.apache.commons.workflow.Context

Clear the evaluation stack.

clear() - Method in interface org.apache.commons.workflow.Registry

Clear any existing Activity instances registered with this Registry.

clear() - Method in interface org.apache.commons.workflow.Scope

Remove all beans from this Map and call scopeCleared() on all registered ScopeListeners.

clear() - Method in class org.apache.commons.workflow.web.HttpSessionScope

Remove all beans from this Map and call scopeCleared() on all registered ScopeListeners.

clear() - Method in class org.apache.commons.workflow.web.ServletContextScope

Remove all beans from this Map and call scopeCleared() on all registered ScopeListeners.

clear() - Method in class org.apache.commons.workflow.web.ServletRequestScope

Remove all beans from this Map and call scopeCleared() on all registered ScopeListeners.

clearBlockState() - Method in class org.apache.commons.workflow.base.BaseContext

Clear the BlockState stack.

clearBlockState() - Method in interface org.apache.commons.workflow.Context

Clear the BlockState stack.

clearSteps() - Method in class org.apache.commons.workflow.base.BaseActivity

Clear any existing Steps associated with this Activity.

clearSteps() - Method in class org.apache.commons.workflow.base.BaseBlock

Clear any existing Steps associated with this Block.

clearSteps() - Method in interface org.apache.commons.workflow.Owner

Clear any existing Steps associated with this Activity or Block.

ConstructStep - Class in org.apache.commons.workflow.core

Create a new object of the specified class, using the constructor that accepts the arguments specified by the associated Descriptor objects.

ConstructStep() - Constructor for class org.apache.commons.workflow.core.ConstructStep

Construct a default instance of this Step.

ConstructStep(String) - Constructor for class org.apache.commons.workflow.core.ConstructStep

Construct an instance of this Step with the specified identifier.

ConstructStep(String, Descriptor) - Constructor for class org.apache.commons.workflow.core.ConstructStep

Construct an instance of this Step with the specified identifier and associated Descriptor.

contains(String) - Method in class org.apache.commons.workflow.base.BaseContext

Return true if a bean with the specified key exist in any specified scope.

contains(String, int) - Method in class org.apache.commons.workflow.base.BaseContext

Does a bean with the specified key exist in the specified scope?

contains(String) - Method in interface org.apache.commons.workflow.Context

Does a bean with the specified key exist in any specified scope? Scopes will be searched in ascending order of their identifiers, starting with LOCAL_SCOPE.

contains(String, int) - Method in interface org.apache.commons.workflow.Context

Does a bean with the specified key exist in the specified scope?

containsKey(Object) - Method in class org.apache.commons.workflow.base.BaseScope

Return true if this map contains the specified key.

containsKey(Object) - Method in class org.apache.commons.workflow.web.HttpSessionScope

Return true if this map contains the specified key.

containsKey(Object) - Method in class org.apache.commons.workflow.web.ServletContextScope

Return true if this map contains the specified key.

containsKey(Object) - Method in class org.apache.commons.workflow.web.ServletRequestScope

Return true if this map contains the specified key.

containsValue(Object) - Method in class org.apache.commons.workflow.base.BaseScope

Return true if this map contains the specified value.

containsValue(Object) - Method in class org.apache.commons.workflow.web.HttpSessionScope

Return true if this map contains the specified value.

containsValue(Object) - Method in class org.apache.commons.workflow.web.ServletContextScope

Return true if this map contains the specified value.

containsValue(Object) - Method in class org.apache.commons.workflow.web.ServletRequestScope

Return true if this map contains the specified value.

Context - Interface in org.apache.commons.workflow

A Context represents the dynamic computational state of a workflow process that is currently being executed.

context - Variable in class org.apache.commons.workflow.ContextEvent

The Context upon which this event occurred.

context - Variable in class org.apache.commons.workflow.util.ContextSupport

The Context for whom we will fire events.

ContextEvent - Class in org.apache.commons.workflow

A ContextEvent provides notification to a ContextListener that a specified event has occurred for the specified context.

ContextEvent(Context) - Constructor for class org.apache.commons.workflow.ContextEvent

Construct a new immutable ContextEvent.

ContextEvent(Context, Step) - Constructor for class org.apache.commons.workflow.ContextEvent

Construct a new immutable ContextEvent.

ContextEvent(Context, Step, StepException) - Constructor for class org.apache.commons.workflow.ContextEvent

Construct a new immutable ContextEvent.

ContextListener - Interface in org.apache.commons.workflow

A ContextListener registers its interest in receiving ContextEvent notifications when the occur on a particular Context of interest.

ContextSupport - Class in org.apache.commons.workflow.util

ContextSupport is a convenience class for managing the firing of ContextEvents to registered ContextListeners.

ContextSupport(Context) - Constructor for class org.apache.commons.workflow.util.ContextSupport

Construct a new ContextSupport object associated with the specified Context.

ContinueStep - Class in org.apache.commons.workflow.core

Locate the closest surrounding Iterator, set the nesting control to true, and transfer control to the Iterator.

ContinueStep() - Constructor for class org.apache.commons.workflow.core.ContinueStep

Construct a default instance of this Step.

ContinueStep(String) - Constructor for class org.apache.commons.workflow.core.ContinueStep

Construct an instance of this Step with the specified identifier.

CoreRuleSet - Class in org.apache.commons.workflow.core

RuleSet for the Step definitions supported by the core library.

CoreRuleSet() - Constructor for class org.apache.commons.workflow.core.CoreRuleSet

Construct a default instance of the RuleSet.

createDigester() - Method in class org.apache.commons.workflow.demo.Main

Create a Digester instance that knows how to parse activities using the core and io built-in Steps.

D

DemoBean - Class in org.apache.commons.workflow.web

JavaBean used in the demonstration web application.

DemoBean() - Constructor for class org.apache.commons.workflow.web.DemoBean

Descriptor - Interface in org.apache.commons.workflow

A Descriptor is a description of the mechanism by which an arbitrary Java object (typically a JavaBean) is referenced.

descriptors - Variable in class org.apache.commons.workflow.base.DescriptorStep

The list of Descriptor objects associated with this Step.

Descriptors - Interface in org.apache.commons.workflow

Implementing Descriptors indicates that the corresponding object has an associated list of Descriptor objects associated with it, which can be manipulated through the methods defined in this interface.

DescriptorStep - Class in org.apache.commons.workflow.base

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.

DescriptorStep() - Constructor for class org.apache.commons.workflow.base.DescriptorStep

destroy() - Method in class org.apache.commons.workflow.web.ActivityServlet

Perform a graceful shutdown of this servlet instance.

digester - Variable in class org.apache.commons.workflow.demo.Main

The Digester used to process input files.

DisplayStep - Class in org.apache.commons.workflow.io

For each associated Descriptor, print the value of the specified Java object to standard output.

DisplayStep() - Constructor for class org.apache.commons.workflow.io.DisplayStep

Construct a default instance of this Step.

DisplayStep(String) - Constructor for class org.apache.commons.workflow.io.DisplayStep

Construct an instance of this Step with the specified identifier.

DisplayStep(String, Descriptor) - Constructor for class org.apache.commons.workflow.io.DisplayStep

Construct an instance of this Step with the specified identifier and associated Descriptor.

doGet(HttpServletRequest, HttpServletResponse) - Method in class org.apache.commons.workflow.web.ActivityServlet

Process a GET transaction.

doPost(HttpServletRequest, HttpServletResponse) - Method in class org.apache.commons.workflow.web.ActivityServlet

Process a POST transaction.

DuplicateStep - Class in org.apache.commons.workflow.core

Push a new copy of the top item on the evaluation stack onto the stack.

DuplicateStep() - Constructor for class org.apache.commons.workflow.core.DuplicateStep

Construct a default instance of this Step.

DuplicateStep(String) - Constructor for class org.apache.commons.workflow.core.DuplicateStep

Construct an instance of this Step with the specified identifier.

E

encoding - Variable in class org.apache.commons.workflow.io.ReadStep

The character encoding used to interpret the contents of this file.

encoding - Variable in class org.apache.commons.workflow.io.WriteStep

The character encoding used to write the contents of this file.

entrySet() - Method in class org.apache.commons.workflow.base.BaseScope

Return a set view of the mappings contained in this map.

entrySet() - Method in class org.apache.commons.workflow.web.HttpSessionScope

Return a set view of the mappings contained in this map.

entrySet() - Method in class org.apache.commons.workflow.web.ServletContextScope

Return a set view of the mappings contained in this map.

entrySet() - Method in class org.apache.commons.workflow.web.ServletRequestScope

Return a set view of the mappings contained in this map.

equals(Object) - Method in class org.apache.commons.workflow.base.BaseScope

Compare the specified object with this map for equality.

equals(Object) - Method in class org.apache.commons.workflow.web.HttpSessionScope

Compare the specified object with this map for equality.

equals(Object) - Method in class org.apache.commons.workflow.web.ServletContextScope

Compare the specified object with this map for equality.

equals(Object) - Method in class org.apache.commons.workflow.web.ServletRequestScope

Compare the specified object with this map for equality.

evaluate(Context) - Method in class org.apache.commons.workflow.base.BaseBlock

Evaluate the condition specified by the Descriptors associated with this Block, and return the resulting boolean value.

evaluate(Context) - Method in class org.apache.commons.workflow.core.IfAnyStep

Evaluate the condition specified by the Descriptors associated with this Block, and return the resulting boolean value.

evaluate(Context) - Method in class org.apache.commons.workflow.core.IfNotAnyStep

Evaluate the condition specified by the Descriptors associated with this Block, and return the resulting boolean value.

evaluate(Context) - Method in class org.apache.commons.workflow.core.IfNotStep

Evaluate the condition specified by the Descriptors associated with this Block, and return the resulting boolean value.

evaluate(Context) - Method in class org.apache.commons.workflow.core.IfStep

Evaluate the condition specified by the Descriptors associated with this Block, and return the resulting boolean value.

evaluate(Context) - Method in class org.apache.commons.workflow.core.WhileAnyStep

Evaluate the condition specified by the Descriptors associated with this Block, and return the resulting boolean value.

evaluate(Context) - Method in class org.apache.commons.workflow.core.WhileNotAnyStep

Evaluate the condition specified by the Descriptors associated with this Block, and return the resulting boolean value.

evaluate(Context) - Method in class org.apache.commons.workflow.core.WhileNotStep

Evaluate the condition specified by the Descriptors associated with this Block, and return the resulting boolean value.

evaluate(Context) - Method in class org.apache.commons.workflow.core.WhileStep

Evaluate the condition specified by the Descriptors associated with this Block, and return the resulting boolean value.

exception - Variable in class org.apache.commons.workflow.ContextEvent

The StepException that caused this event.

execute(Context) - Method in class org.apache.commons.workflow.base.BaseBlock

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

execute() - Method in class org.apache.commons.workflow.base.BaseContext

Execute the Step currently identified as the next step, and continue execution until there is no next step, or until the suspend property has been set to true.

execute(Context) - Method in class org.apache.commons.workflow.base.BaseStep

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

execute() - Method in interface org.apache.commons.workflow.Context

Execute the Step currently identified as the next step, and continue execution until there is no next step, or until the suspend property has been set to true.

execute(Context) - Method in class org.apache.commons.workflow.core.AndStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.BreakStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.CallStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.ConstructStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.ContinueStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.DuplicateStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.ExitStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.GetStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.GotoStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.InvokeStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.LoadStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.NotAndStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.NotOrStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.OrStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.PopStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.PutStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.RemoveStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.StringStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.SuspendStep

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

execute(Context) - Method in class org.apache.commons.workflow.core.SwapStep

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

execute(Context) - Method in class org.apache.commons.workflow.io.DisplayStep

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

execute(Context) - Method in class org.apache.commons.workflow.io.GetStep

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

execute(Context) - Method in class org.apache.commons.workflow.io.PeekStep

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

execute(Context) - Method in class org.apache.commons.workflow.io.ReadStep

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

execute(Context) - Method in class org.apache.commons.workflow.io.WriteStep

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

execute(Context) - Method in interface org.apache.commons.workflow.Step

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

execute(Context) - Method in class org.apache.commons.workflow.web.ForwardStep

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

execute(Context) - Method in class org.apache.commons.workflow.web.GotoStep

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

execute(Context) - Method in class org.apache.commons.workflow.web.IncludeStep23

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

execute(Context) - Method in class org.apache.commons.workflow.web.PopulateStep

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

ExitStep - Class in org.apache.commons.workflow.core

Signal our Context that we have completed the current Activity.

ExitStep() - Constructor for class org.apache.commons.workflow.core.ExitStep

Construct a default instance of this Step.

ExitStep(String) - Constructor for class org.apache.commons.workflow.core.ExitStep

Construct an instance of this Step with the specified identifier.

F

file - Variable in class org.apache.commons.workflow.io.ReadStep

The relative or absolute pathname of the operating system file.

file - Variable in class org.apache.commons.workflow.io.WriteStep

The relative or absolute pathname of the operating system file.

findActivities() - Method in class org.apache.commons.workflow.base.BaseRegistry

Return the complete set of Activity instances associated with this Activity.

findActivities() - Method in interface org.apache.commons.workflow.Registry

Return the complete set of Activity instances associated with this Activity.

findActivity(String) - Method in class org.apache.commons.workflow.base.BaseRegistry

Return the registered Activity with the specified identifier, if any; otherwise return null.

findActivity(String) - Method in interface org.apache.commons.workflow.Registry

Return the registered Activity with the specified identifier, if any; otherwise return null.

findDescriptors() - Method in class org.apache.commons.workflow.base.DescriptorStep

Return the set of Descriptor objects associated with this object, in the order that they were originally added.

findDescriptors() - Method in interface org.apache.commons.workflow.Descriptors

Return the set of Descriptor objects associated with this object, in the order that they were originally added.

findMethod(Object, String, Class[]) - Method in class org.apache.commons.workflow.core.InvokeStep

Return a Method of the specified Class with the specified method name, that takes the specified parameter types, if there is one.

findStep(String) - Method in class org.apache.commons.workflow.base.BaseActivity

Return the identified Step from this Activity, if it exists.

findStep(String) - Method in class org.apache.commons.workflow.base.BaseBlock

Return the identified Step from this Block, if it exists.

findStep(String) - Method in interface org.apache.commons.workflow.Owner

Return the identified Step from our current Activity or Block, if it exists.

fireAfterActivity(Step) - Method in class org.apache.commons.workflow.util.ContextSupport

Fire a afterActivity event to all registered listeners.

fireAfterActivity(Step, StepException) - Method in class org.apache.commons.workflow.util.ContextSupport

Fire a afterActivity event to all registered listeners.

fireAfterStep(Step) - Method in class org.apache.commons.workflow.util.ContextSupport

Fire a afterStep event to all registered listeners.

fireAfterStep(Step, StepException) - Method in class org.apache.commons.workflow.util.ContextSupport

Fire a afterStep event to all registered listeners.

fireBeanAdded(String, Object) - Method in class org.apache.commons.workflow.util.ScopeSupport

Fire a beanAdded() event to all registered listeners.

fireBeanRemoved(String, Object) - Method in class org.apache.commons.workflow.util.ScopeSupport

Fire a beanRemoved() event to all registered listeners.

fireBeanReplaced(String, Object) - Method in class org.apache.commons.workflow.util.ScopeSupport

Fire a beanReplaced() event to all registered listeners.

fireBeforeActivity(Step) - Method in class org.apache.commons.workflow.util.ContextSupport

Fire a beforeActivity event to all registered listeners.

fireBeforeStep(Step) - Method in class org.apache.commons.workflow.util.ContextSupport

Fire a beforeStep event to all registered listeners.

fireScopeCleared() - Method in class org.apache.commons.workflow.util.ScopeSupport

Fire a scopeCleared() event to all registered listeners.

firstStep - Variable in class org.apache.commons.workflow.base.BaseActivity

The first Step associated with this Activity.

firstStep - Variable in class org.apache.commons.workflow.base.BaseBlock

The first Step associated with this Block.

flushBuffer() - Method in class org.apache.commons.workflow.web.IncludeResponse23

Swallow any attempt to flush the response buffer.

ForwardStep - Class in org.apache.commons.workflow.web

Perform a RequestDispatcher.forward() operation on the specified context relative path, and tell our Context to suspend execution until control is returned.

ForwardStep() - Constructor for class org.apache.commons.workflow.web.ForwardStep

Construct a default instance of this Step.

ForwardStep(String) - Constructor for class org.apache.commons.workflow.web.ForwardStep

Construct an instance of this Step with the specified identifier.

ForwardStep(String, String) - Constructor for class org.apache.commons.workflow.web.ForwardStep

Construct a fully configured instance of this Step.

G

get(String) - Method in class org.apache.commons.workflow.base.BaseContext

Return the bean associated with the specified key, if it exists in any scope.

get(String, int) - Method in class org.apache.commons.workflow.base.BaseContext

Return the bean associated with the specified key, if it exists in the specified scope.

get(Context) - Method in class org.apache.commons.workflow.base.BaseDescriptor

Return the value specified by this Descriptor from the specified Context.

get(Object) - Method in class org.apache.commons.workflow.base.BaseScope

Return the value to which this map maps the specified key.

get(String) - Method in class org.apache.commons.workflow.base.BaseScope

Return the value to which this map maps the specified key.

get(String) - Method in interface org.apache.commons.workflow.Context

Return the bean associated with the specified key, if it exists in any scope.

get(String, int) - Method in interface org.apache.commons.workflow.Context

Return the bean associated with the specified key, if it exists in the specified scope.

get(Context) - Method in interface org.apache.commons.workflow.Descriptor

Return the value specified by this Descriptor from the specified Context.

get(Object) - Method in class org.apache.commons.workflow.web.HttpSessionScope

Return the value to which this map maps the specified key.

get(String) - Method in class org.apache.commons.workflow.web.HttpSessionScope

Return the value to which this map maps the specified key.

get(Object) - Method in class org.apache.commons.workflow.web.ServletContextScope

Return the value to which this map maps the specified key.

get(String) - Method in class org.apache.commons.workflow.web.ServletContextScope

Return the value to which this map maps the specified key.

get(Object) - Method in class org.apache.commons.workflow.web.ServletRequestScope

Return the value to which this map maps the specified key.

get(String) - Method in class org.apache.commons.workflow.web.ServletRequestScope

Return the value to which this map maps the specified key.

getActivity() - Method in class org.apache.commons.workflow.base.BaseContext

Return the Activity we will be executing when the execute() method is called, if any.

getActivity() - Method in interface org.apache.commons.workflow.Context

Return the Activity we will be executing when the execute() method is called, if any.

getBlock() - Method in class org.apache.commons.workflow.BlockState

getCalls() - Method in class org.apache.commons.workflow.base.BaseContext

Return the set of pending Step executions that are pending because of calls to subordinate Activities have occurred.

getCause() - Method in exception org.apache.commons.workflow.WorkflowException

getCharacterEncoding() - Method in class org.apache.commons.workflow.web.IncludeResponse23

Return the character encoding for the included response (if any).

getContent() - Method in class org.apache.commons.workflow.web.IncludeResponse23

Return the response data written to this response as a String.

getContext() - Method in class org.apache.commons.workflow.ContextEvent

getEncoding() - Method in class org.apache.commons.workflow.io.ReadStep

getEncoding() - Method in class org.apache.commons.workflow.io.WriteStep

getException() - Method in class org.apache.commons.workflow.ContextEvent

getFavoriteCar() - Method in class org.apache.commons.workflow.web.DemoBean

getFavoriteCity() - Method in class org.apache.commons.workflow.web.DemoBean

getFavoriteSport() - Method in class org.apache.commons.workflow.web.DemoBean

getFavoriteTeam() - Method in class org.apache.commons.workflow.web.DemoBean

getFile() - Method in class org.apache.commons.workflow.io.ReadStep

getFile() - Method in class org.apache.commons.workflow.io.WriteStep

getFirstName() - Method in class org.apache.commons.workflow.web.DemoBean

getFirstStep() - Method in class org.apache.commons.workflow.base.BaseActivity

Return the first Step associated with this Activity.

getFirstStep() - Method in class org.apache.commons.workflow.base.BaseBlock

Return the first Step associated with this Block.

getFirstStep() - Method in interface org.apache.commons.workflow.Owner

Return the first Step associated with this Activity or Block.

getHttpSession() - Method in class org.apache.commons.workflow.web.HttpSessionScope

getHttpSession() - Method in class org.apache.commons.workflow.web.WebContext

getId() - Method in interface org.apache.commons.workflow.Activity

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

getId() - Method in class org.apache.commons.workflow.base.BaseActivity

Return the unique identifier of this Activity.

getId() - Method in class org.apache.commons.workflow.base.BaseStep

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

getId() - Method in interface org.apache.commons.workflow.Step

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

getJXPathContext() - Method in class org.apache.commons.workflow.base.BaseContext

Return the JXPathContext object that represents a unified namespace covering all of our registered Scopes.

getJXPathContext() - Method in interface org.apache.commons.workflow.Context

Return the JXPathContext object that represents a unified namespace covering all of our registered Scopes.

getKey() - Method in class org.apache.commons.workflow.ScopeEvent

getKey() - Method in class org.apache.commons.workflow.util.MapEntry

getLastName() - Method in class org.apache.commons.workflow.web.DemoBean

getLastStep() - Method in class org.apache.commons.workflow.base.BaseActivity

Return the last Step associated with this Activity.

getLastStep() - Method in class org.apache.commons.workflow.base.BaseBlock

Return the last Step associated with this Activity.

getLastStep() - Method in interface org.apache.commons.workflow.Owner

Return the last Step associated with this Activity or Block.

getLocal() - Method in class org.apache.commons.workflow.base.BaseContext

Return the Scope instance for our local Scope as a simple property.

getLocal() - Method in class org.apache.commons.workflow.base.BaseContextBean

getMethod() - Method in class org.apache.commons.workflow.core.InvokeStep

getName() - Method in class org.apache.commons.workflow.base.BaseDescriptor

Return the name of the Java object (in some scope) referenced by this Descriptor.

getName() - Method in class org.apache.commons.workflow.core.LoadStep

getName() - Method in interface org.apache.commons.workflow.Descriptor

Return the name of the Java object (in some scope) referenced by this Descriptor.

getNest() - Method in class org.apache.commons.workflow.BlockState

getNextStep() - Method in class org.apache.commons.workflow.base.BaseContext

Return the Step that will be executed the next time that execute() is called, if any.

getNextStep() - Method in class org.apache.commons.workflow.base.BaseStep

Return the next Step in our associated Activity or Block.

getNextStep() - Method in interface org.apache.commons.workflow.Context

Return the Step that will be executed the next time that execute() is called, if any.

getNextStep() - Method in interface org.apache.commons.workflow.Step

Return the next Step in our associated Activity or Block.

getOutputStream() - Method in class org.apache.commons.workflow.web.IncludeResponse23

Return a ServletOutputStream that can be used to accumulate the response data for the included resource.

getOwner() - Method in class org.apache.commons.workflow.base.BaseStep

Return the Activity or Block that owns this Step.

getOwner() - Method in interface org.apache.commons.workflow.Step

Return the Activity or Block that owns this Step.

getPage() - Method in class org.apache.commons.workflow.web.ForwardStep

getPage() - Method in class org.apache.commons.workflow.web.IncludeStep23

getPreviousStep() - Method in class org.apache.commons.workflow.base.BaseStep

Return the previous Step in our associated Activity or Block.

getPreviousStep() - Method in interface org.apache.commons.workflow.Step

Return the previous Step in our associated Activity or Block.

getRegistry() - Static method in class org.apache.commons.workflow.base.BaseRegistry

Factory method to return a Singleton (per class loader) Registry instance.

getScope(int) - Method in class org.apache.commons.workflow.base.BaseContext

Return the Scope implementation registered for the specified identifier, if any; otherwise, return null.

getScope(String) - Method in class org.apache.commons.workflow.base.BaseContext

Return the Scope implementation registered for the specified name, if any; otherwise, return null.

getScope() - Method in class org.apache.commons.workflow.base.BaseDescriptor

Return the scope of the Java object referenced by this Descriptor.

getScope(int) - Method in interface org.apache.commons.workflow.Context

Return the Scope implementation registered for the specified identifier, if any; otherwise, return null.

getScope(String) - Method in interface org.apache.commons.workflow.Context

Return the Scope implementation registered for the specified name, if any; otherwise, return null.

getScope() - Method in interface org.apache.commons.workflow.Descriptor

Return the scope of the Java object referenced by this Descriptor.

getScope() - Method in class org.apache.commons.workflow.ScopeEvent

getScopeId(String) - Method in class org.apache.commons.workflow.base.BaseContext

Return the Scope identifier registered for the specified name, if any; otherwise, return -1.

getScopeId(String) - Method in interface org.apache.commons.workflow.Context

Return the Scope identifier registered for the specified name, if any; otherwise, return null.

getServletContext() - Method in class org.apache.commons.workflow.web.ServletContextScope

getServletContext() - Method in class org.apache.commons.workflow.web.WebContext

getServletRequest() - Method in class org.apache.commons.workflow.web.ServletRequestScope

getServletRequest() - Method in class org.apache.commons.workflow.web.WebContext

getServletResponse() - Method in class org.apache.commons.workflow.web.WebContext

getStep() - Method in class org.apache.commons.workflow.ContextEvent

GetStep - Class in org.apache.commons.workflow.core

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.

GetStep() - Constructor for class org.apache.commons.workflow.core.GetStep

Construct a default instance of this Step.

GetStep(String) - Constructor for class org.apache.commons.workflow.core.GetStep

Construct an instance of this Step with the specified identifier.

GetStep(String, Descriptor) - Constructor for class org.apache.commons.workflow.core.GetStep

Construct an instance of this Step with the specified identifier and associated Descriptor.

getStep() - Method in class org.apache.commons.workflow.core.GotoStep

GetStep - Class in org.apache.commons.workflow.io

Retrieve the contents of a specified URL resource, and push the contents as a String object onto the evaluation stack.

GetStep() - Constructor for class org.apache.commons.workflow.io.GetStep

Construct a default instance of this Step.

GetStep(String) - Constructor for class org.apache.commons.workflow.io.GetStep

Construct an instance of this Step with the specified identifier.

GetStep(String, String) - Constructor for class org.apache.commons.workflow.io.GetStep

Construct a fully configured instance of this Step.

getStep() - Method in exception org.apache.commons.workflow.StepException

getStep() - Method in class org.apache.commons.workflow.web.GotoStep

getSteps() - Method in class org.apache.commons.workflow.base.BaseActivity

Return the set of Steps associated with this Activity.

getSteps() - Method in class org.apache.commons.workflow.base.BaseBlock

Return the set of Steps associated with this Block.

getSteps() - Method in interface org.apache.commons.workflow.Owner

Return the set of Steps associated with this Activity or Block.

getSuspend() - Method in class org.apache.commons.workflow.base.BaseContext

Return the suspend flag.

getSuspend() - Method in interface org.apache.commons.workflow.Context

Return the suspend flag.

getThread() - Method in class org.apache.commons.workflow.core.LoadStep

getType() - Method in class org.apache.commons.workflow.base.BaseDescriptor

Return the optional Java class expected by this Descriptor.

getType() - Method in interface org.apache.commons.workflow.Descriptor

Return the optional Java class expected by this Descriptor.

getUrl() - Method in class org.apache.commons.workflow.io.GetStep

getValue() - Method in class org.apache.commons.workflow.core.StringStep

getValue() - Method in class org.apache.commons.workflow.ScopeEvent

getValue() - Method in class org.apache.commons.workflow.util.MapEntry

getWriter() - Method in class org.apache.commons.workflow.web.IncludeResponse23

Return a PrintWriter that can be used to accumulate the response data for the included resource.

getXpath() - Method in class org.apache.commons.workflow.base.BaseDescriptor

Return the XPath expression used to access the Java object referenced by this Descriptor.

getXpath() - Method in interface org.apache.commons.workflow.Descriptor

Return the XPath expression used to access the Java object referenced by this Descriptor.

GotoStep - Class in org.apache.commons.workflow.core

Unconditionally transfer control to the specified step.

GotoStep() - Constructor for class org.apache.commons.workflow.core.GotoStep

Construct a default instance of this Step.

GotoStep(String) - Constructor for class org.apache.commons.workflow.core.GotoStep

Construct an instance of this Step with the specified identifier.

GotoStep(String, String) - Constructor for class org.apache.commons.workflow.core.GotoStep

Construct a fully configured instance of this Step.

GotoStep - Class in org.apache.commons.workflow.web

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

GotoStep() - Constructor for class org.apache.commons.workflow.web.GotoStep

Construct a default instance of this Step.

GotoStep(String) - Constructor for class org.apache.commons.workflow.web.GotoStep

Construct an instance of this Step with the specified identifier.

GotoStep(String, String) - Constructor for class org.apache.commons.workflow.web.GotoStep

Construct a fully configured instance of this Step.

H

hashCode() - Method in class org.apache.commons.workflow.base.BaseScope

Return the hash code value for this map.

hashCode() - Method in class org.apache.commons.workflow.web.HttpSessionScope

Return the hash code value for this map.

hashCode() - Method in class org.apache.commons.workflow.web.ServletContextScope

Return the hash code value for this map.

hashCode() - Method in class org.apache.commons.workflow.web.ServletRequestScope

Return the hash code value for this map.

httpSession - Variable in class org.apache.commons.workflow.web.HttpSessionScope

The HTTP session with which we are associated.

httpSession - Variable in class org.apache.commons.workflow.web.WebContext

The HttpSession that provides our associated "session" scope.

HttpSessionScope - Class in org.apache.commons.workflow.web

HttpSessionScope is a specialized Scope implementation corresponding the the attributes of a specified HttpSession.

HttpSessionScope() - Constructor for class org.apache.commons.workflow.web.HttpSessionScope

Construct a new HttpSessionScope with no attached HttpSession.

HttpSessionScope(HttpSession) - Constructor for class org.apache.commons.workflow.web.HttpSessionScope

Construct a HttpSessionScope associated with the specified HttpSession.

I

id - Variable in class org.apache.commons.workflow.base.BaseActivity

The unique identifier of this Activity.

id - Variable in class org.apache.commons.workflow.base.BaseStep

The unique identifier (within this Activity) of this Step.

IfAnyStep - Class in org.apache.commons.workflow.core

Evaluate properties specified by the associated Descriptors, and execute the nested Steps if and only if ANY of them evaluate to a positive result.

IfAnyStep() - Constructor for class org.apache.commons.workflow.core.IfAnyStep

Construct a default instance of this Step.

IfAnyStep(String) - Constructor for class org.apache.commons.workflow.core.IfAnyStep

Construct an instance of this Step with the specified identifier.

IfAnyStep(String, Descriptor) - Constructor for class org.apache.commons.workflow.core.IfAnyStep

Construct a fully configured instance of this Step.

IfNotAnyStep - Class in org.apache.commons.workflow.core

Evaluate properties specified by the associated Descriptors, and execute the nested Steps if and only if ALL of them evaluate to a negative result.

IfNotAnyStep() - Constructor for class org.apache.commons.workflow.core.IfNotAnyStep

Construct a default instance of this Step.

IfNotAnyStep(String) - Constructor for class org.apache.commons.workflow.core.IfNotAnyStep

Construct an instance of this Step with the specified identifier.

IfNotAnyStep(String, Descriptor) - Constructor for class org.apache.commons.workflow.core.IfNotAnyStep

Construct a fully configured instance of this Step.

IfNotStep - Class in org.apache.commons.workflow.core

Evaluate properties specified by the associated Descriptors, and execute the nested Steps if and only if ANY of them evaluate to a negative result.

IfNotStep() - Constructor for class org.apache.commons.workflow.core.IfNotStep

Construct a default instance of this Step.

IfNotStep(String) - Constructor for class org.apache.commons.workflow.core.IfNotStep

Construct an instance of this Step with the specified identifier.

IfNotStep(String, Descriptor) - Constructor for class org.apache.commons.workflow.core.IfNotStep

Construct a fully configured instance of this Step.

IfStep - Class in org.apache.commons.workflow.core

Evaluate properties specified by the associated Descriptors, and execute the nested Steps if and only if they ALL evaluate to a positive result.

IfStep() - Constructor for class org.apache.commons.workflow.core.IfStep

Construct a default instance of this Step.

IfStep(String) - Constructor for class org.apache.commons.workflow.core.IfStep

Construct an instance of this Step with the specified identifier.

IfStep(String, Descriptor) - Constructor for class org.apache.commons.workflow.core.IfStep

Construct a fully configured instance of this Step.

IncludeResponse23 - Class in org.apache.commons.workflow.web

Implementation of HttpServletResponseWrapper for use in IncludeStep23.

IncludeResponse23(ServletResponse) - Constructor for class org.apache.commons.workflow.web.IncludeResponse23

Construct a new response wrapper according to the specified parameters.

IncludeStep23 - Class in org.apache.commons.workflow.web

Perform a RequestDispatcher.include() operation on the specified context relative path, and push the response data (as a String onto the evaluation stack.

IncludeStep23() - Constructor for class org.apache.commons.workflow.web.IncludeStep23

Construct a default instance of this Step.

IncludeStep23(String) - Constructor for class org.apache.commons.workflow.web.IncludeStep23

Construct an instance of this Step with the specified identifier.

IncludeStep23(String, String) - Constructor for class org.apache.commons.workflow.web.IncludeStep23

Construct a fully configured instance of this Step.

init() - Method in class org.apache.commons.workflow.web.ActivityServlet

Perform a graceful startup of this servlet instance.

initial(Context) - Method in class org.apache.commons.workflow.base.BaseBlock

Process the initial entry into this Block.

initial(Context) - Method in class org.apache.commons.workflow.core.IfStep

Process the initial entry into this Block.

initial(Context) - Method in class org.apache.commons.workflow.core.WhileStep

Process the initial entry into this Block.

InvokeStep - Class in org.apache.commons.workflow.core

Call the specified method of the specified bean in the specified scope, passing arguments as specified by associated Descriptor objects.

InvokeStep() - Constructor for class org.apache.commons.workflow.core.InvokeStep

Construct a default instance of this Step.

InvokeStep(String) - Constructor for class org.apache.commons.workflow.core.InvokeStep

Construct an instance of this Step with the specified identifier.

InvokeStep(String, String) - Constructor for class org.apache.commons.workflow.core.InvokeStep

Construct a fully configured instance of this Step.

InvokeStep(String, String, Descriptor) - Constructor for class org.apache.commons.workflow.core.InvokeStep

Construct a fully configured instance of this Step.

IoRuleSet - Class in org.apache.commons.workflow.io

RuleSet for the Step definitions supported by the io library.

IoRuleSet() - Constructor for class org.apache.commons.workflow.io.IoRuleSet

Construct a default instance of the RuleSet.

isEmpty() - Method in class org.apache.commons.workflow.base.BaseContext

Is the evaluation stack currently empty?

isEmpty() - Method in class org.apache.commons.workflow.base.BaseScope

Return true if this map is empty.

isEmpty() - Method in interface org.apache.commons.workflow.Context

Is the evaluation stack currently empty?

isEmpty() - Method in class org.apache.commons.workflow.web.HttpSessionScope

Return true if this map is empty.

isEmpty() - Method in class org.apache.commons.workflow.web.ServletContextScope

Return true if this map is empty.

isEmpty() - Method in class org.apache.commons.workflow.web.ServletRequestScope

Return true if this map is empty.

isEmptyBlockState() - Method in class org.apache.commons.workflow.base.BaseContext

Is the BlockState stack currently empty?

isEmptyBlockState() - Method in interface org.apache.commons.workflow.Context

Is the BlockState stack currently empty?

isServlet23() - Method in class org.apache.commons.workflow.web.WebRuleSet

Are we executing in a Servlet 2.3 (or later) environment?

Iterator - Interface in org.apache.commons.workflow

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).

K

key - Variable in class org.apache.commons.workflow.ScopeEvent

The bean key upon which this event occurred.

key - Variable in class org.apache.commons.workflow.util.MapEntry

The key for this entry.

keySet() - Method in class org.apache.commons.workflow.base.BaseScope

Return a set view of the keys contained in this map.

keySet() - Method in class org.apache.commons.workflow.web.HttpSessionScope

Return a set view of the keys contained in this map.

keySet() - Method in class org.apache.commons.workflow.web.ServletContextScope

Return a set view of the keys contained in this map.

keySet() - Method in class org.apache.commons.workflow.web.ServletRequestScope

Return a set view of the keys contained in this map.

L

lastStep - Variable in class org.apache.commons.workflow.base.BaseActivity

The last Step associated with this Activity.

lastStep - Variable in class org.apache.commons.workflow.base.BaseBlock

The last Step associated with this Block.

listeners - Variable in class org.apache.commons.workflow.util.ContextSupport

The set of registered ContextListener event listeners.

listeners - Variable in class org.apache.commons.workflow.util.ScopeSupport

The set of registered ScopeListener event listeners.

LoadStep - Class in org.apache.commons.workflow.core

Load a class with the specified name from the specified class loader, and push the corresponding java.lang.Class object onto the evaluation stack.

LoadStep() - Constructor for class org.apache.commons.workflow.core.LoadStep

Construct a default instance of this Step.

LoadStep(String) - Constructor for class org.apache.commons.workflow.core.LoadStep

Construct an instance of this Step with the specified identifier.

LoadStep(String, String) - Constructor for class org.apache.commons.workflow.core.LoadStep

Construct a fully configured instance of this Step.

LoadStep(String, String, boolean) - Constructor for class org.apache.commons.workflow.core.LoadStep

Construct a fully configured instance of this Step.

LOCAL_SCOPE - Static variable in interface org.apache.commons.workflow.Context

The public identifier of the LOCAL scope, which is always defined by a Context implementation.

M

Main - Class in org.apache.commons.workflow.demo

Demonstration program to illustrate how the Workflow Management System is utilized.

Main() - Constructor for class org.apache.commons.workflow.demo.Main

Construct a new instance of this class to process input files.

main(String[]) - Static method in class org.apache.commons.workflow.demo.Main

The main program for the demo.

map - Variable in class org.apache.commons.workflow.base.BaseScope

The HashMap that contains our registered keys and beans.

MapEntry - Class in org.apache.commons.workflow.util

General purpose implementation of the Map.Entry interface for use in returning results from entrySet() methods on Map implementations.

MapEntry(Object, Object) - Constructor for class org.apache.commons.workflow.util.MapEntry

Construct a new MapEntry based on the specified parameters.

MAX_SCOPES - Static variable in interface org.apache.commons.workflow.Context

The maximum number of Scopes (including LOCAL_SCOPE) that can be registered.

method - Variable in class org.apache.commons.workflow.core.InvokeStep

The method name to be invoked.

N

name - Variable in class org.apache.commons.workflow.base.BaseDescriptor

The name of the Java object (in some scope).

name - Variable in class org.apache.commons.workflow.core.LoadStep

The class name to be loaded.

names - Variable in class org.apache.commons.workflow.base.BaseContext

The set of names associated with the registered Scopes.

nest - Variable in class org.apache.commons.workflow.BlockState

Should we execute the nested Steps of this Block again when the current execution finishes?

nextStep - Variable in class org.apache.commons.workflow.base.BaseContext

The Step that will be executed first the next time that execute() is called.

nextStep - Variable in class org.apache.commons.workflow.base.BaseStep

The next Step in our associated Activity.

NotAndStep - Class in org.apache.commons.workflow.core

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).

NotAndStep() - Constructor for class org.apache.commons.workflow.core.NotAndStep

Construct a default instance of this Step.

NotAndStep(String) - Constructor for class org.apache.commons.workflow.core.NotAndStep

Construct an instance of this Step with the specified identifier.

NotAndStep(String, String) - Constructor for class org.apache.commons.workflow.core.NotAndStep

Construct a fully configured instance of this Step.

NotAndStep(String, String, Descriptor) - Constructor for class org.apache.commons.workflow.core.NotAndStep

Construct a fully configured instance of this Step.

NotOrStep - Class in org.apache.commons.workflow.core

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).

NotOrStep() - Constructor for class org.apache.commons.workflow.core.NotOrStep

Construct a default instance of this Step.

NotOrStep(String) - Constructor for class org.apache.commons.workflow.core.NotOrStep

Construct an instance of this Step with the specified identifier.

NotOrStep(String, String) - Constructor for class org.apache.commons.workflow.core.NotOrStep

Construct a fully configured instance of this Step.

NotOrStep(String, String, Descriptor) - Constructor for class org.apache.commons.workflow.core.NotOrStep

Construct a fully configured instance of this Step.

O

org.apache.commons.workflow - package 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 - package org.apache.commons.workflow.base

Basic implementations and base classes for Workflow Management System applications.

org.apache.commons.workflow.core - package org.apache.commons.workflow.core

Implementations of Steps in the core library.

org.apache.commons.workflow.demo - package org.apache.commons.workflow.demo

org.apache.commons.workflow.io - package org.apache.commons.workflow.io

Implementations of Steps in the io library.

org.apache.commons.workflow.util - package org.apache.commons.workflow.util

General purpose utility classes required by the Workflow Management System.

org.apache.commons.workflow.web - package org.apache.commons.workflow.web

Implementations of Steps in the web library.

OrStep - Class in org.apache.commons.workflow.core

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).

OrStep() - Constructor for class org.apache.commons.workflow.core.OrStep

Construct a default instance of this Step.

OrStep(String) - Constructor for class org.apache.commons.workflow.core.OrStep

Construct an instance of this Step with the specified identifier.

OrStep(String, String) - Constructor for class org.apache.commons.workflow.core.OrStep

Construct a fully configured instance of this Step.

OrStep(String, String, Descriptor) - Constructor for class org.apache.commons.workflow.core.OrStep

Construct a fully configured instance of this Step.

owner - Variable in class org.apache.commons.workflow.base.BaseStep

The Activity or Block that owns this Step.

Owner - Interface in org.apache.commons.workflow

Owner represents the common characteristics of Activities and Blocks (that is, Steps that allow nested Steps, such as those that implementat conditionals and iteration).

P

page - Variable in class org.apache.commons.workflow.web.ForwardStep

The context-relative URL (starting with '/') of the resource to be forwarded to.

page - Variable in class org.apache.commons.workflow.web.IncludeStep23

The context-relative URL (starting with '/') of the resource to be retrieved.

parseCharacterEncoding(String) - Static method in class org.apache.commons.workflow.util.WorkflowUtils

Parse the character encoding from the specified content type header.

peek() - Method in class org.apache.commons.workflow.base.BaseContext

Return the top item from the evaluation stack without removing it.

peek() - Method in interface org.apache.commons.workflow.Context

Return the top item from the evaluation stack without removing it.

peekBlockState() - Method in class org.apache.commons.workflow.base.BaseContext

Return the top item from the BlockState stack without removing it.

peekBlockState() - Method in interface org.apache.commons.workflow.Context

Return the top item from the BlockState stack without removing it.

PeekStep - Class in org.apache.commons.workflow.io

Write the top value from the evaluation stack to standard output, without removing it.

PeekStep() - Constructor for class org.apache.commons.workflow.io.PeekStep

Construct a default instance of this Step.

PeekStep(String) - Constructor for class org.apache.commons.workflow.io.PeekStep

Construct an instance of this Step with the specified identifier.

pop() - Method in class org.apache.commons.workflow.base.BaseContext

Pop and return the top item from the evaluation stack.

pop() - Method in interface org.apache.commons.workflow.Context

Pop and return the top item from the evaluation stack.

popBlockState() - Method in class org.apache.commons.workflow.base.BaseContext

Pop and return the top item from the BlockState stack.

popBlockState() - Method in interface org.apache.commons.workflow.Context

Pop and return the top item from the BlockState stack.

PopStep - Class in org.apache.commons.workflow.core

Pop the top value from the evaluation stack and throw it away.

PopStep() - Constructor for class org.apache.commons.workflow.core.PopStep

Construct a default instance of this Step.

PopStep(String) - Constructor for class org.apache.commons.workflow.core.PopStep

Construct an instance of this Step with the specified identifier.

PopulateStep - Class in org.apache.commons.workflow.web

For each associated Descriptor, populate the properties of the bean specified by that descriptor from the request parameters of the current request.

PopulateStep() - Constructor for class org.apache.commons.workflow.web.PopulateStep

Construct a default instance of this Step.

PopulateStep(String) - Constructor for class org.apache.commons.workflow.web.PopulateStep

Construct an instance of this Step with the specified identifier.

PopulateStep(String, Descriptor) - Constructor for class org.apache.commons.workflow.web.PopulateStep

Construct an instance of this Step with the specified identifier and associated Descriptor.

positive(Context) - Method in class org.apache.commons.workflow.base.BaseDescriptor

Call get() to retrieve the value specified by this Descriptor, and then return true if this value represents a positive result; otherwise return false.

positive(Context) - Method in interface org.apache.commons.workflow.Descriptor

Call get() to retrieve the value specified by this Descriptor, and then return true if this value represents a positive result; otherwise return false.

previousStep - Variable in class org.apache.commons.workflow.base.BaseStep

The previous Step in our associated Activity.

process(String) - Method in class org.apache.commons.workflow.demo.Main

Process the specified file.

push(Object) - Method in class org.apache.commons.workflow.base.BaseContext

Push a new item onto the top of the evaluation stack.

push(Object) - Method in interface org.apache.commons.workflow.Context

Push a new item onto the top of the evaluation stack.

pushBlockState(BlockState) - Method in class org.apache.commons.workflow.base.BaseContext

Push a new item onto the top of the BlockState stack.

pushBlockState(BlockState) - Method in interface org.apache.commons.workflow.Context

Push a new item onto the top of the BlockState stack.

put(String, Object) - Method in class org.apache.commons.workflow.base.BaseContext

Store the specified bean under the specified key, in local scope, replacing any previous value for that key.

put(String, Object, int) - Method in class org.apache.commons.workflow.base.BaseContext

Store the specified bean under the specified key, in the specified scope, replacing any previous value for that key.

put(Context, Object) - Method in class org.apache.commons.workflow.base.BaseDescriptor

Store the value into the destination specified by this Descriptor in the specified Context, replacing any existing value.

put(Object, Object) - Method in class org.apache.commons.workflow.base.BaseScope

Add or replace the bean associated with the specified key.

put(String, Object) - Method in class org.apache.commons.workflow.base.BaseScope

Add the specified bean, associated with the specified key, to this scope and replace any previous bean associated with this key.

put(String, Object) - Method in interface org.apache.commons.workflow.Context

Store the specified bean under the specified key, in local scope, replacing any previous value for that key.

put(String, Object, int) - Method in interface org.apache.commons.workflow.Context

Store the specified bean under the specified key, in the specified scope, replacing any previous value for that key.

put(Context, Object) - Method in interface org.apache.commons.workflow.Descriptor

Store the value into the destination specified by this Descriptor in the specified Context, replacing any existing value.

put(String, Object) - Method in interface org.apache.commons.workflow.Scope

Add the specified bean, associated with the specified key, to this scope and replace any previous bean associated with this key.

put(Object, Object) - Method in class org.apache.commons.workflow.web.HttpSessionScope

Add or replace the bean associated with the specified key.

put(String, Object) - Method in class org.apache.commons.workflow.web.HttpSessionScope

Add the specified bean, associated with the specified key, to this scope and replace any previous bean associated with this key.

put(Object, Object) - Method in class org.apache.commons.workflow.web.ServletContextScope

Add or replace the bean associated with the specified key.

put(String, Object) - Method in class org.apache.commons.workflow.web.ServletContextScope

Add the specified bean, associated with the specified key, to this scope and replace any previous bean associated with this key.

put(Object, Object) - Method in class org.apache.commons.workflow.web.ServletRequestScope

Add or replace the bean associated with the specified key.

put(String, Object) - Method in class org.apache.commons.workflow.web.ServletRequestScope

Add the specified bean, associated with the specified key, to this scope and replace any previous bean associated with this key.

putAll(Map) - Method in class org.apache.commons.workflow.base.BaseScope

Copy all of the mappings from the specified map into this map, firing appropriate beanAdded() and beanReplaced() events along the way.

putAll(Map) - Method in class org.apache.commons.workflow.web.HttpSessionScope

Copy all of the mappings from the specified map into this map, firing appropriate beanAdded() and beanReplaced() events along the way.

putAll(Map) - Method in class org.apache.commons.workflow.web.ServletContextScope

Copy all of the mappings from the specified map into this map, firing appropriate beanAdded() and beanReplaced() events along the way.

putAll(Map) - Method in class org.apache.commons.workflow.web.ServletRequestScope

Copy all of the mappings from the specified map into this map, firing appropriate beanAdded() and beanReplaced() events along the way.

PutStep - Class in org.apache.commons.workflow.core

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.

PutStep() - Constructor for class org.apache.commons.workflow.core.PutStep

Construct a default instance of this Step.

PutStep(String) - Constructor for class org.apache.commons.workflow.core.PutStep

Construct an instance of this Step with the specified identifier.

PutStep(String, Descriptor) - Constructor for class org.apache.commons.workflow.core.PutStep

Construct an instance of this Step with the specified identifier and associated Descriptor.

R

ReadStep - Class in org.apache.commons.workflow.io

Read the contents of the specified file from the filesystem, and push the contents as a String object onto the evaluation stack.

ReadStep() - Constructor for class org.apache.commons.workflow.io.ReadStep

Construct a default instance of this Step.

ReadStep(String) - Constructor for class org.apache.commons.workflow.io.ReadStep

Construct an instance of this Step with the specified identifier.

ReadStep(String, String, String) - Constructor for class org.apache.commons.workflow.io.ReadStep

Construct a fully configured instance of this Step.

registry - Static variable in class org.apache.commons.workflow.base.BaseRegistry

The singleton registry instance.

Registry - Interface in org.apache.commons.workflow

A Registry is a Singleton that provides registration and lookup facilities for Activity instances.

remove(String) - Method in class org.apache.commons.workflow.base.BaseContext

Remove any existing value for the specified key, in any scope.

remove(String, int) - Method in class org.apache.commons.workflow.base.BaseContext

Remove any existing value for the specified key, from the specified scope.

remove(Context) - Method in class org.apache.commons.workflow.base.BaseDescriptor

Remove any existing value associated with this Descriptor from the specified Context.

remove(Object) - Method in class org.apache.commons.workflow.base.BaseScope

Remove the bean associated with the specified key (if any), and return the old value if removed.

remove(String) - Method in class org.apache.commons.workflow.base.BaseScope

Remove the bean associated with the specified key (if any).

remove(String) - Method in interface org.apache.commons.workflow.Context

Remove any existing value for the specified key, in any scope.

remove(String, int) - Method in interface org.apache.commons.workflow.Context

Remove any existing value for the specified key, from the specified scope.

remove(Context) - Method in interface org.apache.commons.workflow.Descriptor

Remove any existing value associated with this Descriptor from the specified Context.

remove(String) - Method in interface org.apache.commons.workflow.Scope

Remove the bean associated with the specified key (if any).

remove(Object) - Method in class org.apache.commons.workflow.web.HttpSessionScope

Remove the bean associated with the specified key (if any), and return the old value if removed.

remove(String) - Method in class org.apache.commons.workflow.web.HttpSessionScope

Remove the bean associated with the specified key (if any).

remove(Object) - Method in class org.apache.commons.workflow.web.ServletContextScope

Remove the bean associated with the specified key (if any), and return the old value if removed.

remove(String) - Method in class org.apache.commons.workflow.web.ServletContextScope

Remove the bean associated with the specified key (if any).

remove(Object) - Method in class org.apache.commons.workflow.web.ServletRequestScope

Remove the bean associated with the specified key (if any), and return the old value if removed.

remove(String) - Method in class org.apache.commons.workflow.web.ServletRequestScope

Remove the bean associated with the specified key (if any).

removeActivity(Activity) - Method in class org.apache.commons.workflow.base.BaseRegistry

Remove the specified Activity from this Registry.

removeActivity(Activity) - Method in interface org.apache.commons.workflow.Registry

Remove the specified Activity from this Registry.

removeContextListener(ContextListener) - Method in class org.apache.commons.workflow.base.BaseContext

Remove a listener that is notified each time beans are added, replaced, or removed in this context.

removeContextListener(ContextListener) - Method in interface org.apache.commons.workflow.Context

Remove a listener that is notified each time beans are added, replaced, or removed in this context.

removeContextListener(ContextListener) - Method in class org.apache.commons.workflow.util.ContextSupport

Remove a listener that is notified each time beans are added, replaced, or removed in this context.

removeDescriptor(Descriptor) - Method in class org.apache.commons.workflow.base.DescriptorStep

Remove an existing Descriptor from the set associated with this object.

removeDescriptor(Descriptor) - Method in interface org.apache.commons.workflow.Descriptors

Remove an existing Descriptor from the set associated with this object.

removeScopeListener(ScopeListener) - Method in class org.apache.commons.workflow.base.BaseScope

Remove a listener that is notified each time beans are added, replaced, or removed in this scope.

removeScopeListener(ScopeListener) - Method in interface org.apache.commons.workflow.Scope

Remove a listener that is notified each time beans are added, replaced, or removed in this scope.

removeScopeListener(ScopeListener) - Method in class org.apache.commons.workflow.util.ScopeSupport

Remove a listener that is notified each time beans are added, replaced, or removed in this scope.

RemoveStep - Class in org.apache.commons.workflow.core

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

RemoveStep() - Constructor for class org.apache.commons.workflow.core.RemoveStep

Construct a default instance of this Step.

RemoveStep(String) - Constructor for class org.apache.commons.workflow.core.RemoveStep

Construct an instance of this Step with the specified identifier.

RemoveStep(String, Descriptor) - Constructor for class org.apache.commons.workflow.core.RemoveStep

Construct an instance of this Step with the specified identifier and associated Descriptor.

REQUEST_SCOPE - Static variable in class org.apache.commons.workflow.web.WebContext

The scope identifier for the scope associated with the current servlet request.

REQUEST_SCOPE_NAME - Static variable in class org.apache.commons.workflow.web.WebContext

The scope name for the scope associated with the current servlet request.

reset() - Method in class org.apache.commons.workflow.web.DemoBean

reset() - Method in class org.apache.commons.workflow.web.IncludeResponse23

Reset the response buffer and all headers.

resetBuffer() - Method in class org.apache.commons.workflow.web.IncludeResponse23

Reset the response buffer to contain no data.

S

scope - Variable in class org.apache.commons.workflow.base.BaseDescriptor

The scope of the Java object.

Scope - Interface in org.apache.commons.workflow

A Scope is a collection of arbitrary Java objects, keyed by String-valued names.

scope - Variable in class org.apache.commons.workflow.ScopeEvent

The Scope upon which this event occurred.

scope - Variable in class org.apache.commons.workflow.util.ScopeSupport

The Scope for whom we will fire events.

scopeCleared(ScopeEvent) - Method in interface org.apache.commons.workflow.ScopeListener

Invoked when the entire Scope is cleared.

ScopeEvent - Class in org.apache.commons.workflow

A ScopeEvent provides notification to a ScopeListener that a specified event has occurred for the specified scope.

ScopeEvent(Scope, String, Object) - Constructor for class org.apache.commons.workflow.ScopeEvent

Construct a new immutable ScopeEvent.

ScopeListener - Interface in org.apache.commons.workflow

A ScopeListener registers its interest in receiving ScopeEvent notifications when the occur on a particular Scope of interest.

scopes - Variable in class org.apache.commons.workflow.base.BaseContext

The set of Scopes that have been associated with this Context.

ScopeSupport - Class in org.apache.commons.workflow.util

ScopeSupport is a convenience class for managing the firing of ScopeEvents to registered ScopeListeners.

ScopeSupport(Scope) - Constructor for class org.apache.commons.workflow.util.ScopeSupport

Construct a new ScopeSupport object associated with the specified Scope.

servletContext - Variable in class org.apache.commons.workflow.web.ServletContextScope

The servlet context with which we are associated.

servletContext - Variable in class org.apache.commons.workflow.web.WebContext

The ServletContext that provides our associated "application" scope.

ServletContextScope - Class in org.apache.commons.workflow.web

ServletContextScope is a specialized Scope implementation corresponding the the attributes of a specified ServletContext.

ServletContextScope() - Constructor for class org.apache.commons.workflow.web.ServletContextScope

Construct a new ServletContextScope with no attached ServletContext.

ServletContextScope(ServletContext) - Constructor for class org.apache.commons.workflow.web.ServletContextScope

Construct a ServletContextScope associated with the specified ServletContext.

servletRequest - Variable in class org.apache.commons.workflow.web.ServletRequestScope

The servlet request with which we are associated.

servletRequest - Variable in class org.apache.commons.workflow.web.WebContext

The ServletRequest that provides our associated "request" scope.

ServletRequestScope - Class in org.apache.commons.workflow.web

ServletRequestScope is a specialized Scope implementation corresponding the the attributes of a specified ServletRequest.

ServletRequestScope() - Constructor for class org.apache.commons.workflow.web.ServletRequestScope

Construct a new ServletRequestScope with no attached ServletRequest.

ServletRequestScope(ServletRequest) - Constructor for class org.apache.commons.workflow.web.ServletRequestScope

Construct a ServletRequestScope associated with the specified ServletRequest.

servletResponse - Variable in class org.apache.commons.workflow.web.WebContext

The ServletResponse we should pass on to any request dispatcher delegations.

SESSION_SCOPE - Static variable in class org.apache.commons.workflow.web.WebContext

The scope identifier for the scope associated with the current HTTP session.

SESSION_SCOPE_NAME - Static variable in class org.apache.commons.workflow.web.WebContext

The scope name for the scope associated with the current HTTP session.

setActivity(Activity) - Method in class org.apache.commons.workflow.base.BaseContext

Set the Activity to be executed, and make the first defined Step within this Activity the next action to be performed by execute().

setActivity(Activity) - Method in interface org.apache.commons.workflow.Context

Set the Activity to be executed, and make the first defined Step within this Activity the next action to be performed by execute().

setActivity(Activity) - Method in class org.apache.commons.workflow.demo.Main

Save the Activity that our Digester has constructed.

setActivity(Activity) - Method in class org.apache.commons.workflow.web.ActivityServlet

Set the Activity associated with this instance.

setContentType(String) - Method in class org.apache.commons.workflow.web.IncludeResponse23

Set the content type (and possibly the character encoding) of the response data.

setEncoding(String) - Method in class org.apache.commons.workflow.io.ReadStep

setEncoding(String) - Method in class org.apache.commons.workflow.io.WriteStep

setFavoriteCar(String) - Method in class org.apache.commons.workflow.web.DemoBean

setFavoriteCity(String) - Method in class org.apache.commons.workflow.web.DemoBean

setFavoriteSport(String) - Method in class org.apache.commons.workflow.web.DemoBean

setFavoriteTeam(String) - Method in class org.apache.commons.workflow.web.DemoBean

setFile(String) - Method in class org.apache.commons.workflow.io.ReadStep

setFile(String) - Method in class org.apache.commons.workflow.io.WriteStep

setFirstName(String) - Method in class org.apache.commons.workflow.web.DemoBean

setHttpSession(HttpSession) - Method in class org.apache.commons.workflow.web.HttpSessionScope

setHttpSession(HttpSession) - Method in class org.apache.commons.workflow.web.WebContext

setId(String) - Method in interface org.apache.commons.workflow.Activity

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

setId(String) - Method in class org.apache.commons.workflow.base.BaseActivity

Set the unique identifier of this Activity.

setId(String) - Method in class org.apache.commons.workflow.base.BaseStep

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

setId(String) - Method in interface org.apache.commons.workflow.Step

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

setKey(Object) - Method in class org.apache.commons.workflow.util.MapEntry

setLastName(String) - Method in class org.apache.commons.workflow.web.DemoBean

setMethod(String) - Method in class org.apache.commons.workflow.core.InvokeStep

setName(String) - Method in class org.apache.commons.workflow.base.BaseDescriptor

Set the name of the Java object (in some scope) referenced by this Descriptor.

setName(String) - Method in class org.apache.commons.workflow.core.LoadStep

setName(String) - Method in interface org.apache.commons.workflow.Descriptor

Set the name of the Java object (in some scope) referenced by this Descriptor.

setNamespaceURI(String) - Method in class org.apache.commons.workflow.base.BaseRuleSet

Set the namespace URI that these rules apply to.

setNest(boolean) - Method in class org.apache.commons.workflow.BlockState

setNextStep(Step) - Method in class org.apache.commons.workflow.base.BaseContext

Set the Step that will be executed the next time that execute() is called.

setNextStep(Step) - Method in class org.apache.commons.workflow.base.BaseStep

Set the next Step in our associated Activity or Block.

setNextStep(Step) - Method in interface org.apache.commons.workflow.Context

Set the Step that will be executed the next time that execute() is called.

setNextStep(Step) - Method in interface org.apache.commons.workflow.Step

Set the next Step in our associated Activity or Block.

setOwner(Owner) - Method in class org.apache.commons.workflow.base.BaseStep

Set the Activity or Block that owns this Step.

setOwner(Owner) - Method in interface org.apache.commons.workflow.Step

Set the Activity or Block that owns this Step.

setPage(String) - Method in class org.apache.commons.workflow.web.ForwardStep

setPage(String) - Method in class org.apache.commons.workflow.web.IncludeStep23

setPreviousStep(Step) - Method in class org.apache.commons.workflow.base.BaseStep

Set the previous Step in our associated Activity or Block.

setPreviousStep(Step) - Method in interface org.apache.commons.workflow.Step

Set the previous Step in our associated Activity or Block.

setScope(String) - Method in class org.apache.commons.workflow.base.BaseDescriptor

Set the scope of the Java object referenced by this Descriptor.

setScope(String) - Method in interface org.apache.commons.workflow.Descriptor

Set the scope of the Java object referenced by this Descriptor.

setServletContext(ServletContext) - Method in class org.apache.commons.workflow.web.ServletContextScope

setServletContext(ServletContext) - Method in class org.apache.commons.workflow.web.WebContext

setServletRequest(ServletRequest) - Method in class org.apache.commons.workflow.web.ServletRequestScope

setServletRequest(ServletRequest) - Method in class org.apache.commons.workflow.web.WebContext

setServletResponse(ServletResponse) - Method in class org.apache.commons.workflow.web.WebContext

setStep(String) - Method in class org.apache.commons.workflow.core.GotoStep

setStep(String) - Method in class org.apache.commons.workflow.web.GotoStep

setSteps(Step[]) - Method in class org.apache.commons.workflow.base.BaseActivity

Set the set of Steps associated with this Activity, replacing any existing ones.

setSteps(Step[]) - Method in class org.apache.commons.workflow.base.BaseBlock

Set the set of Steps associated with this Block, replacing any existing ones.

setSteps(Step[]) - Method in interface org.apache.commons.workflow.Owner

Set the set of Steps associated with this Activity or Block, replacing any existing ones.

setSuspend(boolean) - Method in class org.apache.commons.workflow.base.BaseContext

Set the suspend flag.

setSuspend(boolean) - Method in interface org.apache.commons.workflow.Context

Set the suspend flag.

setThread(boolean) - Method in class org.apache.commons.workflow.core.LoadStep

setType(Class) - Method in class org.apache.commons.workflow.base.BaseDescriptor

Set the optional Java class expected by this Descriptor.

setType(Class) - Method in interface org.apache.commons.workflow.Descriptor

Set the optional Java class expected by this Descriptor.

setUrl(String) - Method in class org.apache.commons.workflow.io.GetStep

setValue(String) - Method in class org.apache.commons.workflow.core.StringStep

setValue(Object) - Method in class org.apache.commons.workflow.util.MapEntry

setXpath(String) - Method in class org.apache.commons.workflow.base.BaseDescriptor

Set the XPath expression used to access the Java object referenced by this Descriptor.

setXpath(String) - Method in interface org.apache.commons.workflow.Descriptor

Set the XPath expression used to access the Java object referenced by this Descriptor.

signature(String, Class[]) - Method in class org.apache.commons.workflow.core.ConstructStep

Return a method signature useful in debugging and exception messages.

signature(String, Class[]) - Method in class org.apache.commons.workflow.core.InvokeStep

Return a method signature useful in debugging and exception messages.

size() - Method in class org.apache.commons.workflow.base.BaseScope

Return the number of key-value mappings in this map.

size() - Method in class org.apache.commons.workflow.web.HttpSessionScope

Return the number of key-value mappings in this map.

size() - Method in class org.apache.commons.workflow.web.ServletContextScope

Return the number of key-value mappings in this map.

size() - Method in class org.apache.commons.workflow.web.ServletRequestScope

Return the number of key-value mappings in this map.

stack - Variable in class org.apache.commons.workflow.base.BaseContext

The evaluation stack of nameless objects being processed.

state(Context) - Method in class org.apache.commons.workflow.base.BaseBlock

Peek at the top BlockState element on the stack maintained by our Context, and return it.

state - Variable in class org.apache.commons.workflow.base.BaseContext

The BlockState stack of BlockState objects used to manage iteration.

step - Variable in class org.apache.commons.workflow.ContextEvent

The Step upon which this event occurred.

step - Variable in class org.apache.commons.workflow.core.GotoStep

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

Step - Interface in org.apache.commons.workflow

A Step represents a single executable action that can occur during the completion of an Activity.

step - Variable in exception org.apache.commons.workflow.StepException

The Step that was being executed when the problem occurred.

step - Variable in class org.apache.commons.workflow.web.GotoStep

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

StepException - Exception in org.apache.commons.workflow

A StepException is used to report problems encountered during the dynamic execution of a specific Step.

StepException() - Constructor for exception org.apache.commons.workflow.StepException

Construct an empty StepException.

StepException(Step) - Constructor for exception org.apache.commons.workflow.StepException

Construct an empty StepException occurring with the specified Step.

StepException(String) - Constructor for exception org.apache.commons.workflow.StepException

Construct a StepException with the specified message.

StepException(String, Step) - Constructor for exception org.apache.commons.workflow.StepException

Construct a StepException with the specified message occurring with the specified Step.

StepException(Throwable) - Constructor for exception org.apache.commons.workflow.StepException

Construct a StepException with the specified underlying cause.

StepException(Throwable, Step) - Constructor for exception org.apache.commons.workflow.StepException

Construct a StepException with the specified underlying cause, occurring in the specified Step.

StepException(String, Throwable) - Constructor for exception org.apache.commons.workflow.StepException

Construct a StepException with the specified message and underlying cause.

StepException(String, Throwable, Step) - Constructor for exception org.apache.commons.workflow.StepException

Construct a StepException with the specified message and underlying cause, occurring in the specified Step.

StringStep - Class in org.apache.commons.workflow.core

Push the specified String value onto the top of the evaluation stack.

StringStep() - Constructor for class org.apache.commons.workflow.core.StringStep

Construct a default instance of this Step.

StringStep(String) - Constructor for class org.apache.commons.workflow.core.StringStep

Construct an instance of this Step with the specified identifier.

StringStep(String, String) - Constructor for class org.apache.commons.workflow.core.StringStep

Construct a fully configured instance of this Step.

subsequent(Context, BlockState) - Method in class org.apache.commons.workflow.base.BaseBlock

Process the return from nested execution of the Steps associated with this Block.

subsequent(Context, BlockState) - Method in class org.apache.commons.workflow.core.WhileStep

Process the return from nested execution of the Steps assocaited with this Block.

support - Variable in class org.apache.commons.workflow.base.BaseContext

The event listener support object for this Context.

support - Variable in class org.apache.commons.workflow.base.BaseScope

The event listener support object for this Scope.

suspend - Variable in class org.apache.commons.workflow.base.BaseContext

The suspension flag.

SuspendStep - Class in org.apache.commons.workflow.core

Signal our Context to suspend execution until control is returned.

SuspendStep() - Constructor for class org.apache.commons.workflow.core.SuspendStep

Construct a default instance of this Step.

SuspendStep(String) - Constructor for class org.apache.commons.workflow.core.SuspendStep

Construct an instance of this Step with the specified identifier.

SwapStep - Class in org.apache.commons.workflow.core

Swap the positions of the top two values on the evaluation stack.

SwapStep() - Constructor for class org.apache.commons.workflow.core.SwapStep

Construct a default instance of this Step.

SwapStep(String) - Constructor for class org.apache.commons.workflow.core.SwapStep

Construct an instance of this Step with the specified identifier.

T

thread - Variable in class org.apache.commons.workflow.core.LoadStep

Load from the thread context class loader?

toString() - Method in class org.apache.commons.workflow.base.BaseDescriptor

Render a printable version of this object.

toString() - Method in class org.apache.commons.workflow.BlockState

Render a String version of this object.

toString() - Method in class org.apache.commons.workflow.core.BreakStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.core.ConstructStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.core.ContinueStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.core.GotoStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.core.IfAnyStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.core.IfNotAnyStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.core.IfNotStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.core.IfStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.core.InvokeStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.core.LoadStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.core.StringStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.core.WhileAnyStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.core.WhileNotAnyStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.core.WhileNotStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.core.WhileStep

Render a string representation of this Step.

toString() - Method in exception org.apache.commons.workflow.StepException

Render a printable version of this exception.

toString() - Method in class org.apache.commons.workflow.web.ForwardStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.web.GotoStep

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.web.IncludeStep23

Render a string representation of this Step.

toString() - Method in class org.apache.commons.workflow.web.PopulateStep

Render a string representation of this Step.

type - Variable in class org.apache.commons.workflow.base.BaseDescriptor

The optional Java class expected by this Descriptor.

U

url - Variable in class org.apache.commons.workflow.io.GetStep

The URL of the resource to be retrieved.

V

value - Variable in class org.apache.commons.workflow.core.StringStep

The string value to be pushed.

value - Variable in class org.apache.commons.workflow.ScopeEvent

The bean value upon which this event occurred.

value - Variable in class org.apache.commons.workflow.util.MapEntry

The value for for this entry.

values() - Method in class org.apache.commons.workflow.base.BaseScope

Return a Collection view of the values contained in this map.

values() - Method in class org.apache.commons.workflow.web.HttpSessionScope

Return a Collection view of the values contained in this map.

values() - Method in class org.apache.commons.workflow.web.ServletContextScope

Return a Collection view of the values contained in this map.

values() - Method in class org.apache.commons.workflow.web.ServletRequestScope

Return a Collection view of the values contained in this map.

W

WebContext - Class in org.apache.commons.workflow.web

WebContext is a specialized Context implementation appropriate for web applications that run on top of a Servlet 2.2 (or later) container.

WebContext() - Constructor for class org.apache.commons.workflow.web.WebContext

WebRuleSet - Class in org.apache.commons.workflow.web

RuleSet for the Step definitions supported by the web library.

WebRuleSet() - Constructor for class org.apache.commons.workflow.web.WebRuleSet

Construct a default instance of the RuleSet.

WhileAnyStep - Class in org.apache.commons.workflow.core

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.

WhileAnyStep() - Constructor for class org.apache.commons.workflow.core.WhileAnyStep

Construct a default instance of this Step.

WhileAnyStep(String) - Constructor for class org.apache.commons.workflow.core.WhileAnyStep

Construct an instance of this Step with the specified identifier.

WhileAnyStep(String, Descriptor) - Constructor for class org.apache.commons.workflow.core.WhileAnyStep

Construct a fully configured instance of this Step.

WhileNotAnyStep - Class in org.apache.commons.workflow.core

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.

WhileNotAnyStep() - Constructor for class org.apache.commons.workflow.core.WhileNotAnyStep

Construct a default instance of this Step.

WhileNotAnyStep(String) - Constructor for class org.apache.commons.workflow.core.WhileNotAnyStep

Construct an instance of this Step with the specified identifier.

WhileNotAnyStep(String, Descriptor) - Constructor for class org.apache.commons.workflow.core.WhileNotAnyStep

Construct a fully configured instance of this Step.

WhileNotStep - Class in org.apache.commons.workflow.core

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.

WhileNotStep() - Constructor for class org.apache.commons.workflow.core.WhileNotStep

Construct a default instance of this Step.

WhileNotStep(String) - Constructor for class org.apache.commons.workflow.core.WhileNotStep

Construct an instance of this Step with the specified identifier.

WhileNotStep(String, Descriptor) - Constructor for class org.apache.commons.workflow.core.WhileNotStep

Construct a fully configured instance of this Step.

WhileStep - Class in org.apache.commons.workflow.core

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.

WhileStep() - Constructor for class org.apache.commons.workflow.core.WhileStep

Construct a default instance of this Step.

WhileStep(String) - Constructor for class org.apache.commons.workflow.core.WhileStep

Construct an instance of this Step with the specified identifier.

WhileStep(String, Descriptor) - Constructor for class org.apache.commons.workflow.core.WhileStep

Construct a fully configured instance of this Step.

WorkflowException - Exception in org.apache.commons.workflow

A WorkflowException is the base class for exceptions related to the workflow engine framework.

WorkflowException() - Constructor for exception org.apache.commons.workflow.WorkflowException

Construct an empty WorkflowException.

WorkflowException(String) - Constructor for exception org.apache.commons.workflow.WorkflowException

Construct a WorkflowException with the specified message.

WorkflowException(Throwable) - Constructor for exception org.apache.commons.workflow.WorkflowException

Construct a WorkflowException with the specified underlying cause.

WorkflowException(String, Throwable) - Constructor for exception org.apache.commons.workflow.WorkflowException

Construct a WorkflowException with the specified message and underlying cause.

WorkflowUtils - Class in org.apache.commons.workflow.util

General purpose static utility methods for the Workflow engine.

WorkflowUtils() - Constructor for class org.apache.commons.workflow.util.WorkflowUtils

WriteStep - Class in org.apache.commons.workflow.io

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).

WriteStep() - Constructor for class org.apache.commons.workflow.io.WriteStep

Construct a default instance of this Step.

WriteStep(String) - Constructor for class org.apache.commons.workflow.io.WriteStep

Construct an instance of this Step with the specified identifier.

WriteStep(String, String, String) - Constructor for class org.apache.commons.workflow.io.WriteStep

Construct a fully configured instance of this Step.

X

xpath - Variable in class org.apache.commons.workflow.base.BaseDescriptor

The XPath expression used to access the Java object.

A B C D E F G H I K L M N O P R S T U V W X