CICS® Transaction Gateway Programming Reference v1.1.0.0

com.ibm.ctg.client
Interface EPIReturnCodes

All Known Implementing Classes:
EPIRequest, EPIRequestException, EPIResourceAdapterRc, EPITranFailedException, EPITxnFailedException

public interface EPIReturnCodes

Constant values representing EPI return codes.


Field Summary
static java.lang.String[] astrCics_Rc
          Error code enumeration.
static int EPI_ERR_ABENDED
          A read timeout occurred for the current transaction.
static int EPI_ERR_ADDTYPE_INVALID
          The Terminal Add Type was invalid (in CICS client).
static int EPI_ERR_ALREADY_INSTALLED
          The terminal ID is already installed.
static int EPI_ERR_ATI_ACTIVE
          An ATI transaction is already active.
static int EPI_ERR_ATI_STATE
          Invalid atiState provided.
static int EPI_ERR_BAD_INDEX
          Invalid termIndex.
static int EPI_ERR_CCSID_INVALID
          The CCSid supplied was invalid.
static int EPI_ERR_FAILED
          The function failed for an unexpected reason.
static int EPI_ERR_IN_CALLBACK
          On the CICS client, the call was made from a callback routine.
static int EPI_ERR_IS_INIT
          The EPI is already initialized.
static int EPI_ERR_MAX_SESSIONS
          Not enough communication resources to satisfy request.
static int EPI_ERR_MAX_SYSTEMS
          Reached limit on maximum number of systems.
static int EPI_ERR_MAX_TERMS
          Maximum number of terminals reached.
static int EPI_ERR_MODELID_INVALID
          The model ID was invalid.
static int EPI_ERR_MORE_DATA
          getEvent supplied data array too small, data has been truncated.
static int EPI_ERR_MORE_EVENTS
          There are more events outstanding.
static int EPI_ERR_MORE_SYSTEMS
          Insufficient space for server list.
static int EPI_ERR_NO_CICS
          No CICS system available.
static int EPI_ERR_NO_CONVERSE
          No reply expected by the terminal resource.
static int EPI_ERR_NO_DATA
          No reply data was provided.
static int EPI_ERR_NO_EVENT
          There are no events outstanding.
static int EPI_ERR_NO_SYSTEMS
          No CICS servers can be located.
static int EPI_ERR_NOT_3270_DEVICE
          Not a 3270 device.
static int EPI_ERR_NOT_INIT
          The EPI environment has not been initialized.
static int EPI_ERR_NULL_PARM
          termIndex was null (in CICS client).
static int EPI_ERR_NULL_PASSWORD
          The password supplied was an empty string or NULL.
static int EPI_ERR_NULL_USERID
          The user ID supplied was an empty string or NULL.
static int EPI_ERR_PASSWORD_INVALID
          Not returned by the CICS Transaction Gateway Java API.
static int EPI_ERR_RESOURCE_SHORTAGE
          Resource shortage, e.g.
static int EPI_ERR_RESPONSE_TIMEOUT
          The terminal did not install within the given timeout.
static int EPI_ERR_SECURITY
          A server security error occurred, such as an incorrect user ID or password.
static int EPI_ERR_SENSE_CODE
          An invalid sense code was provided.
static int EPI_ERR_SERVER_BUSY
          The CICS server was too busy to handle the request.
static int EPI_ERR_SERVER_DOWN
          The CICS server is not available.
static int EPI_ERR_SIGNON_NOT_POSS
          A request for a signon capable terminal was not possible.
static int EPI_ERR_SIGNONCAP_INVALID
          The Terminal Signon Capability flag was invalid (in CICS client).
static int EPI_ERR_SYSTEM
          The specified server is not known.
static int EPI_ERR_TERMID_INVALID
          The requested terminal ID was invalid.
static int EPI_ERR_TRAN_ACTIVE
          There is a transaction running against the terminal resource, or there are unprocessed events.
static int EPI_ERR_TTI_ACTIVE
          An EPI transaction is already active.
static int EPI_ERR_USERID_INVALID
          Not returned by the CICS Transaction Gateway Java API.
static int EPI_ERR_VERSION
          The CICS EPI cannot support the EPI version requested.
static int EPI_ERR_WAIT
          Invalid waitState.
static int EPI_NORMAL
          The function completed normally.
 

Field Detail

EPI_NORMAL

static final int EPI_NORMAL
The function completed normally.

See Also:
Constant Field Values

EPI_ERR_NOT_INIT

static final int EPI_ERR_NOT_INIT
The EPI environment has not been initialized.

See Also:
Constant Field Values

EPI_ERR_BAD_INDEX

static final int EPI_ERR_BAD_INDEX
Invalid termIndex.

See Also:
Constant Field Values

EPI_ERR_FAILED

static final int EPI_ERR_FAILED
The function failed for an unexpected reason.

See Also:
Constant Field Values

EPI_ERR_VERSION

static final int EPI_ERR_VERSION
The CICS EPI cannot support the EPI version requested.

See Also:
Constant Field Values

EPI_ERR_IS_INIT

static final int EPI_ERR_IS_INIT
The EPI is already initialized.

See Also:
Constant Field Values

EPI_ERR_NO_SYSTEMS

static final int EPI_ERR_NO_SYSTEMS
No CICS servers can be located.

See Also:
Constant Field Values

EPI_ERR_MORE_SYSTEMS

static final int EPI_ERR_MORE_SYSTEMS
Insufficient space for server list.

See Also:
Constant Field Values

EPI_ERR_MAX_TERMS

static final int EPI_ERR_MAX_TERMS
Maximum number of terminals reached.

See Also:
Constant Field Values

EPI_ERR_SYSTEM

static final int EPI_ERR_SYSTEM
The specified server is not known.

See Also:
Constant Field Values

EPI_ERR_TRAN_ACTIVE

static final int EPI_ERR_TRAN_ACTIVE
There is a transaction running against the terminal resource, or there are unprocessed events.

See Also:
Constant Field Values

EPI_ERR_NO_DATA

static final int EPI_ERR_NO_DATA
No reply data was provided.

See Also:
Constant Field Values

EPI_ERR_TTI_ACTIVE

static final int EPI_ERR_TTI_ACTIVE
An EPI transaction is already active.

See Also:
Constant Field Values

EPI_ERR_ATI_ACTIVE

static final int EPI_ERR_ATI_ACTIVE
An ATI transaction is already active.

See Also:
Constant Field Values

EPI_ERR_NO_CONVERSE

static final int EPI_ERR_NO_CONVERSE
No reply expected by the terminal resource.

See Also:
Constant Field Values

EPI_ERR_ATI_STATE

static final int EPI_ERR_ATI_STATE
Invalid atiState provided.

See Also:
Constant Field Values

EPI_ERR_NO_EVENT

static final int EPI_ERR_NO_EVENT
There are no events outstanding.

See Also:
Constant Field Values

EPI_ERR_MORE_EVENTS

static final int EPI_ERR_MORE_EVENTS
There are more events outstanding.

See Also:
Constant Field Values

EPI_ERR_MORE_DATA

static final int EPI_ERR_MORE_DATA
getEvent supplied data array too small, data has been truncated.

See Also:
Constant Field Values

EPI_ERR_WAIT

static final int EPI_ERR_WAIT
Invalid waitState.

See Also:
Constant Field Values

EPI_ERR_SERVER_DOWN

static final int EPI_ERR_SERVER_DOWN
The CICS server is not available.

See Also:
Constant Field Values

EPI_ERR_SENSE_CODE

static final int EPI_ERR_SENSE_CODE
An invalid sense code was provided.

See Also:
Constant Field Values

EPI_ERR_SECURITY

static final int EPI_ERR_SECURITY
A server security error occurred, such as an incorrect user ID or password.

See Also:
Constant Field Values

EPI_ERR_IN_CALLBACK

static final int EPI_ERR_IN_CALLBACK
On the CICS client, the call was made from a callback routine.

See Also:
Constant Field Values

EPI_ERR_NULL_PARM

static final int EPI_ERR_NULL_PARM
termIndex was null (in CICS client).

See Also:
Constant Field Values

EPI_ERR_ADDTYPE_INVALID

static final int EPI_ERR_ADDTYPE_INVALID
The Terminal Add Type was invalid (in CICS client).

See Also:
Constant Field Values

EPI_ERR_SIGNONCAP_INVALID

static final int EPI_ERR_SIGNONCAP_INVALID
The Terminal Signon Capability flag was invalid (in CICS client).

See Also:
Constant Field Values

EPI_ERR_RESPONSE_TIMEOUT

static final int EPI_ERR_RESPONSE_TIMEOUT
The terminal did not install within the given timeout.

See Also:
Constant Field Values

EPI_ERR_SIGNON_NOT_POSS

static final int EPI_ERR_SIGNON_NOT_POSS
A request for a signon capable terminal was not possible.

See Also:
Constant Field Values

EPI_ERR_TERMID_INVALID

static final int EPI_ERR_TERMID_INVALID
The requested terminal ID was invalid.

See Also:
Constant Field Values

EPI_ERR_MODELID_INVALID

static final int EPI_ERR_MODELID_INVALID
The model ID was invalid.

See Also:
Constant Field Values

EPI_ERR_NOT_3270_DEVICE

static final int EPI_ERR_NOT_3270_DEVICE
Not a 3270 device.

See Also:
Constant Field Values

EPI_ERR_ALREADY_INSTALLED

static final int EPI_ERR_ALREADY_INSTALLED
The terminal ID is already installed.

See Also:
Constant Field Values

EPI_ERR_USERID_INVALID

static final int EPI_ERR_USERID_INVALID
Not returned by the CICS Transaction Gateway Java API.

See Also:
Constant Field Values

EPI_ERR_PASSWORD_INVALID

static final int EPI_ERR_PASSWORD_INVALID
Not returned by the CICS Transaction Gateway Java API.

See Also:
Constant Field Values

EPI_ERR_NULL_USERID

static final int EPI_ERR_NULL_USERID
The user ID supplied was an empty string or NULL.

See Also:
Constant Field Values

EPI_ERR_NULL_PASSWORD

static final int EPI_ERR_NULL_PASSWORD
The password supplied was an empty string or NULL.

See Also:
Constant Field Values

EPI_ERR_CCSID_INVALID

static final int EPI_ERR_CCSID_INVALID
The CCSid supplied was invalid.

See Also:
Constant Field Values

EPI_ERR_SERVER_BUSY

static final int EPI_ERR_SERVER_BUSY
The CICS server was too busy to handle the request.

See Also:
Constant Field Values

EPI_ERR_ABENDED

static final int EPI_ERR_ABENDED
A read timeout occurred for the current transaction.

See Also:
Constant Field Values

EPI_ERR_RESOURCE_SHORTAGE

static final int EPI_ERR_RESOURCE_SHORTAGE
Resource shortage, e.g. not enough SNA sessions.

See Also:
Constant Field Values

EPI_ERR_NO_CICS

static final int EPI_ERR_NO_CICS
No CICS system available.

See Also:
Constant Field Values

EPI_ERR_MAX_SYSTEMS

static final int EPI_ERR_MAX_SYSTEMS
Reached limit on maximum number of systems.

See Also:
Constant Field Values

EPI_ERR_MAX_SESSIONS

static final int EPI_ERR_MAX_SESSIONS
Not enough communication resources to satisfy request.

See Also:
Constant Field Values

astrCics_Rc

static final java.lang.String[] astrCics_Rc
Error code enumeration. Not to be used directly.


©Copyright IBM Corp. 1994, 2014
Legal