TerminalPrincipalFacility

java.lang.Object
- com.ibm.cics.server.API
- - com.ibm.cics.server.Terminal
  - - com.ibm.cics.server.TerminalPrincipalFacility

All Implemented Interfaces:

TerminalSendBits, TerminalSendCommonBits

Direct Known Subclasses:

TerminalPrincipalFacilityExtended
```
public class TerminalPrincipalFacility
extends Terminal
implements TerminalSendBits
```
This Class provides the Java interface to a CICS Terminal.

See Also:
com.ibm.cics.server.API for general restrictions on using the JCICS API.
Since CICS TS version:

1.3

Since package version:

1.0

Field Summary
- Fields inherited from interface com.ibm.cics.server.TerminalSendBits
  FRSET, NUMBER_OF_BITS, WAIT
- Fields inherited from interface com.ibm.cics.server.TerminalSendCommonBits
  ALARM, ERASE, FREEKB, PRINT

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`clear()` Clear the terminal.
`void`	`converse(DataHolder data)` Send then receive 3270 data stream from the terminal
`void`	`converseASIS(DataHolder data)` Send then receive 3270 data stream from the terminal without upper-case translation
`void`	`erase()` Erase the terminal.
`byte`	`getAIDbyte()` Return the AID (Action Identifier) key last entered by the user at the terminal.
`void`	`getTCTUA(TCTUAHolder holder)` Return a copy of the Terminal User Area (TCTUA).
`byte[]`	`getTERMCODE()` Return the TERMCODE for the principal facility.
`void`	`receive(DataHolder data)` Receive 3270 data stream from the terminal
`void`	`receiveASIS(DataHolder data)` Receive 3270 data stream from the terminal without upper-case translation
`void`	`receiveBuffer(DataHolder data)` Receive 3270 buffer from the terminal
`void`	`receiveBufferASIS(DataHolder data)` Receive 3270 buffer from the terminal without upper-case translation
`void`	`send(byte[] data)` Send a 3270 data stream to the terminal.
`void`	`send(byte[] data, java.util.BitSet options)` Send a 3270 data stream to the terminal with options.
`void`	`sendControl(java.util.BitSet options)` Send device controls to the terminal.
`void`	`sendControl(Cursor cursor)` Send cursor control to the terminal.
`void`	`sendControl(Cursor cursor, java.util.BitSet options)` Send cursor control and device controls to the terminal.
`void`	`sendText(byte[] text)` Send text to the terminal.
`void`	`sendText(byte[] text, java.util.BitSet options)` Send text to the terminal, specifying options.
`void`	`sendText(byte[] text, Cursor cursor)` Send text to the terminal, specifying a cursor position.
`void`	`sendText(byte[] text, Cursor cursor, java.util.BitSet options)` Send text to the terminal, specifying cursor position and options.
`void`	`sendText(java.lang.String text, java.util.BitSet options)` Send text to the terminal, specifying options.
`void`	`sendTextString(java.lang.String text)` Send text to the terminal.
`void`	`sendTextString(java.lang.String text, Cursor cursor)` Send text to the terminal, specifying a cursor position.
`void`	`sendTextString(java.lang.String text, Cursor cursor, java.util.BitSet options)` Send text to the terminal, specifying cursor position and options.
`void`	`setNextChannel(Channel nextChan)` Set the Channel to be used with the next transaction to be run on input from the terminal.
`void`	`setNextCOMMAREA(byte[] nextCOMMAREA)` Set the COMMAREA to be used with the next transaction to be run on input from the terminal.
`void`	`setNextTransaction(java.lang.String nextTransaction)` Set the next transaction to be run on input from the terminal.
`void`	`setTCTUA(byte[] data)` Update the contents of the TCTUA from an array of bytes.
`void`	`waitTerminal()` Deprecated. All methods operating on this class are synchronous so there is no need to wait for them to complete.

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
  - clear
```
public void clear()
           throws InvalidRequestException
```
    Clear the terminal. This method is equivalent to erase().
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - converse
```
public void converse(DataHolder data)
              throws EndOfChainIndicatorException,
                     InvalidRequestException,
                     LengthErrorException,
                     NotAllocatedException,
                     TerminalException
```
    Send then receive 3270 data stream from the terminal
    
    Parameters:
    data - the data to write
    
    Throws:
    
    EndOfChainIndicatorException - EOC occurred.
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    
    NotAllocatedException - NOTALLOC occurred.
    
    TerminalException - TERMERR occurred.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - converseASIS
```
public void converseASIS(DataHolder data)
                  throws EndOfChainIndicatorException,
                         InvalidRequestException,
                         LengthErrorException,
                         NotAllocatedException,
                         TerminalException
```
    Send then receive 3270 data stream from the terminal without upper-case translation
    
    Parameters:
    data - the data to write
    
    Throws:
    
    EndOfChainIndicatorException - EOC occurred.
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    
    NotAllocatedException - NOTALLOC occurred.
    
    TerminalException - TERMERR occurred.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - erase
```
public void erase()
           throws InvalidRequestException
```
    Erase the terminal.
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - getTCTUA
```
public void getTCTUA(TCTUAHolder holder)
```
    Return a copy of the Terminal User Area (TCTUA).
    The corresponding setTCTUA(byte[]) method must be called before returning from the task or invoking another program, as the Java TCTUA is a copy of the "real" TCTUA and any changes made in Java code must be reflected back into the "real" TCTUA before another program is invoked which would not see the current program's copy of the TCTUA.
    
    Parameters:
    holder - a holder for the TCTUA. If there is no TCTUA defined for the terminal, a byte[] of length 0 is returned as the value of the holder.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - getTERMCODE
```
public byte[] getTERMCODE()
```
    Return the TERMCODE for the principal facility.
    
    Returns:
    the TERMCODE as an array of bytes.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - receive
```
public void receive(DataHolder data)
             throws EndOfChainIndicatorException,
                    InvalidRequestException,
                    LengthErrorException,
                    NotAllocatedException,
                    TerminalException
```
    Receive 3270 data stream from the terminal
    
    Parameters:
    data - the data returned from the terminal
    
    Throws:
    
    EndOfChainIndicatorException - EOC
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    
    NotAllocatedException - NOTALLOC occurred.
    
    TerminalException - TERMERR occurred.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - receiveASIS
```
public void receiveASIS(DataHolder data)
                 throws EndOfChainIndicatorException,
                        InvalidRequestException,
                        LengthErrorException,
                        NotAllocatedException,
                        TerminalException
```
    Receive 3270 data stream from the terminal without upper-case translation
    
    Parameters:
    data - the data returned from the terminal
    
    Throws:
    
    EndOfChainIndicatorException - EOC occurred.
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    
    NotAllocatedException - NOTALLOC occurred.
    
    TerminalException - TERMERR occurred.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - receiveBuffer
```
public void receiveBuffer(DataHolder data)
                   throws EndOfChainIndicatorException,
                          InvalidRequestException,
                          LengthErrorException,
                          NotAllocatedException,
                          TerminalException
```
    Receive 3270 buffer from the terminal
    
    Parameters:
    data - the data returned from the terminal
    
    Throws:
    
    EndOfChainIndicatorException - EOC occurred.
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    
    NotAllocatedException - NOTALLOC occurred.
    
    TerminalException - TERMERR occurred.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - receiveBufferASIS
```
public void receiveBufferASIS(DataHolder data)
                       throws EndOfChainIndicatorException,
                              InvalidRequestException,
                              LengthErrorException,
                              NotAllocatedException,
                              TerminalException
```
    Receive 3270 buffer from the terminal without upper-case translation
    
    Parameters:
    data - the data returned from the terminal
    
    Throws:
    
    EndOfChainIndicatorException - EOC occurred
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    
    NotAllocatedException - NOTALLOC occurred.
    
    TerminalException - TERMERR occurred.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - send
```
public void send(byte[] data)
          throws InvalidRequestException,
                 LengthErrorException,
                 NotAllocatedException,
                 TerminalException
```
    Send a 3270 data stream to the terminal.
    
    Parameters:
    data - the data to send to the terminal
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    
    NotAllocatedException - NOTALLOC occurred.
    
    TerminalException - TERMERR occurred.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - send
```
public void send(byte[] data,
        java.util.BitSet options)
          throws InvalidRequestException,
                 LengthErrorException,
                 NotAllocatedException,
                 TerminalException
```
    Send a 3270 data stream to the terminal with options.
    
    Parameters:
    data - the data to send to the terminal
    options - the terminal control bits to set
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    
    NotAllocatedException - NOTALLOC occurred.
    
    TerminalException - TERMERR occurred.
    See Also:
    TerminalSendBits
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - sendControl
```
public void sendControl(Cursor cursor)
                 throws InvalidRequestException
```
    Send cursor control to the terminal.
    
    Parameters:
    cursor - the cursor to send to the terminal
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - sendControl
```
public void sendControl(Cursor cursor,
               java.util.BitSet options)
                 throws InvalidRequestException
```
    Send cursor control and device controls to the terminal.
    
    Parameters:
    cursor - the cursor to send to the terminal
    options - the terminal control bits to set
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    See Also:
    TerminalSendControlBits
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - sendControl
```
public void sendControl(java.util.BitSet options)
                 throws InvalidRequestException
```
    Send device controls to the terminal.
    
    Parameters:
    options - the terminal control bits to set
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    See Also:
    TerminalSendControlBits
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - sendText
```
public void sendText(byte[] text)
              throws InvalidRequestException,
                     LengthErrorException
```
    Send text to the terminal.
    
    Parameters:
    text - The text to be sent.
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - sendText
```
public void sendText(byte[] text,
            Cursor cursor)
              throws InvalidRequestException,
                     LengthErrorException
```
    Send text to the terminal, specifying a cursor position.
    
    Parameters:
    text - The text to be sent.
    cursor - The cursor position.
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - sendText
```
public void sendText(byte[] text,
            Cursor cursor,
            java.util.BitSet options)
              throws InvalidRequestException,
                     LengthErrorException
```
    Send text to the terminal, specifying cursor position and options.
    
    Parameters:
    text - The text to be sent.
    cursor - The cursor position.
    options - The options.
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    See Also:
    TerminalSendTextBits
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - sendText
```
public void sendText(byte[] text,
            java.util.BitSet options)
              throws InvalidRequestException,
                     LengthErrorException
```
    Send text to the terminal, specifying options.
    
    Parameters:
    text - The text to be sent.
    options - The options.
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    See Also:
    TerminalSendTextBits
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - sendTextString
```
public void sendTextString(java.lang.String text)
                    throws InvalidRequestException,
                           LengthErrorException
```
    Send text to the terminal. The passed String is converted to a stream of bytes using the LOCALCCSID encoding.
    
    Parameters:
    text - The text String to be sent.
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    Since CICS TS version:
    
    5.1
    
    Since package version:
    
    1.401.0
  - sendTextString
```
public void sendTextString(java.lang.String text,
                  Cursor cursor)
                    throws InvalidRequestException,
                           LengthErrorException
```
    Send text to the terminal, specifying a cursor position. The passed String is converted to a stream of bytes using the LOCALCCSID encoding.
    
    Parameters:
    text - The text to be sent.
    cursor - The cursor position.
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    Since CICS TS version:
    
    5.1
    
    Since package version:
    
    1.401.0
  - sendTextString
```
public void sendTextString(java.lang.String text,
                  Cursor cursor,
                  java.util.BitSet options)
                    throws InvalidRequestException,
                           LengthErrorException
```
    Send text to the terminal, specifying cursor position and options. The passed String is converted to a stream of bytes using the LOCALCCSID encoding.
    
    Parameters:
    text - The text String to be sent.
    cursor - The cursor position.
    options - The options.
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    See Also:
    TerminalSendTextBits
    Since CICS TS version:
    
    5.1
    
    Since package version:
    
    1.401.0
  - sendText
```
public void sendText(java.lang.String text,
            java.util.BitSet options)
              throws InvalidRequestException,
                     LengthErrorException
```
    Send text to the terminal, specifying options. The passed String is converted to a stream of bytes using the LOCALCCSID encoding.
    
    Parameters:
    text - The text String to be sent.
    options - The options.
    
    Throws:
    
    InvalidRequestException - INVREQ occurred.
    
    LengthErrorException - LENGERR occurred.
    See Also:
    TerminalSendTextBits
    Since CICS TS version:
    
    5.1
    
    Since package version:
    
    1.401.0
  - setNextCOMMAREA
```
public void setNextCOMMAREA(byte[] nextCOMMAREA)
```
    Set the COMMAREA to be used with the next transaction to be run on input from the terminal.
    
    Parameters:
    nextCOMMAREA - The COMMAREA that is to be supplied to the next transaction.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - setNextTransaction
```
public void setNextTransaction(java.lang.String nextTransaction)
```
    Set the next transaction to be run on input from the terminal.
    
    Parameters:
    nextTransaction - The name of the next transaction to be run from the terminal.
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - setNextChannel
```
public void setNextChannel(Channel nextChan)
```
    Set the Channel to be used with the next transaction to be run on input from the terminal.
    
    Parameters:
    nextChan - the Channel that is to be supplied to the next transaction.
    Since CICS TS version:
    
    3.1
    
    Since package version:
    
    1.0
  - setTCTUA
```
public void setTCTUA(byte[] data)
              throws InvalidRequestException
```
    Update the contents of the TCTUA from an array of bytes.
    This method must be called before returning from the task or invoking another program, as the Java TCTUA is a copy of the "real" TCTUA and any changes made in Java code must be reflected back into the "real" TCTUA before another program is invoked which would not see the current program's copy of the TCTUA.
    
    Parameters:
    data - the new data to be copied into the TCTUA.
    
    Throws:
    
    InvalidRequestException - the terminal does not have a TCTUA
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - waitTerminal
```
@Deprecated
public void waitTerminal()
```
    Deprecated. All methods operating on this class are synchronous so there is no need to wait for them to complete.
    
    Wait for a terminal operation to complete.
    
    Since CICS TS version:
    
    1.3
    
    Since package version:
    
    1.0
  - getAIDbyte
```
public byte getAIDbyte()
```
    Return the AID (Action Identifier) key last entered by the user at the terminal. A set of constants for interpretation of the AID byte value is provided in interface AIDValue. This method is new in CICS TS 2.1.
    
    Returns:
    byte value of AID key
    See Also:
    AIDValue
    Since CICS TS version:
    
    2.1
    
    Since package version:
    
    1.0

Class TerminalPrincipalFacility

Field Summary

Fields inherited from interface com.ibm.cics.server.TerminalSendBits

Fields inherited from interface com.ibm.cics.server.TerminalSendCommonBits

Method Summary

Methods inherited from class com.ibm.cics.server.Terminal

Methods inherited from class java.lang.Object

Method Detail

clear

converse

converseASIS

erase

getTCTUA

getTERMCODE

receive

receiveASIS

receiveBuffer

receiveBufferASIS

send

send

sendControl

sendControl

sendControl

sendText

sendText

sendText

sendText

sendTextString

sendTextString

sendTextString

sendText

setNextCOMMAREA

setNextTransaction

setNextChannel

setTCTUA

waitTerminal

getAIDbyte