|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.ibm.cics.server.API | +--com.ibm.cics.server.Terminal | +--com.ibm.cics.server.TerminalPrincipalFacility
This class represents the Java interface to the Terminal that is attached as the principal facility of the current Task.
Method Summary | |
void |
clear()
Clear the screen of the terminal. |
void |
converse(DataHolder data)
Not Implemented. |
void |
converseASIS(DataHolder data)
Not Implemented. |
void |
erase()
Clear the screen of the terminal. |
void |
getTCTUA(TCTUAHolder holder)
Get a copy of the TCTUA. |
byte[] |
getTERMCODE()
Not Implemented. |
void |
receive(DataHolder data)
Receive some data from the terminal. |
void |
receiveASIS(DataHolder data)
Receive some data from the terminal. |
void |
receiveBuffer(DataHolder data)
Receive some data from the terminal. |
void |
receiveBufferASIS(DataHolder data)
Receive some data from the terminal. |
void |
send(byte[] datastream)
Send a 3270 datastream to the terminal. |
void |
send(byte[] datastream,
java.util.BitSet bs)
Send a 3270 datastream to the terminal, along with some control information. |
void |
sendControl(java.util.BitSet bs)
Send a set of controls to a terminal. |
void |
sendControl(Cursor cursor)
Set the cursor position on the terminal. |
void |
sendControl(Cursor cursor,
java.util.BitSet bs)
Send a set of controls to a terminal as well as setting the cursor position. |
void |
sendText(byte[] text)
Send text to the terminal. |
void |
sendText(byte[] text,
java.util.BitSet bs)
Send text to the terminal, specifying some control actions to perform. |
void |
sendText(byte[] text,
Cursor cursor)
Send text to the terminal, specifying the final cursor position. |
void |
sendText(byte[] text,
Cursor cursor,
java.util.BitSet bs)
Send text to the terminal, specifying the final cursor position, and some control actions to perform. |
void |
setNextCOMMAREA(byte[] nextCOMMAREA)
Set the COMMAREA for the next transaction on this terminal. |
void |
setNextTransaction(java.lang.String nextTransaction)
Set the next transaction to be executed on this terminal. |
void |
setTCTUA(byte[] data)
Set the TCTUA bytes. |
void |
waitTerminal()
Not Implemented. |
Methods inherited from class com.ibm.cics.server.Terminal |
getCursor,
getName,
getUser |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Method Detail |
public void clear() throws InvalidRequestException
erase()
public void erase() throws InvalidRequestException
clear()
public void sendControl(Cursor cursor) throws InvalidRequestException
cursor
- The cursor position.public void sendControl(java.util.BitSet bs) throws InvalidRequestException
bs
- A BitSet that contain the bits indicating which control
actions are to be performed.public void sendControl(Cursor cursor, java.util.BitSet bs) throws InvalidRequestException
cursor
- The cursor position.bs
- A BitSet that contain the bits indicating which control
actions are to be performed.public void send(byte[] datastream) throws InvalidRequestException, LengthErrorException, NotAllocatedException, TerminalException
datastream
- The datastream to be sent.public void send(byte[] datastream, java.util.BitSet bs) throws InvalidRequestException, LengthErrorException, NotAllocatedException, TerminalException
datastream
- The datastream to be sent.bs
- A BitSet that contain the bits indicating which control
actions are to be performed.public void sendText(byte[] text) throws InvalidRequestException, LengthErrorException
text
- The text to be sent.public void sendText(byte[] text, Cursor cursor) throws InvalidRequestException, LengthErrorException
text
- The text to be sent.cursor
- The final cursor position.public void sendText(byte[] text, Cursor cursor, java.util.BitSet bs) throws InvalidRequestException, LengthErrorException
Note: The FORMFEED and NLEOM bits are not supported in TRANS and are therefore ignored.
text
- The text to be sent.cursor
- The final cursor position.bs
- A BitSet that contain the bits indicating which control
actions are to be performed.public void sendText(byte[] text, java.util.BitSet bs) throws InvalidRequestException, LengthErrorException
Note: The FORMFEED and NLEOM bits are not supported in TRANS and are therefore ignored.
text
- The text to be sent.bs
- A BitSet that contain the bits indicating which control
actions are to be performed.public void converse(DataHolder data) throws EndOfChainIndicatorException, InvalidRequestException, LengthErrorException, NotAllocatedException, TerminalException
public void converseASIS(DataHolder data) throws EndOfChainIndicatorException, InvalidRequestException, LengthErrorException, NotAllocatedException, TerminalException
public void getTCTUA(TCTUAHolder holder)
A copy of the contents of the TCTUA placed into the supplied holder. Modifications to this copy will not affect the actual TCTUA. The { @link #setTCTUA(byte[]) setTCTUA } method should be used to set the value of the TCTUA.
If the length of the TCTUA is zero then a zero length array is
placed into the TCTUAHolder
.
public byte[] getTERMCODE()
public void setNextCOMMAREA(byte[] nextCOMMAREA)
nextCOMMAREA
- The commarea.public void setNextTransaction(java.lang.String nextTransaction)
nextTransaction
- The transID of the text transaction.public void setTCTUA(byte[] data) throws InvalidRequestException
data
- The data to put into the TCTUA.public void waitTerminal()
public void receive(DataHolder data) throws EndOfChainIndicatorException, InvalidRequestException, LengthErrorException, NotAllocatedException, TerminalException
The dataholder supplied has its value set to be a new byte array containing the data. Thus, the caller does not have to supply a value.
The returned data is converted to uppercase if the terminal is defined as such.
data
- A holder for the returned data.public void receiveASIS(DataHolder data) throws EndOfChainIndicatorException, InvalidRequestException, LengthErrorException, NotAllocatedException, TerminalException
The dataholder supplied has its value set to be a new byte array containing the data. Thus, the caller does not have to supply a value.
The returned data is not converted to uppercase.
data
- A holder for the returned data.public void receiveBuffer(DataHolder data) throws EndOfChainIndicatorException, InvalidRequestException, LengthErrorException, NotAllocatedException, TerminalException
This method returns data that is currently displayed on the terminal. It does not require an AID key to have been pressed.
The dataholder supplied has its value set to be a new byte array containing the data. Thus, the caller does not have to supply a value.
The returned data is converted to uppercase if the terminal is defined as such.
data
- A holder for the returned data.public void receiveBufferASIS(DataHolder data) throws EndOfChainIndicatorException, InvalidRequestException, LengthErrorException, NotAllocatedException, TerminalException
This method returns data that is currently displayed on the terminal. It does not require an AID key to have been pressed.
The dataholder supplied has its value set to be a new byte array containing the data. Thus, the caller does not have to supply a value.
The returned data is not converted to uppercase.
data
- A holder for the returned data.
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |