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

java.lang.Object
  com.sri.emo.wizard.selection.management.AbstractStepHandler
      com.sri.emo.wizard.selection.management.EditFinalState
          com.sri.emo.wizard.selection.management.PromptInstructions

All Implemented Interfaces:

StateHandler

public class PromptInstructions
extends EditFinalState
implements StateHandler

State that prompts for instructions.

Author:

Michael Rimov

Field Summary

static String	PARAM_INPUT_ID Id of the input parameter on the form.
static String	STATE_DESCRIPTION Constant for description of this state.
static String	STATE_NAME Constant for access to this state.

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

ATTRIBUTE_SESSION_KEY, PARAM_DIRECTIVE, PARAM_HELPTEXT, PARAM_TITLE, REQUEST_ATTRIBUTES, TRANSITION_EDIT, TRANSITION_SAVE

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

ADD_MODE, EDIT_MODE, PARAM_RETURN_URL

Constructor Summary

PromptInstructions(String wizId, String stepId)
Default constructor.

Method Summary

void	handleRequest(ExpressoRequest request, ExpressoResponse response) Prompts for any instructions.

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

addStepTypeLabel, buildAndStoreStepAttributes, buildEditTypeTransition, buildSaveAndReturnTransition, isNeedTransitionOnError, renderCommonControls

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

buildCancelTransition, getDefinition, getStep, 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_INPUT_ID

public static final String PARAM_INPUT_ID

Id of the input parameter on the form.

See Also:

Constant Field Values

STATE_NAME

public static final String STATE_NAME

Constant for access to this state.

See Also:

Constant Field Values

STATE_DESCRIPTION

public static final String STATE_DESCRIPTION

Constant for description of this state.

See Also:

Constant Field Values

Constructor Detail

PromptInstructions

public PromptInstructions(String wizId,
                          String stepId)
                   throws DBException

Default constructor.

Parameters:

wizId - The wizard ID.

stepId - The step ID which may be null if we are dealing with a new step.

Throws:

DBException - Upon database exception.

Method Detail

handleRequest

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

Prompts for any instructions. There are no additional types - per se

Called to handle the request. Here's an example of the usage within an Expresso Controller state handler. It is assumed that the class MyHandler implements the StateHandler interface.

 protected void runMyState(final ControllerRequest request,
        final ControllerResponse response) throws ControllerException, DBException {
 

     MyHander handler = new MyHandler();
     handler.handleRequest(request,response);
 }
 

Specified by:

handleRequest in interface StateHandler

Parameters:

request - ExpressoRequest The Function's ExpressoRequest object.

response - ExpressoResponse The Function's ExpressoResponse object.

Throws:

DBException - upon underlying database exception error.

ControllerException - upon underlying ControllerException error.