Package com.ibm.jakarta.connector2.cics
Class EPIInteractionSpec
java.lang.Object
com.ibm.jakarta.connector2.cics.CICSInteractionSpec
com.ibm.jakarta.connector2.cics.EPIInteractionSpec
- All Implemented Interfaces:
jakarta.resource.cci.InteractionSpec
,Serializable
This class allows you to set the values for a CICS EPI request.
On each EPI request, a screen of data is sent to CICS and the next screen is received in reply. Use the properties provided by this class to indicate the AID key that should be sent to CICS and to set the cursor position.
The properties that can be set are as follows:
- interactionVerb
- This allows you to control how data is flowed. SEND_AND_RECEIVE sends a screen to the server and receives a screen back. SEND will just send a screen to the server and RECEIVE will return the last screen received from the server back.
- FunctionName
- The transaction to run
- AID
- the AID to be sent to CICS. The default value is enter.
- cursorRow
- the screen row at which the cursor should be placed. The first row is 1.
- cursorColumn
- the screen column at which the cursor should be placed. The first column is 1.
- outputAttributeType
- This allows you to control what will be held in the attribute byte for the field on a returned screen. The options available are ATTRIBUTE_NONE, ATTRIBUTE_BASE, ATTRIBUTE_FOREGROUNDCOLOR, ATTRIBUTE_BACKGROUNDCOLOR, ATTRIBUTE_HIGHLIGHT, ATTRIBUTE_TRANSPARENCY, ATTRIBUTE_MARKER.
The properties that will return information are as follows:
- cursorRow
- the screen row at which the cursor is at. The first row is 1.
- cursorColumn
- the screen column at which the cursor is at. The first column is 1.
- screenDepth
- The depth of this screen
- screenWidth
- The width of this screen
- termId
- The terminal id that was interacted with
- mapName
- The screen map name
- mapSetName
- The screen mapset name
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
Selects Attribute byte for field to contain the background colour attribute for streamable recordsstatic final int
Selects Attribute byte for field to contain the base attribute for streamable recordsstatic final int
Selects Attribute byte for field to contain the foreground colour attribute for streamable recordsstatic final int
Selects Attribute byte for field to contain the highlight attribute for streamable recordsstatic final int
Selects Attribute byte for field to contain a field marker byte.static final int
Selects Attribute byte for field to contain 0x20 for streamable recordsstatic final int
Selects Attribute byte for field to contain the transparency attribute for streamable recordsstatic final String
static final byte
defines the byte which represents a field markerFields inherited from interface jakarta.resource.cci.InteractionSpec
SYNC_RECEIVE, SYNC_SEND, SYNC_SEND_RECEIVE
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncom.ibm.ctg.epi.AID
getAID()
Returns the AID property.int
Returns the cursor column property.int
Returns the cursor row property.returns the map namereturns the mapset nameint
returns the outputAttributetype (int) value.int
returns the screen depth (int) value.int
returns the screen width (int) value.returns the terminal idvoid
setAID
(com.ibm.ctg.epi.AID newAid) Sets the AID property.void
setCursorColumn
(int col) Sets the cursor column property.void
setCursorRow
(int row) Sets the cursor row property.void
setOutputAttributeType
(int outType) Sets the outputAttributeType (int) value.toString()
returns a string representation of this instance, in this case it lists the contents of the write properties.Methods inherited from class com.ibm.jakarta.connector2.cics.CICSInteractionSpec
addPropertyChangeListener, getFunctionName, getInteractionVerb, removePropertyChangeListener, setFunctionName, setInteractionVerb
-
Field Details
-
CLASS_VERSION
- See Also:
-
ATTRIBUTE_NONE
public static final int ATTRIBUTE_NONESelects Attribute byte for field to contain 0x20 for streamable records- See Also:
-
ATTRIBUTE_BASE
public static final int ATTRIBUTE_BASESelects Attribute byte for field to contain the base attribute for streamable records- See Also:
-
ATTRIBUTE_FOREGROUNDCOLOR
public static final int ATTRIBUTE_FOREGROUNDCOLORSelects Attribute byte for field to contain the foreground colour attribute for streamable records- See Also:
-
ATTRIBUTE_BACKGROUNDCOLOR
public static final int ATTRIBUTE_BACKGROUNDCOLORSelects Attribute byte for field to contain the background colour attribute for streamable records- See Also:
-
ATTRIBUTE_HIGHLIGHT
public static final int ATTRIBUTE_HIGHLIGHTSelects Attribute byte for field to contain the highlight attribute for streamable records- See Also:
-
ATTRIBUTE_TRANSPARENCY
public static final int ATTRIBUTE_TRANSPARENCYSelects Attribute byte for field to contain the transparency attribute for streamable records- See Also:
-
ATTRIBUTE_MARKER
public static final int ATTRIBUTE_MARKERSelects Attribute byte for field to contain a field marker byte. Useful for generic field locating- See Also:
-
MARKER_BYTE
public static final byte MARKER_BYTEdefines the byte which represents a field marker- See Also:
-
-
Constructor Details
-
EPIInteractionSpec
public EPIInteractionSpec()Constructs an EPIInteractionSpec Object
-
-
Method Details
-
getAID
public com.ibm.ctg.epi.AID getAID()Returns the AID property.- Returns:
- the AID property
-
setAID
public void setAID(com.ibm.ctg.epi.AID newAid) Sets the AID property.- Parameters:
newAid
- the AID property
-
getCursorRow
public int getCursorRow()Returns the cursor row property.- Returns:
- the cursor row property
-
setCursorRow
public void setCursorRow(int row) Sets the cursor row property.- Parameters:
row
- the cursor row property
-
getCursorColumn
public int getCursorColumn()Returns the cursor column property.- Returns:
- the cursor column property
-
setCursorColumn
public void setCursorColumn(int col) Sets the cursor column property.- Parameters:
col
- the cursor column property
-
getOutputAttributeType
public int getOutputAttributeType()returns the outputAttributetype (int) value.- Returns:
- int the outputAttribyteType value
-
setOutputAttributeType
public void setOutputAttributeType(int outType) Sets the outputAttributeType (int) value. This defines what will be contained in the attribute byte of a field. You can select many options which include just setting it to a 0x20 to returning the BASE attribute the foreground and background colour attribute. The various enumerations allowed start with "ATTRIBUTE_".- Parameters:
outType
- the new value for the property
-
getScreenDepth
public int getScreenDepth()returns the screen depth (int) value.- Returns:
- int the screen depth value
-
getScreenWidth
public int getScreenWidth()returns the screen width (int) value.- Returns:
- int the screen width value
-
getTermId
returns the terminal id- Returns:
- String the terminal id
-
getMapName
returns the map name- Returns:
- String the map name
-
getMapSetName
returns the mapset name- Returns:
- String the mapset name
-
toString
returns a string representation of this instance, in this case it lists the contents of the write properties.- Overrides:
toString
in classCICSInteractionSpec
- Returns:
- String
-