CICS® Transaction Gateway Base API Programming Reference v8.1.0.2

com.ibm.ctg.client
Class GatewayRequest

java.lang.Object
  extended by com.ibm.ctg.client.GatewayRequest
All Implemented Interfaces:
GatewayReturnCodes
Direct Known Subclasses:
CicsCpRequest, ECIRequest, EPIRequest, ESIRequest

public class GatewayRequest
extends java.lang.Object
implements GatewayReturnCodes

This is the root class that all the different types of Gateway request are built off. It simply contains the request type and the message ID, and provides serialisation methods to write/read the message header. GatewayRequest now include some expanded types


Field Summary
 
Fields inherited from interface com.ibm.ctg.client.GatewayReturnCodes
astrGateway_Rc, ERROR_BASE, ERROR_CONNECTION_FAILED, ERROR_EXIT_RETRY_INVALID, ERROR_GATEWAY_BACK_LEVEL, ERROR_GATEWAY_CLOSED, ERROR_GATEWAY_EXCEPTION, ERROR_INVALID_REQUEST_TYPE, ERROR_NOT_AUTHORIZED, ERROR_NOT_SUPPORTED, ERROR_REPLY_MISMATCH, ERROR_UNKNOWN_REQUEST_TYPE, ERROR_WORK_WAS_REFUSED, ERROR_XA_SUPPORT_NOT_ENABLED, strINVALID_GATEWAY_RC
 
Method Summary
 int getGatewayRc()
          Gets the gateway return code set in this object.
 java.lang.String getGatewayRcString()
          Gets the Gateway return code set in this object and returns it as a String.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getGatewayRc

public int getGatewayRc()
Gets the gateway return code set in this object.

Returns:
The return code

getGatewayRcString

public java.lang.String getGatewayRcString()
Gets the Gateway return code set in this object and returns it as a String.

The String returned is the name of the appropriate Java constant e.g. if the iGateway_Rc is ERROR_CONNECTION_FAILED, then the String returned will be "ERROR_CONNECTION_FAILED". If the iGateway_Rc is unknown then the String returned will be "ERROR_UNKNOWN_GATEWAY_RC".

Returns:
String The return code

©Copyright IBM Corp. 1994, 2012
Legal