CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.ctg.epi
Class AID

java.lang.Object
  extended by com.ibm.ctg.epi.AID
All Implemented Interfaces:
java.io.Serializable
Direct Known Subclasses:
AIDKey

public class AID
extends java.lang.Object
implements java.io.Serializable

This class represents an AID character to be sent to CICS.

A 3270 terminal sends a datastream to CICS when an AID key is pressed.

The AID characters are:

See Also:
Serialized Form

Field Summary
static AID clear
          Clear key.
static AID enter
          Enter key.
static AID PA1
          PA1 key.
static AID PA2
          PA2 key.
static AID PA3
          PA3 key.
static AID PF1
          PF1 key.
static AID PF10
          PF10 key.
static AID PF11
          PF11 key.
static AID PF12
          PF12 key.
static AID PF13
          PF13 key.
static AID PF14
          PF14 key.
static AID PF15
          PF15 key.
static AID PF16
          PF16 key.
static AID PF17
          PF17 key.
static AID PF18
          PF18 key.
static AID PF19
          PF19 key.
static AID PF2
          PF2 key.
static AID PF20
          PF20 key.
static AID PF21
          PF21 key.
static AID PF22
          PF22 key.
static AID PF23
          PF23 key.
static AID PF24
          PF24 key.
static AID PF3
          PF3 key.
static AID PF4
          PF4 key.
static AID PF5
          PF5 key.
static AID PF6
          PF6 key.
static AID PF7
          PF7 key.
static AID PF8
          PF8 key.
static AID PF9
          PF9 key.
static java.lang.String[] tags
          Array of String names of AID values.
 
Constructor Summary
AID(java.lang.String s)
          Construct an AID from a string representation.
 
Method Summary
 boolean equals(java.lang.Object obj)
          Returns true if the argument is not null and is an AID with the same value as this object.
 java.lang.String toString()
          Returns a String object representing this AID, for example "enter", "PF3".
 
Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

enter

public static final AID enter
Enter key.


clear

public static final AID clear
Clear key.


PA1

public static final AID PA1
PA1 key.


PA2

public static final AID PA2
PA2 key.


PA3

public static final AID PA3
PA3 key.


PF1

public static final AID PF1
PF1 key.


PF2

public static final AID PF2
PF2 key.


PF3

public static final AID PF3
PF3 key.


PF4

public static final AID PF4
PF4 key.


PF5

public static final AID PF5
PF5 key.


PF6

public static final AID PF6
PF6 key.


PF7

public static final AID PF7
PF7 key.


PF8

public static final AID PF8
PF8 key.


PF9

public static final AID PF9
PF9 key.


PF10

public static final AID PF10
PF10 key.


PF11

public static final AID PF11
PF11 key.


PF12

public static final AID PF12
PF12 key.


PF13

public static final AID PF13
PF13 key.


PF14

public static final AID PF14
PF14 key.


PF15

public static final AID PF15
PF15 key.


PF16

public static final AID PF16
PF16 key.


PF17

public static final AID PF17
PF17 key.


PF18

public static final AID PF18
PF18 key.


PF19

public static final AID PF19
PF19 key.


PF20

public static final AID PF20
PF20 key.


PF21

public static final AID PF21
PF21 key.


PF22

public static final AID PF22
PF22 key.


PF23

public static final AID PF23
PF23 key.


PF24

public static final AID PF24
PF24 key.


tags

public static final java.lang.String[] tags
Array of String names of AID values.

Constructor Detail

AID

public AID(java.lang.String s)
    throws java.lang.IllegalArgumentException
Construct an AID from a string representation. For example, "enter".

Parameters:
s - the string
Throws:
java.lang.IllegalArgumentException - if the string does not represent an AID
Method Detail

equals

public boolean equals(java.lang.Object obj)
Returns true if the argument is not null and is an AID with the same value as this object.

Overrides:
equals in class java.lang.Object
Parameters:
obj - the object to compare with
Returns:
true if the objects are the same, false otherwise

toString

public java.lang.String toString()
Returns a String object representing this AID, for example "enter", "PF3".

Overrides:
toString in class java.lang.Object
Returns:
a string representation of this object

©Copyright IBM Corp. 1994, 2014
Legal