com.ibm.eNetwork.beans.HOD.event
Class CommEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--com.ibm.eNetwork.beans.HOD.event.HODEvent
              |
              +--com.ibm.eNetwork.beans.HOD.event.CommEvent
All Implemented Interfaces:
java.io.Serializable

public class CommEvent
extends com.ibm.eNetwork.beans.HOD.event.HODEvent

The communications event. Fired to CommListeners when the communications state of a Terminal or Session changes.

See Also:
CommListener, Session, Terminal, Serialized Form

Constructor Summary
CommEvent(java.lang.Object source, int commStatus)
          Constructs a new CommEvent with the specified source and communications status.
CommEvent(java.lang.Object source, int commStatus, com.ibm.eNetwork.ECL.ECLErr e)
          Constructs a new CommEvent with the specified source, communications status, and ECLErr
 
Method Summary
 int getCommStatus()
          Returns the communications status.
 java.lang.String getDeviceName()
          Returns the device name if one has been assigned, null otherwise.
 com.ibm.eNetwork.ECL.ECLErr getECLErr()
          Returns the ECLErr if one was assigned, null otherwise.
 java.lang.String getSLPHost()
          Returns the host name if one has been assigned, null otherwise.
 int getSLPPort()
          Returns the port name if one has been assigned, null otherwise.
 java.lang.String getWorkstationID()
          Returns the workstation ID if one has been assigned, null otherwise.
 boolean isCommReady()
          Returns whether or not communications is ready.
 boolean isDeviceNameReady()
          Returns whether or not the device name has been assigned.
 boolean isWorkstationIDReady()
          Returns true if the workstation ID is ready, otherwise returns false.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

CommEvent

public CommEvent(java.lang.Object source,
                 int commStatus)
Constructs a new CommEvent with the specified source and communications status.

CommEvent

public CommEvent(java.lang.Object source,
                 int commStatus,
                 com.ibm.eNetwork.ECL.ECLErr e)
Constructs a new CommEvent with the specified source, communications status, and ECLErr
Method Detail

getCommStatus

public int getCommStatus()
Returns the communications status.
See Also:
Session.getCommStatus()

isCommReady

public boolean isCommReady()
Returns whether or not communications is ready.
See Also:
Session.isCommReady()

isDeviceNameReady

public boolean isDeviceNameReady()
Returns whether or not the device name has been assigned.
See Also:
Session.isDeviceNameReady()

getDeviceName

public java.lang.String getDeviceName()
Returns the device name if one has been assigned, null otherwise.

See Also:
ECLConnection

getSLPHost

public java.lang.String getSLPHost()
Returns the host name if one has been assigned, null otherwise.

See Also:
ECLConnection

getSLPPort

public int getSLPPort()
Returns the port name if one has been assigned, null otherwise.

See Also:
ECLConnection

isWorkstationIDReady

public boolean isWorkstationIDReady()
Returns true if the workstation ID is ready, otherwise returns false. This method is only valid for 5250 session.
See Also:
Session.isWorkstationIDReady()

getWorkstationID

public java.lang.String getWorkstationID()
Returns the workstation ID if one has been assigned, null otherwise.

See Also:
ECLConnection

getECLErr

public com.ibm.eNetwork.ECL.ECLErr getECLErr()
Returns the ECLErr if one was assigned, null otherwise.