com.ibm.cics.server
Class Terminal

java.lang.Object
  extended by com.ibm.cics.server.API
      extended by com.ibm.cics.server.Terminal
Direct Known Subclasses:
TerminalPrincipalFacility

public class Terminal
extends API

This Class provides the Java interface to a CICS Terminal.

Since CICS TS version:
1.3
Since package version:
1.0

Constructor Summary
Terminal(java.lang.String name)
          Constructor
Terminal(java.lang.String name, java.lang.String NETNAME)
          Constructor
 
Method Summary
 Cursor getCursor()
          Return the Cursor associated with the terminal.
 java.lang.String getName()
          Return the name of the terminal.
 java.lang.String getUser()
          Return the name of the user currently signed on to the terminal.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Terminal

public Terminal(java.lang.String name)
         throws java.lang.NullPointerException,
                InvalidTerminalIdException
Constructor

Parameters:
name - the name of the terminal
Throws:
java.lang.NullPointerException - if the name is null
InvalidTerminalIdException - if the name is invalid
Since CICS TS version:
1.3
Since package version:
1.0

Terminal

public Terminal(java.lang.String name,
                java.lang.String NETNAME)
         throws java.lang.NullPointerException,
                InvalidTerminalIdException
Constructor

Parameters:
name - the name of the terminal
NETNAME - the NETNAME of the terminal
Throws:
java.lang.NullPointerException - if the name is null
InvalidTerminalIdException - if the name is invalid
Since CICS TS version:
1.3
Since package version:
1.0
Method Detail

getCursor

public Cursor getCursor()
Return the Cursor associated with the terminal.

Returns:
the cursor
Since CICS TS version:
2.1
Since package version:
1.0

getName

public java.lang.String getName()
Return the name of the terminal.

Returns:
the name
Since CICS TS version:
1.3
Since package version:
1.0

getUser

public java.lang.String getUser()
                         throws InvalidRequestException
Return the name of the user currently signed on to the terminal.

Returns:
The name of the user currently signed on to the terminal.
Throws:
InvalidRequestException - an INVREQ condition occurred
Since CICS TS version:
1.3
Since package version:
1.0