com.sas.servlet.util
Interface CommandProcessorInterface

All Known Implementing Classes:

CommandProcessor

Deprecated. As of Version 3.0 this class has been replaced by com.sas.servlet.util.commandprocessor.CommandProcessorInterface.

public interface CommandProcessorInterface

Method Summary

abstract boolean	addStoredCommand(CommandProcessorViewInterface viewer, CommandProcessorCommandInterface cmd) Deprecated. Adds a stored command to the list.
abstract void	addViewer(CommandProcessorViewInterface vi) Deprecated. Adds a viewer to the list of views sending commands to the commandProcessor.
abstract void	executeCommand(CommandProcessorCommandInterface cmd, java.lang.Object obj) Deprecated. Executes the command passed and writes the appropriate component to the output stream.
abstract boolean	executedCommandExists(java.lang.String cmdName) Deprecated. Checks to see if a command with the given name has been previously executed.
abstract CommandProcessorCommandInterface	findStoredCommand(java.lang.String commandName) Deprecated.
abstract CommandDefinition[]	getCommandDefinitions() Deprecated. Returns all registered command definitions.
abstract CommandProcessorCommandInterface[]	getExecutedCommands() Deprecated. Returns all previously executedCommands
abstract CommandProcessorCommandInterface	getLastExecutedCommand() Deprecated. Returns the most recently executed command.
abstract java.util.Locale	getLocale() Deprecated. Get the locale
abstract CommandProcessorCommandInterface	getStoredCommand(java.lang.String cmdName) Deprecated. Returns a stored command with a given name.
abstract CommandProcessorViewInterface[]	getViewers() Deprecated. Returns views for which the CommandProcessor is processing commands.
abstract CommandProcessorCommandInterface	processCommand(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response) Deprecated.
abstract void	registerCommand(CommandDefinition def) Deprecated. Registers a command.
abstract void	removeAllStoredCommands() Deprecated. Remove all stored commands from the list.
abstract void	removeAllStoredCommands(CommandProcessorViewInterface viewer) Deprecated. Remove the stored commands for a particular viewer.
abstract void	removeStoredCommand(java.lang.String cmdName) Deprecated. Removes the first command with the given name.
abstract boolean	removeViewer(CommandProcessorViewInterface vi) Deprecated. Removes a viewer from the list of views sending commands to the commandProcessor
abstract void	setLocale(java.util.Locale loc) Deprecated. Set the locale
abstract boolean	storedCommandExists(java.lang.String cmdName) Deprecated. Checks for the existance of a storedCommand
abstract void	unregisterCommand(CommandDefinition def) Deprecated. Unregisters a command
abstract void	unregisterCommand(java.lang.String commandPrefix) Deprecated. Unregisters a command, using the command's prefix to identify the commandDefinition.

Method Detail

addStoredCommand

boolean addStoredCommand(CommandProcessorViewInterface viewer,
                         CommandProcessorCommandInterface cmd)

Deprecated.

Adds a stored command to the list. Typically these are navigation commands that are created as the table representation of the multidimensional table is built.

Parameters:

viewer - viewer associated with this command.

cmd - command object

getStoredCommand

CommandProcessorCommandInterface getStoredCommand(java.lang.String cmdName)

Deprecated.

Returns a stored command with a given name. If the name does not exist a null is returned.

Parameters:

cmdName - name of the desired command.

removeStoredCommand

void removeStoredCommand(java.lang.String cmdName)

Deprecated.

Removes the first command with the given name.

Parameters:

cmdName - command name to remove.

storedCommandExists

boolean storedCommandExists(java.lang.String cmdName)

Deprecated.

Checks for the existance of a storedCommand

Parameters:

cmdName - name of stored command

removeAllStoredCommands

void removeAllStoredCommands()

Deprecated.

Remove all stored commands from the list. If multiple viewers are attached the commands for all viewers are removed.

removeAllStoredCommands

void removeAllStoredCommands(CommandProcessorViewInterface viewer)

Deprecated.

Remove the stored commands for a particular viewer.

executedCommandExists

boolean executedCommandExists(java.lang.String cmdName)

Deprecated.

Checks to see if a command with the given name has been previously executed.

Parameters:

cmdName - name of stored command

processCommand

CommandProcessorCommandInterface processCommand(javax.servlet.http.HttpServletRequest request,
                                                javax.servlet.http.HttpServletResponse response)
                                                throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

findStoredCommand

CommandProcessorCommandInterface findStoredCommand(java.lang.String commandName)

Deprecated.

executeCommand

void executeCommand(CommandProcessorCommandInterface cmd,
                    java.lang.Object obj)
                    throws java.io.IOException

Deprecated.

Executes the command passed and writes the appropriate component to the output stream.

Parameters:

cmd - command to be executed

out - output stream to write table/graph etc to.

Throws:

java.io.IOException

getLastExecutedCommand

CommandProcessorCommandInterface getLastExecutedCommand()

Deprecated.

Returns the most recently executed command.

Returns:

an object that implements the MDTableCommandInterface.

addViewer

void addViewer(CommandProcessorViewInterface vi)

Deprecated.

Adds a viewer to the list of views sending commands to the commandProcessor.

Parameters:

object - implementing the CommandProcessorViewIterface.

removeViewer

boolean removeViewer(CommandProcessorViewInterface vi)

Deprecated.

Removes a viewer from the list of views sending commands to the commandProcessor

Parameters:

vi - the view to remove.

Returns:

True if item removed, false if not.

getViewers

CommandProcessorViewInterface[] getViewers()

Deprecated.

Returns views for which the CommandProcessor is processing commands.

Returns:

list of views.

setLocale

void setLocale(java.util.Locale loc)

Deprecated.

Set the locale

Parameters:

locale -

getLocale

java.util.Locale getLocale()

Deprecated.

Get the locale

Returns:

locale

registerCommand

void registerCommand(CommandDefinition def)

Deprecated.

Registers a command. All commands to be processed by the command processor must be registered.

See Also:

CommandDefinition

unregisterCommand

void unregisterCommand(CommandDefinition def)

Deprecated.

Unregisters a command

unregisterCommand

void unregisterCommand(java.lang.String commandPrefix)

Deprecated.

Unregisters a command, using the command's prefix to identify the commandDefinition.

getCommandDefinitions

CommandDefinition[] getCommandDefinitions()

Deprecated.

Returns all registered command definitions.

Returns:

command definitions.

getExecutedCommands

CommandProcessorCommandInterface[] getExecutedCommands()

Deprecated.

Returns all previously executedCommands

Returns:

previously executedCommands