com.iplanet.jato.command
Interface CommandEvent

All Known Implementing Classes:
ViewCommandEvent

public interface CommandEvent

Generic interface to provide Command objects with information pertinent to the execution of the command. A particular CommandEvent is designed to meet the execution time needs of a particular Command. The CommandEvent provides the command with access to the RequestContext, as well an operation name (if specified by the caller) and a collection of arbitrary parameter data which are meaningful to the command's execution.

Since:
JATO/1.2
Version:
JATO/1.2.2 $Id: CommandEvent.java,v 1.6 2002/03/16 03:26:29 todd Exp $
See Also:
Command

Method Summary
 java.lang.String getOperationName()
          Returns the name of the operation for the command to perform.
 java.util.Map getParameters()
          Returns the map of command parameters.
 RequestContext getRequestContext()
          Returns the RequestContext
 java.lang.Object getSource()
          Returns the event source
 

Method Detail

getSource

public java.lang.Object getSource()
Returns the event source

getRequestContext

public RequestContext getRequestContext()
Returns the RequestContext

getOperationName

public java.lang.String getOperationName()
Returns the name of the operation for the command to perform. This should generally return the value of the Command.DEFAULT_OPERATION_NAME constant if a different operation name was not specified by the source of the event.

getParameters

public java.util.Map getParameters()
Returns the map of command parameters. The command paramaters may be an arbitrarily complex collection of objects which are meaningful to the Command object which recieves this event.
Returns:
The map of command paramaters specific to this execution