au.com.whitesquare.waf.command
Interface BaseCommand

All Known Implementing Classes:

ValidatedCommand

public interface BaseCommand

The Base interface of the code Command component. Each command is a logical action of work. Each page is usually generated by one command, and each command usually generates only one page.
Last Modified $Date: 2004/11/17 12:11:59 $

Version:

$Revision: 1.5 $

Author:

Steve Mactaggart

Method Summary

Response	execute(WAFRequest params) This is the method that is called to execute the actual work for the command.
boolean	isSessionRequired() Determines if the user should be re-directed to the index page if they are a new session.

Method Detail

isSessionRequired

public boolean isSessionRequired()

Determines if the user should be re-directed to the index page if they are a new session. Allows the developer to define a command as part of a process that must be traversed inside a session.

Returns:

whether the command must be executed inside a session or not.

execute

public Response execute(WAFRequest params)

This is the method that is called to execute the actual work for the command. This method is implemented with the ability to interact with the request and session (via the WAFRequest object) and the response, by returning a sub-class of Response.

Parameters:

params - is the WAFRequest object that contains all of the request information parsed into the standard WAF format.

Returns:

a sub-class of Response which will direct the Controller Servlet on how to manage the response.