com.iplanet.jato.view.event
Class ViewCommandEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.iplanet.jato.view.event.ViewCommandEvent
All Implemented Interfaces:
CommandEvent, java.io.Serializable

public class ViewCommandEvent
extends java.util.EventObject
implements CommandEvent

An CommandEvent that can be associated with a View.

Since:
JATO/1.2
Version:
JATO/1.2.2 $Id: ViewCommandEvent.java,v 1.5 2002/03/16 03:26:43 todd Exp $
See Also:
Serialized Form

Fields inherited from class java.util.EventObject
source
 
Constructor Summary
protected ViewCommandEvent(java.lang.Object source)
          Creates a ViewCommandEvent object
  ViewCommandEvent(java.lang.Object source, RequestContext requestContext, java.lang.String operationName, java.util.Map parameters, ViewInvocation invocation)
          Creates a ViewCommandEvent object
 
Method Summary
 ViewInvocation getInvocation()
          Returns the ViewInvocation.
 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 The command paramaters may be an arbitrarily complex collection of objects which are meaningful to the Command object which recieves this event.
 RequestContext getRequestContext()
          Returns the RequestContext.
 java.lang.String toString()
          Returns a String representation of this ViewCommandEvent.
 
Methods inherited from class java.util.EventObject
getSource
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.iplanet.jato.command.CommandEvent
getSource
 

Constructor Detail

ViewCommandEvent

protected ViewCommandEvent(java.lang.Object source)
Creates a ViewCommandEvent object
Parameters:
source - The request source.

ViewCommandEvent

public ViewCommandEvent(java.lang.Object source,
                        RequestContext requestContext,
                        java.lang.String operationName,
                        java.util.Map parameters,
                        ViewInvocation invocation)
Creates a ViewCommandEvent object
Parameters:
source - The request source.
requestContext - The RequestContext.
operationName - Ths name of the operation for the command to perform.
parameters - the map of command parameters
invocation - The ViewInvocation.
Method Detail

getRequestContext

public RequestContext getRequestContext()
Returns the RequestContext.
Specified by:
getRequestContext in interface CommandEvent
Returns:
the RequestContext.

getOperationName

public java.lang.String getOperationName()
Returns the name of the operation for the command to perform. Not all Commands expect or require an execution time operation name.
Specified by:
getOperationName in interface CommandEvent
Returns:
the name of the operation for the command to perform

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.
Specified by:
getParameters in interface CommandEvent
Returns:
the map of command paramaters.

getInvocation

public ViewInvocation getInvocation()
Returns the ViewInvocation.
Returns:
The ViewInvocaton.

toString

public java.lang.String toString()
Returns a String representation of this ViewCommandEvent.
Overrides:
toString in class java.util.EventObject
Returns:
a String representation of this ViewCommandEvent.