CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.ctg.epi
Interface TerminalInterface

All Superinterfaces:
TerminalSession
All Known Implementing Classes:
Terminal

public interface TerminalInterface
extends TerminalSession

This interface defines the behaviour of a terminal. It is implemented by the Terminal class. It extends the TerminalSession interface.

See Also:
TerminalSession

Field Summary
 
Fields inherited from interface com.ibm.ctg.epi.TerminalSession
client, discon, error, failed, idle, server, start, txnTimedOut
 
Method Summary
 void connect(Session session, int installTimeout)
          Connects an Extended terminal to the server, within a given timeout.
 void send(Session session)
          Sends the current screen to the server.
 void send(Session session, java.lang.String transid, java.lang.String data)
          Sends the current screen to the server.
 void setGateway(JavaGateway jgate)
          Sets the JavaGateway that this terminal should use to connect to the server.
 void setSession(Session session)
          Sets the Session associated with this terminal.
 
Methods inherited from interface com.ibm.ctg.epi.TerminalSession
changePassword, connect, connect, disconnect, getPassword, getScreen, getState, getTermid, getUserid, queryATI, send, send, setATI, setPassword, setUserid, verifyPassword
 

Method Detail

setGateway

void setGateway(JavaGateway jgate)
                throws java.io.IOException,
                       EPIException
Sets the JavaGateway that this terminal should use to connect to the server.

Parameters:
jgate - a JavaGateway object
Throws:
java.io.IOException - if an error occurs
EPIException - if an error occurs

connect

void connect(Session session,
             int installTimeout)
             throws java.io.IOException,
                    EPIException
Connects an Extended terminal to the server, within a given timeout.

Parameters:
session - the Session that will handle responses from the server.
installTimeout - Terminal Install timeout (0-3600 secs, 0 = infinite)
Throws:
java.io.IOException - if an error occurs
EPIException - if an error occurs

send

void send(Session session,
          java.lang.String transid,
          java.lang.String data)
          throws java.io.IOException,
                 EPIException
Sends the current screen to the server. This method starts a new transaction on a terminal in the idle state.

Parameters:
session - the Session that will handle responses from the server. If this is null, no Session is used and calls are handled synchronously.
transid - the transaction to start
data - the data to pass to the transaction
Throws:
java.io.IOException - if an error occurs
EPIException - if an error occurs

send

void send(Session session)
          throws java.io.IOException,
                 EPIException
Sends the current screen to the server. This method is used when the terminal state is not idle or the screen is already set up to start the next transaction.

Parameters:
session - the Session that will handle responses from the server. If this is null, no Session is used and calls are handled synchronously.
Throws:
java.io.IOException - if an error occurs
EPIException - if an error occurs

setSession

void setSession(Session session)
Sets the Session associated with this terminal.

Parameters:
session - the Session that will handle responses from the server. If this is null, no Session is used and calls are handled synchronously.

©Copyright IBM Corp. 1994, 2014
Legal