com.sri.emo.wizard.selection.management
Class StepDefinition

java.lang.Object
  com.sri.emo.wizard.selection.management.AbstractStepHandler
      com.sri.emo.wizard.selection.management.StepDefinition

All Implemented Interfaces:

StateHandler

public abstract class StepDefinition
extends AbstractStepHandler
implements StateHandler

Base class for step definitions. This is the final step in defining a wizard step and it takes Title, Directive, and Helptext as a minimum for data entry.

Author:

Michael Rimov

Field Summary

static String	PARAM_DIRECTIVE_ID The parameter name of the directive parameter.
static String	PARAM_HELPTEXT_ID The parameter name of the helptext parameter.
static String	PARAM_NAME_ID The parameter name of the title parameter.

Fields inherited from class com.sri.emo.wizard.selection.management.AbstractStepHandler

ADD_MODE, ATTRIBUTE_SESSION_KEY, EDIT_MODE, PARAM_RETURN_URL

Constructor Summary

StepDefinition(String wizId, String stepId)
Default Constructor.

Method Summary

protected WizStep	getStep() Retrieve the current step.
void	handleRequest(ExpressoRequest request, ExpressoResponse response) Base class parses some parameters and loads the step definition based on that.

Methods inherited from class com.sri.emo.wizard.selection.management.AbstractStepHandler

buildCancelTransition, getDefinition, getStepFromParameters, getStepName, getStepTitle, getWizardTitle, isEditing, parseStepAttributes, setEditing, transitionOnError

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_NAME_ID

public static final String PARAM_NAME_ID

The parameter name of the title parameter.

See Also:

Constant Field Values

PARAM_DIRECTIVE_ID

public static final String PARAM_DIRECTIVE_ID

The parameter name of the directive parameter.

See Also:

Constant Field Values

PARAM_HELPTEXT_ID

public static final String PARAM_HELPTEXT_ID

The parameter name of the helptext parameter.

See Also:

Constant Field Values

Constructor Detail

StepDefinition

public StepDefinition(String wizId,
                      String stepId)
               throws DBException

Default Constructor.

Parameters:

wizId - the Wizard id we're working with.

stepId - the Step Id we're working with. (May be null for no step)

Throws:

DBException - upon DBObject construction/retrieval error.

Method Detail

handleRequest

public void handleRequest(ExpressoRequest request,
                          ExpressoResponse response)
                   throws DBException,
                          ControllerException

Base class parses some parameters and loads the step definition based on that.

Specified by:

handleRequest in interface StateHandler

Parameters:

request - ControllerRequest

response - ControllerResponse

Throws:

DBException - upon database error.

ControllerException - upon controller error.

getStep

protected WizStep getStep()

Retrieve the current step. Returns null if none is defined (which is fine for 'add' situations)

Overrides:

getStep in class AbstractStepHandler

Returns:

WizStep