org.josef.web.jsf.flow

Class AbstractFlowStep

java.lang.Object

org.josef.web.jsf.flow.AbstractFlowStep

Direct Known Subclasses:

AbstractFlow, AbstractGuiFlowStep

public abstract class AbstractFlowStep
extends Object

Abstraction of a single step that is part of a flow.
By default this step has no corresponding GUI part. It could do its work for example by calling a web service. See AbstractGuiFlowStep for the GUI counterpart of this step.

Version:

1.0 $Revision: 5791 $

Author:

Kees Schotanus

Constructor Summary

Constructors

Constructor and Description
AbstractFlowStep() No argument constructor to make this step a Java Bean.
AbstractFlowStep(String name) Creates this step from the supplied name.

Method Summary

Modifier and Type	Method and Description
void	back() Goes back to the previous step.
void	finish() Finishes this step (and continues with the next).
Object	getInputOutputParameter(String key) Gets the input/output parameter with the supplied key.
String	getName() Gets the name of this step.
AbstractFlow	getParentFlow() Gets the parent flow of this step.
AbstractFlow	getRootFlow() Gets the root flow of this step.
boolean	isStartable() Determines whether this step is startable or not.
boolean	isUserStartable() Determines whether this step is startable by the user or not.
boolean	isVisible() Determines whether this step is visible or not.
Object	putInputOutputParameter(String key, Object inputOutputParameter) Puts the supplied inputOutputParameter in the map of input/output parameters under the supplied key.
void	setStartable(boolean startable) Sets this step to be startable or not.
void	setUserStartable(boolean userStartable) Sets this step to be startable by the user or not.
void	setVisible(boolean visible) Sets this step to visible or invisible.
abstract void	start() Starts this step.
String	toString() Creates a String representation of this AbstractFlowStep.

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractFlowStep

public AbstractFlowStep()

No argument constructor to make this step a Java Bean.

AbstractFlowStep

public AbstractFlowStep(String name)

Creates this step from the supplied name.

Parameters:

name - The name of this step.

Method Detail

getName

public String getName()

Gets the name of this step.

Returns:

The name of this step.

getParentFlow

public AbstractFlow getParentFlow()

Gets the parent flow of this step.

Returns:

The parent flow of this step.

getRootFlow

public AbstractFlow getRootFlow()

Gets the root flow of this step.

Returns:

The root flow of this step.

isVisible

public boolean isVisible()

Determines whether this step is visible or not.

Returns:

True when visible, false when invisible.

setVisible

public void setVisible(boolean visible)

Sets this step to visible or invisible.

Parameters:

visible - Supply true to make this step visible, false to make it invisible.

isStartable

public boolean isStartable()

Determines whether this step is startable or not.

Returns:

True when startable, false when this step can not be started.

setStartable

public void setStartable(boolean startable)

Sets this step to be startable or not.

Parameters:

startable - Supply true to make this step startable, false to make it unstartable.

isUserStartable

public boolean isUserStartable()

Determines whether this step is startable by the user or not.

Returns:

True when the user can start this step, false when she can't.

setUserStartable

public void setUserStartable(boolean userStartable)

Sets this step to be startable by the user or not.

Parameters:

userStartable - Supply true to make this step startable by the user, false so the user can't start this step.

getInputOutputParameter

public Object getInputOutputParameter(String key)

Gets the input/output parameter with the supplied key.

Parameters:

key - The key of the input/output parameter.

Returns:

The input/output parameter with the supplied key or null when no input/output parameter with the supplied key exists.

putInputOutputParameter

public Object putInputOutputParameter(String key,
                                      Object inputOutputParameter)

Puts the supplied inputOutputParameter in the map of input/output parameters under the supplied key.

Parameters:

key - The key of the input/output parameter.

inputOutputParameter - The input/output parameter.

Returns:

The object previously stored under the supplied key or null when no key was previously stored or the key was stored but its value was null.

start

public abstract void start()

Starts this step.

back

public void back()

Goes back to the previous step.

finish

public void finish()

Finishes this step (and continues with the next).

toString

public String toString()

Creates a String representation of this AbstractFlowStep.

Overrides:

toString in class Object

Returns:

A String representation of this AbstractFlowStep.