Package com.microfocus.zfe.haapi.ps

Interface OIA

public interface OIA
An OIA object represents the operator information area (OIA) of the host terminal session. You gain access to the session's OIA instance using the getOIA() method on Session. The OIA provides information about the cursor position, the type of host field where the cursor is located, etc. The information available from the OIA object is generally analogous to the information visible in the green-screen session's status bar at the bottom of the terminal window.

  • Method Details

    • addOIAListener

      void addOIAListener(OIAListener listener)
      Adds an OIAListener instance that wishes to be notified of OIA events.
      Parameters:
      listener - the OIAListener instance to be added. If the listener is already added, this method does nothing.

    • removeOIAListener

      boolean removeOIAListener(OIAListener listener)
      Removes an OIAListener instance so it will not longer receive OIA events
      Parameters:
      listener - the listener to be removed
      Returns:
      true if the listener was found, false otherwise

    • getStatus

      Set<OIAStatus> getStatus()
      Returns the current OIA status as an EnumSet
      Returns:
      the current OIA status

    • getProgErrorCode

      int getProgErrorCode()
      Returns the current program error code
      Returns:
      the current program error code which may be 0 if there is not one

    • getCommErrorCode

      int getCommErrorCode()
      Returns the current comm error code
      Returns:
      the current comm error code which may be 0 if there is not one