hirondelle.fish.help
Class ShowHelpAction

Object
  hirondelle.fish.help.ShowHelpAction

All Implemented Interfaces:

Action

public final class ShowHelpAction
extends Object
implements Action

Toggle the display of help text, and redirect back to the original URI.

This class interacts with ShowHelpTag by placing an item in session scope, using a ShowHelpTag.KEY defined by that class.

The original URI is taken from a request parameter named 'OriginalURI', whose value in turn comes from an item named Controller.CURRENT_URI, placed in request scope by the Controller.

Field Summary

static RequestParameter

ORIGINAL_URI

Constructor Summary

ShowHelpAction(RequestParser aRequestParser)
Constructor.

Method Summary

ResponsePage

execute() Toggle the display of help text, and redirect back to original request.

Methods inherited from class Object

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

Field Detail

ORIGINAL_URI

public static final RequestParameter ORIGINAL_URI

Constructor Detail

ShowHelpAction

public ShowHelpAction(RequestParser aRequestParser)

Constructor.

Method Detail

execute

public ResponsePage execute()
                     throws AppException

Toggle the display of help text, and redirect back to original request.

Toggles the value of a Boolean item in session scoped, identified by ShowHelpTag.KEY.

Specified by:

execute in interface Action

Throws:

AppException