com.essbase.eas.framework.server.defs.event
Class CommandEvent

java.lang.Object
  extended byjava.util.EventObject
      extended bycom.essbase.eas.framework.defs.event.FrameworkEvent
          extended bycom.essbase.eas.framework.server.defs.event.ServerEvent
              extended bycom.essbase.eas.framework.server.defs.event.CommandEvent
All Implemented Interfaces:
java.io.Serializable

public class CommandEvent
extends ServerEvent

Since:
6.5.3
Version:
6.5.3
Author:
Hank Cox, Painted Word
See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
CommandEvent(java.lang.Object source, ServiceContext theContext, StoreService theStore, com.essbase.eas.framework.defs.command.CommandDescriptor descriptor, java.util.HashMap theParameters)
          Constructs a CommandEvent object with the requested values.
CommandEvent(java.lang.Object source, ServiceContext theContext, StoreService theStore, MetaCommand theMetaCommand, MetaCommandParser theParser, java.util.HashMap theParameters)
          Constructs a CommandEvent object with the requested values.
 
Method Summary
 void flushOutputParms()
           
 com.essbase.eas.framework.defs.command.CommandDescriptor getCommandDescriptor()
           
 java.lang.String getCommandName()
          Retrieves the command name from the MetaCommand object that this event was constructed with.
 java.lang.Class getDispatchClass()
          Implements the ServerEvent.getDispatchClass() method.
 java.lang.Object getInputParm(java.lang.String inputParm)
          Retrieves a specific input parameter.
 java.lang.Object getOutputParm(java.lang.String outputParm)
          Retrieves a specific output parameter.
 java.lang.Object getRawParameter(java.lang.String rawParm)
          Returns a single parameter.
 java.util.HashMap getRawParameters()
          Retrieves the raw parameters used to create this CommandEvent object with.
 ServiceContext getServiceContext()
          Retrieves the service context for this CommandEvent object.
 StoreService getStoreService()
           
 void setOutputParm(java.lang.String outputParm, java.lang.Object value)
          Sets an output parameter for this CommandEvent object.
 
Methods inherited from class com.essbase.eas.framework.defs.event.FrameworkEvent
addException, getExceptions
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CommandEvent

public CommandEvent(java.lang.Object source,
                    ServiceContext theContext,
                    StoreService theStore,
                    MetaCommand theMetaCommand,
                    MetaCommandParser theParser,
                    java.util.HashMap theParameters)
             throws ApplicationException
Constructs a CommandEvent object with the requested values.

Parameters:
source -
Throws:
ApplicationException

CommandEvent

public CommandEvent(java.lang.Object source,
                    ServiceContext theContext,
                    StoreService theStore,
                    com.essbase.eas.framework.defs.command.CommandDescriptor descriptor,
                    java.util.HashMap theParameters)
             throws ApplicationException
Constructs a CommandEvent object with the requested values.

Parameters:
source -
Throws:
ApplicationException
Method Detail

getDispatchClass

public java.lang.Class getDispatchClass()
Implements the ServerEvent.getDispatchClass() method.

Specified by:
getDispatchClass in class ServerEvent
Returns:
The object for the CommandEvent class.

getCommandName

public java.lang.String getCommandName()
Retrieves the command name from the MetaCommand object that this event was constructed with.

Returns:
the string representing the command name for this event.

getRawParameters

public java.util.HashMap getRawParameters()
Retrieves the raw parameters used to create this CommandEvent object with.

Returns:
a newly constructed HashMap containing the parameters for this CommandEvent object.

getRawParameter

public java.lang.Object getRawParameter(java.lang.String rawParm)
Returns a single parameter.

Parameters:
rawParm - a String which can be used as the key to retrieve a specific parameter for this CommandEvent object.
Returns:
an Object that is the requested parameter; null if the parameter doesn't exist.

getInputParm

public java.lang.Object getInputParm(java.lang.String inputParm)
Retrieves a specific input parameter.

Parameters:
inputParm - a String representing the input parameter being requested.
Returns:
the object matching that parameter; null if the parameter doesn't exist in the command.

setOutputParm

public void setOutputParm(java.lang.String outputParm,
                          java.lang.Object value)
Sets an output parameter for this CommandEvent object.

Parameters:
outputParm - a String representing the output parameter being set.
value - an Object representing the output value.

getOutputParm

public java.lang.Object getOutputParm(java.lang.String outputParm)
Retrieves a specific output parameter.

Parameters:
outputParm - a String representing the output parameter being requested.
Returns:
the object matching that parameter; null if the parameter doesn't exist in the command.

flushOutputParms

public void flushOutputParms()
                      throws ApplicationException
Throws:
ApplicationException

getServiceContext

public ServiceContext getServiceContext()
Retrieves the service context for this CommandEvent object.

Overrides:
getServiceContext in class ServerEvent
Returns:
the ServiceContext object for this command event.

getStoreService

public StoreService getStoreService()

getCommandDescriptor

public com.essbase.eas.framework.defs.command.CommandDescriptor getCommandDescriptor()


Copyright © 2001 Hyperion Solutions Corporation. All Rights Reserved.