com.ibm.eNetwork.beans.HOD
Class HODBean

java.lang.Object
  |
  +--com.ibm.eNetwork.beans.HOD.HODBean
All Implemented Interfaces:
java.lang.Cloneable, java.util.EventListener, java.io.Externalizable, com.ibm.eNetwork.HOD.common.HODConstants, java.beans.PropertyChangeListener, java.io.Serializable, TraceProducer
Direct Known Subclasses:
Converter, Macro, Session

public abstract class HODBean
extends java.lang.Object
implements com.ibm.eNetwork.HOD.common.HODConstants, java.io.Externalizable, java.beans.PropertyChangeListener, java.lang.Cloneable, TraceProducer

Base class for the Host Access Beans.

Class Inheritance

The libraries containing this class are available in two versions: java2 and jdk1.1.8. This class document represents a compilation using Java 2 and its core libraries. The class inheritance scheme is shown above.

The alternative library was compiled with JDK 1.1.8. The result is a slightly different derivation, illustrated in this following class inheritance fragment.

         |
         +--java.awt.Container
               |
               +--java.awt.Panel
                     |
                     +--com.ibm.eNetwork.HOD.common.gui.HPanel
                           |
                           +--
 

See Also:
Serialized Form

Field Summary
static java.lang.String BEAN_VERSION_STRING
           
static java.lang.String TRACE_LEVEL
          traceLevel property keyword
static int TRACE_MAXIMUM
          traceLevel property value
static int TRACE_MINIMUM
          traceLevel property value
static int TRACE_NONE
          traceLevel property value
static int TRACE_NORMAL
          traceLevel property value
 
Fields inherited from interface com.ibm.eNetwork.HOD.common.HODConstants
DEFAULT_WIN_FONT, HOD_ICON_EVENT, HOD_MSG_FILE, HOD_RAS_COMPID_ASSOC_PRT, HOD_RAS_COMPID_BLINKREMAP, HOD_RAS_COMPID_CODEPAGE, HOD_RAS_COMPID_COLORREMAP, HOD_RAS_COMPID_CONFIG, HOD_RAS_COMPID_FILETRANSFER, HOD_RAS_COMPID_FTP_SCREEN, HOD_RAS_COMPID_FTP_SESSION, HOD_RAS_COMPID_FTP_TERMINAL, HOD_RAS_COMPID_FUDOMA, HOD_RAS_COMPID_IMPEXP, HOD_RAS_COMPID_JNILOAD, HOD_RAS_COMPID_KEYPAD, HOD_RAS_COMPID_KEYREMAP, HOD_RAS_COMPID_MACRO, HOD_RAS_COMPID_MACROMANGR, HOD_RAS_COMPID_PRT_TERMINAL, HOD_RAS_COMPID_SCREEN, HOD_RAS_COMPID_SESSION, HOD_RAS_COMPID_SESSION_MGR, HOD_RAS_COMPID_SLP, HOD_RAS_COMPID_TERMINAL, HOD_RAS_FUNC_NAME, HOD_START_UP, HOD_TRANSFER_FILE_INFO, MOUSE_DOUBLE_CLICK_THRESHOLD, XFER_ASCII_GET_OPTIONS, XFER_ASCII_GET_OPTIONS_DEFAULT, XFER_ASCII_PUT_OPTIONS, XFER_ASCII_PUT_OPTIONS_DEFAULT, XFER_BINARY_GET_OPTIONS, XFER_BINARY_GET_OPTIONS_DEFAULT, XFER_BINARY_PUT_OPTIONS, XFER_BINARY_PUT_OPTIONS_DEFAULT, XFER_DEFAULT_OPTIONS, XFER_FILETYPE_DTA, XFER_FILETYPE_SAVF, XFER_FILETYPE_SRC, XFER_HOST_TYPE, XFER_HOST_TYPE_CICS, XFER_HOST_TYPE_CMS, XFER_HOST_TYPE_DEFAULT, XFER_HOST_TYPE_OS400, XFER_HOST_TYPE_TSO, XFER_PACKET_SIZE, XFER_PACKET_SIZE_DEFAULT, XFER_TIME_OUT_VALUE, XFER_TIME_OUT_VALUE_DEFAULT, XFER_TRANSFER_MODE, XFER_TRANSFER_MODE_ASCII, XFER_TRANSFER_MODE_BINARY, XFER_TRANSFER_MODE_DEFAULT
 
Method Summary
 void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
          Adds a property change listener.
 void addTraceListener(TraceListener l)
          Adds a trace listener.
 void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
          Adds a vetoable change listener.
 java.lang.Object clone()
          Returns a copy of this bean.
 void dispose()
          Disposes of the Bean when the caller is done with it.
 java.lang.String getComponent()
          Returns the trace component name for this object.
 java.lang.String getFunction()
          Returns the trace function name for this object.
 java.util.Properties getProperties()
          Returns the properties of the bean.
 int getTraceLevel()
          Returns the current trace level for this object.
abstract  java.lang.String getTraceName()
          Returns the trace name for this object.
 void propertyChange(java.beans.PropertyChangeEvent evt)
          Invoked if this bean is registered as a PropertyChangeListener on a bean who's properties are changed.
 void readExternal(java.io.ObjectInput input)
          Externalizable interface method to read the serialized bean properties.
 void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
          Removes a property change listener so that it no longer receives property change events.
 void removeTraceListener(TraceListener l)
          Removes a trace listener so that it no longer receives trace events.
 void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
          Removes a vetoable change listener so that it no longer receives notification of vetoable property changes.
 void setProperties(java.util.Properties p)
          Sets the properties for the bean.
 void setTraceLevel(int newLevel)
          Sets the current tracing level for this object.
 java.lang.String toString()
          Returns a string representation of the bean.
 void writeExternal(java.io.ObjectOutput output)
          Externalizable interface method to write the serialized bean properties.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TRACE_LEVEL

public static final java.lang.String TRACE_LEVEL
traceLevel property keyword

TRACE_NONE

public static final int TRACE_NONE
traceLevel property value

TRACE_MINIMUM

public static final int TRACE_MINIMUM
traceLevel property value

TRACE_NORMAL

public static final int TRACE_NORMAL
traceLevel property value

TRACE_MAXIMUM

public static final int TRACE_MAXIMUM
traceLevel property value

BEAN_VERSION_STRING

public static final java.lang.String BEAN_VERSION_STRING
Method Detail

setProperties

public void setProperties(java.util.Properties p)
                   throws java.beans.PropertyVetoException
Sets the properties for the bean.
Parameters:
properties - a properties object for the bean.
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.
See Also:
getProperties()

getProperties

public java.util.Properties getProperties()
Returns the properties of the bean.
See Also:
setProperties(java.util.Properties)

addVetoableChangeListener

public void addVetoableChangeListener(java.beans.VetoableChangeListener listener)
Adds a vetoable change listener. Vetoable change listeners are notified with a PropertyChangeEvent before a property is changed on the bean and have the option of vetoing the change.
Parameters:
listener - The VetoableChangeListener.
See Also:
removeVetoableChangeListener(java.beans.VetoableChangeListener)

removeVetoableChangeListener

public void removeVetoableChangeListener(java.beans.VetoableChangeListener listener)
Removes a vetoable change listener so that it no longer receives notification of vetoable property changes.
Parameters:
listener - The VetoableChangeListener to remove.
See Also:
addVetoableChangeListener(java.beans.VetoableChangeListener)

addPropertyChangeListener

public void addPropertyChangeListener(java.beans.PropertyChangeListener listener)
Adds a property change listener. Property change listeners are notified when a property is changed on the bean.
Parameters:
listener - The PropertyChangeListener.
See Also:
removePropertyChangeListener(java.beans.PropertyChangeListener)

removePropertyChangeListener

public void removePropertyChangeListener(java.beans.PropertyChangeListener listener)
Removes a property change listener so that it no longer receives property change events.
Parameters:
listener - a previously registered PropertyChangeListener object.
See Also:
addPropertyChangeListener(java.beans.PropertyChangeListener)

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)
Invoked if this bean is registered as a PropertyChangeListener on a bean who's properties are changed.
Specified by:
propertyChange in interface java.beans.PropertyChangeListener
Parameters:
evt - the PropertyChangeEvent for the property that was changed.

toString

public java.lang.String toString()
Returns a string representation of the bean.
Overrides:
toString in class java.lang.Object

clone

public java.lang.Object clone()
Returns a copy of this bean.

readExternal

public void readExternal(java.io.ObjectInput input)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Externalizable interface method to read the serialized bean properties.
Specified by:
readExternal in interface java.io.Externalizable
Parameters:
input - ObjectInput from the Externalizable interface
Throws:
java.io.IOException - May occur reading a persistent class.
java.lang.ClassNotFoundException - May occur attempting to load a persistent class.
See Also:
writeExternal(java.io.ObjectOutput)

writeExternal

public void writeExternal(java.io.ObjectOutput output)
                   throws java.io.IOException
Externalizable interface method to write the serialized bean properties.
Specified by:
writeExternal in interface java.io.Externalizable
Parameters:
output - ObjectOutput from the Externalizable interface
See Also:
readExternal(java.io.ObjectInput)

getTraceName

public abstract java.lang.String getTraceName()
Returns the trace name for this object.

getComponent

public java.lang.String getComponent()
Returns the trace component name for this object.
Specified by:
getComponent in interface TraceProducer

getFunction

public java.lang.String getFunction()
Returns the trace function name for this object.
Specified by:
getFunction in interface TraceProducer

getTraceLevel

public int getTraceLevel()
Returns the current trace level for this object.
Specified by:
getTraceLevel in interface TraceProducer

setTraceLevel

public void setTraceLevel(int newLevel)
                   throws java.beans.PropertyVetoException
Sets the current tracing level for this object.
Specified by:
setTraceLevel in interface TraceProducer
Parameters:
traceLevel - One of the trace level constants
Throws:
java.beans.PropertyVetoException - Thrown if a VetoableChangeListener vetoes the new value.

addTraceListener

public void addTraceListener(TraceListener l)
Adds a trace listener. Trace listeners are notified when a trace event occurs on the bean.
Parameters:
l - an object that implements the TraceListener interface
See Also:
com.ibm.eNetwork.beans.HOD.event.TraceListener, com.ibm.eNetwork.beans.HOD.event.TraceEvent

removeTraceListener

public void removeTraceListener(TraceListener l)
Removes a trace listener so that it no longer receives trace events.
Parameters:
l - a previously registered TraceListener object
See Also:
com.ibm.eNetwork.beans.HOD.event.TraceListener, com.ibm.eNetwork.beans.HOD.event.TraceEvent

dispose

public void dispose()
Disposes of the Bean when the caller is done with it.