oracle.adfnmc.event
Class ClientEvent

java.lang.Object
  oracle.adfnmc.event.ClientEvent

public class ClientEvent
extends java.lang.Object

This class provides extra information about events that are invoked

Field Summary

static java.lang.Class

CLASS_INSTANCE

Constructor Summary

ClientEvent(java.lang.String type, Map parameters)
Constructor

ClientEvent(java.lang.String type, Map parameters, java.lang.Object source)
Constructor

Method Summary

java.lang.Object	getParameter(java.lang.String parameter) Returns the value to which the specified parameter, or null if the parameter does not exist.
Map	getParameters() Returns a map containing every parameter for this event.
java.lang.Object	getSource() The source of the event might contain useful additional information in addition to the parameter values
java.lang.String	getType() If the user wants to check which type of event was thrown, this method should be called.
java.lang.Object	setParameter(java.lang.String key, java.lang.Object value) Associates the specified value with the specified parameter.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CLASS_INSTANCE

public static final java.lang.Class CLASS_INSTANCE

Constructor Detail

ClientEvent

public ClientEvent(java.lang.String type,
                   Map parameters)

Constructor

Parameters:

type - the text name of this event

parameters - any additional parameter information to be provided

ClientEvent

public ClientEvent(java.lang.String type,
                   Map parameters,
                   java.lang.Object source)

Constructor

Parameters:

type - the text name of this event

parameters - any additional parameter information to be provided

source - the invoker of this event

Method Detail

getType

public java.lang.String getType()

If the user wants to check which type of event was thrown, this method should be called.

Returns:

the text name of this event

getSource

public java.lang.Object getSource()

The source of the event might contain useful additional information in addition to the parameter values

Returns:

the invoker of this event

getParameter

public java.lang.Object getParameter(java.lang.String parameter)

Returns the value to which the specified parameter, or null if the parameter does not exist. A return value of null does not necessarily indicate that there is no parameter; it is also possible that the parameter is explicitly null.

Parameters:

parameter - the text name of the parameter

Returns:

the parameter value, or null

setParameter

public java.lang.Object setParameter(java.lang.String key,
                                     java.lang.Object value)

Associates the specified value with the specified parameter. If the parameter previously existed, the old value is replaced.

Parameters:

key - the text name of the parameter

value - the parameter value

Returns:

the previous parameter value, or null

getParameters

public Map getParameters()

Returns a map containing every parameter for this event.

Returns:

a map representing all of the parameters for this event