IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.event
Class DSEEventObject

java.lang.Object
  extended by java.util.EventObject
      extended by com.ibm.btt.event.DSEEventObject
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
DSEExceptionEvent

public class DSEEventObject
extends java.util.EventObject

The DSEEventObject class is used by notifiers, the Event Manager,and handlers to handle events by name. It provides as many parameters as are required by the notifiers and enables the system to provide the TID (terminal identification) where the event was generated.

See Also:
Serialized Form

Field Summary
static java.lang.String COPYRIGHT
           
protected  java.lang.String name
           
protected  java.lang.String originTID
           
protected  java.util.Hashtable parameters
           
protected  java.lang.String sourceName
           
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
DSEEventObject(java.lang.Object aObject)
          This constructor creates a DSEEventObject object.
DSEEventObject(java.lang.String name)
          This constructor creates a DSEEventObject object.
DSEEventObject(java.lang.String aName, Notifier aSource)
          This constructor creates a DSEEventObject with a name and notifier.
DSEEventObject(java.lang.String aName, Notifier aSource, java.util.Hashtable aParametersTable)
          This constructor creates a DSEEventObject with a name and notifier.
 
Method Summary
 java.lang.String getName()
          Gets the DSEEventObject name attribute.
 java.util.Hashtable getParameters()
          Gets the DSEEventObject parameters attribute.
 java.lang.String getSourceName()
          Gets the DSEEventObject sourceName.
 java.lang.String getTID()
          Gets the terminal identification.
 void setName(java.lang.String aName)
          Sets the DSEEventObject name to aName.
 void setParameters(java.util.Hashtable aParametersTable)
          Sets the DSEEventObject parameters attribute to aParametersTable.
 void setSourceName(java.lang.String aSourceName)
          Sets the DSEEventObject sourceName to aSourceName.
 void setTID(java.lang.String aTID)
          Sets the terminal identification.
 java.lang.String toString()
          Returns a visual representation of the DSEEventObject.
 
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
 

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT
See Also:
Constant Field Values

sourceName

protected java.lang.String sourceName

name

protected java.lang.String name

parameters

protected java.util.Hashtable parameters

originTID

protected java.lang.String originTID
Constructor Detail

DSEEventObject

public DSEEventObject(java.lang.String name)
This constructor creates a DSEEventObject object.

Parameters:
name - String

DSEEventObject

public DSEEventObject(java.lang.Object aObject)
This constructor creates a DSEEventObject object.

Parameters:
aObject - java.lang.Object

DSEEventObject

public DSEEventObject(java.lang.String aName,
                      Notifier aSource)
               throws DSEInvalidArgumentException
This constructor creates a DSEEventObject with a name and notifier. This method generates a DSEInvalidArgumentException when an attempt is made to create a DSEEventObject with null parameters.

Parameters:
aName - java.lang.String
aSource - com.ibm.btt.event.Notifier
Throws:
DSEInvalidArgumentException

DSEEventObject

public DSEEventObject(java.lang.String aName,
                      Notifier aSource,
                      java.util.Hashtable aParametersTable)
               throws DSEInvalidArgumentException
This constructor creates a DSEEventObject with a name and notifier. This method generates a DSEInvalidArgumentException when an attempt is made to create a DSEEventObject with null parameters.

Parameters:
aName - java.lang.String
aSource - com.ibm.btt.event.Notifier
aParametersTable - java.util.Hashtable
Throws:
DSEInvalidArgumentException
Method Detail

getName

public java.lang.String getName()
Gets the DSEEventObject name attribute.

Returns:
java.lang.String

getParameters

public java.util.Hashtable getParameters()
Gets the DSEEventObject parameters attribute.

Returns:
java.util.Hashtable

getSourceName

public java.lang.String getSourceName()
Gets the DSEEventObject sourceName.

Returns:
java.lang.String

getTID

public java.lang.String getTID()
Gets the terminal identification.

Returns:
java.lang.String

setTID

public void setTID(java.lang.String aTID)
Sets the terminal identification.

Parameters:
aTID - java.lang.String

setName

public void setName(java.lang.String aName)
Sets the DSEEventObject name to aName.

Parameters:
aName - java.lang.String

setParameters

public void setParameters(java.util.Hashtable aParametersTable)
Sets the DSEEventObject parameters attribute to aParametersTable.

Parameters:
aParametersTable - java.util.Hashtable

setSourceName

public void setSourceName(java.lang.String aSourceName)
Sets the DSEEventObject sourceName to aSourceName.

Parameters:
aSourceName - java.lang.String

toString

public java.lang.String toString()
Returns a visual representation of the DSEEventObject.

Overrides:
toString in class java.util.EventObject
Returns:
java.lang.String

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2009