Package com.softwaremining.vendors.cics.constants

Class CicsCodes

java.lang.Object
com.softwaremining.vendors.cics.constants.CicsCodes
Direct Known Subclasses:
CicsConditionManager, CicsDBResponseCodes
public class CicsCodes extends Object
Cics Response codes. 2006-08-23 : A new set of values have been assigned to ALL constants. This is based on conversion of HEX values presented on IBM Documentation page: http://publib.boulder.ibm.com/infocenter/cicsts/v3r1/index.jsp?topic=/com.ibm.cics.ts31.doc/dfhp4/topics/dfhp4_eibfields.htm 2006-08- (ref-a) : The original values are taken from IBM documentation pages such as : http://publib.boulder.ibm.com/infocenter/cicsts/v3r1/topic/com.ibm.cics.ts31.doc/dfhp4/commands/dfhp4_read.htm

  • Field Details

    • ERROR

      public static final int ERROR
      default program handler
      See Also:

    • NORMAL

      public static final int NORMAL
      *** NOT VALIDATED AGAINST IBM CODES **** Normal termination of operation Default action: terminate the task abnormally
      See Also:

    • EOC

      public static final int EOC
      Deprecated.
      EOC has no function, is not used/set by the framework.
      End-Of-Chain - used in CICS RECEIVE. In CICS Long pieces of data returned from RECEIVE is broken down into Request-Units (RU). Long messages maybe broken onto many RUs which are chained together. CICS can tell the application when the last RU has been received.
      See Also:

    • NOHANDLE

      public static final int NOHANDLE
      to do
      See Also:

    • ENDDATA

      public static final int ENDDATA
      See Also:

    • DISABLED

      public static final int DISABLED
      A file is disabled because it was initially defined as disabled and has not since been enabled. A file is disabled because it has been disabled by a SET FILE or a CEMT SET FILE command. Used in read/write Default action: terminate the task abnormally
      See Also:

    • RESP2_CODE_DISABLED

      public static final int RESP2_CODE_DISABLED
      See Also:

    • DUPKEY

      public static final int DUPKEY
      A record is retrieved by way of an alternate index with the NONUNIQUEKEY attribute, and another alternate index record with the same key follows In assembler language, if the SET option is being used, the specified register has not been set, but can be loaded from DFHEITP1. Default action: terminate the task abnormally.
      See Also:

    • RESP2_CODE_DUPKEY

      public static final int RESP2_CODE_DUPKEY
      See Also:

    • FILENOTFOUND

      public static final int FILENOTFOUND
      The file name supplied in the FILE option cannot be found in the FCT. Default action: terminate the task abnormally.
      See Also:

    • RESP2_CODE_ILLOGIC

      public static final int RESP2_CODE_ILLOGIC
      A VSAM error occurs that does not fall within one of the other CICS response categories. (See EIBRCODE in the description of the EXEC interface block, EXEC interface block.) For user-maintained data tables, this condition occurs only for a non-UPDATE READ during loading when CICS has attempted to retrieve the record from the source data set. Default action: terminate the task abnormally.
      See Also:

    • ILLOGIC

      public static final int ILLOGIC
      See Also:

    • INVREQ

      public static final int INVREQ
      (not-used) INvalid-REQuest.. Used in CICS SEND / Receive for details please see http://publib.boulder.ibm.com/infocenter/cicsts/v3r1/index.jsp?topic=/com.ibm.cics.ts31.doc/dfhp3/dfhp3b00134.htm
      See Also:

    • INVERRTERM

      public static final int INVERRTERM
      (not-used) used in CICS Routing - system does not require invalid-terminal / routing to terminal is not supported
      See Also:

    • RTEFAIL

      public static final int RTEFAIL
      (not-used) used in CICS Routing - system does not require invalid-terminal / routing to terminal is not supported
      See Also:

    • ITEMERR

      public static final int ITEMERR
      Not handled yet For CICS WRITEQ: Occurs for the following conditions: The item number that is specified or implied by a WRITEQ TS command with the REWRITE option is not valid (that is, outside the range of entry numbers that are assigned for the queue). The maximum number of items (32767) is exceeded. FOr CICS READQ: If the item number that is specified or implied by a READQ TS command is not valid (that is, it is outside the range of entry numbers assigned for the queue) If an end of file marker is encountered on a READQ TS NEXT command If this is the first time the queue has been read on a READQ TS NEXT command
      See Also:

    • IOERR

      public static final int IOERR
      For VSAM files, IOERR normally indicates a hardware error. For user-maintained data tables, this condition occurs only for a non-UPDATE READ during loading when CICS has attempted to retrieve the record from the source data set. For a coupling facility data table, an IOERR indicates a bad response returned from a coupling facility access. (Further information is available in the EXEC interface block, EXEC interface block.) Default action: terminate the task abnormally.
      See Also:

    • ISCINVREQ

      public static final int ISCINVREQ
      The remote system indicates a failure that does not correspond to a known condition. Default action: terminate the task abnormally.
      See Also:

    • LENGERR

      public static final int LENGERR
      10 - Neither the LENGTH option nor the SET option is specified on a READ command for a file with variable-length records or for a BDAM file with variable-length or undefined-format records. 11 - The length of a record read with the INTO option specified exceeds the value specified in the LENGTH option; the record is truncated, and the data area supplied in the LENGTH option is set to the actual length of the record. 13 - An incorrect length is specified for a file with fixed-length records. Default action: terminate the task abnormally.
      See Also:

    • LOADING

      public static final int LOADING
      The request cannot be satisfied because it is issued against a data table that is still being loaded. The condition can be raised for one of the following reasons: The READ specifies a record that has not yet been loaded into a coupling facility data table. Records can be read or modified while a CFDT is loading only if the requested key is within the range of those records already loaded. The LOADING response can also be returned for a coupling facility data table that has failed during loading. For more information about what happens if the load for a coupling facility data table fails, see the description of the XDTLC global user exit in the CICS Customization Guide. The READ specifies the UPDATE option for a user-maintained data table. A user-maintained data table cannot be modified during loading. The READ specifies the GENERIC or GTEQ options for a user-maintained data table. While a UMT is being loaded, you can use read requests with precise keys only. If your application programs encounter the LOADING condition persistently or too frequently, check that this is not caused by conflicting file definitions that reference the same data set. Default action: terminate the task abnormally.
      See Also:

    • LOCKED

      public static final int LOCKED
      An attempt is being made to read a record either specifying the UPDATE keyword, or specifying (explicitly or implicitly) CONSISTENT or REPEATABLE, but the record is locked by a retained lock (see Retained and active locks). The LOCKED condition can also occur for a READ UPDATE request to a recoverable CFDT that uses the locking model, if the record being read is locked by a retained lock. See the CICS Recovery and Restart Guide for information about investigating retained locks on records in a coupling facility data table. Default action: abend the task with code AEX8.
      See Also:

    • RECORDBUSY

      public static final int RECORDBUSY
      See Also:

    • ENQBUSY

      public static final int ENQBUSY
      See Also:

    • NOTAUTH

      public static final int NOTAUTH
      A resource security check has failed on FILE(filename). Default action: terminate the task abnormally.
      See Also:

    • NOTFND

      public static final int NOTFND
      An attempt to retrieve a record based on the search argument provided is unsuccessful. For data tables, this condition occurs if an attempt to read a record is unsuccessful because there is no entry with the specified key in the data table. This does not mean that there is no such record in the source data set (if the table was created from one); it may be that such a record is present but was either rejected during initial loading by the user exit XDTRD, or was subsequently deleted from the data table. For remote files, this condition occurs if an attempt to read a record is made without keylength specified either in the application or the file definition, and the actual key is longer than 4 characters. Default action: terminate the task abnormally.
      See Also:

    • ENDFILE

      public static final int ENDFILE
      An end-of-file condition is detected during the browse. RESP2 values: 90
      See Also:

    • EOF

      public static final int EOF
      See Also:

    • NOTOPEN

      public static final int NOTOPEN
      NOTOPEN (RESP2 60) is returned for one of the following reasons: The requested file is CLOSED and UNENABLED. The CLOSED, UNENABLED state is reached after a CLOSE request has been received against an OPEN ENABLED file and the file is no longer in use. You can also make CLOSED, UNENABLED the initial state, by specifying STATUS(UNENABLED) and OPENTIME(FIRSTREF) on the FILE resource definition. (For BDAM files, you use the FILSTAT parameter of DFHFCT TYPE=FILE.) The requested file is OPEN and in use by other transactions, but a CLOSE request against the file has been received. A READ command is issued against a data set that is quiesced, or is being quiesced, as a result of a SET DSNAME QUIESCED or IMMQUIESCED command. The requested file is CLOSED and ENABLED, so CICS has tried to open the file as part of executing the request. This file open has failed for some reason. You should examine the console for messages that explain why the file open has been unsuccessful. This condition does not occur if the request is made to a CLOSED, DISABLED file. In this case, the DISABLED condition occurs. Default action: terminate the task abnormally.
      See Also:

    • RESP2_CODE_NOTOPEN

      public static final int RESP2_CODE_NOTOPEN
      See Also:

    • RECORD_BUSY

      public static final int RECORD_BUSY
      The NOSUSPEND keyword is specified and the record is locked by an active lock (see Retained and active locks). Default action: abend the task with code AEX9.
      See Also:

    • RESP2_CODE_RECORD_BUSY

      public static final int RESP2_CODE_RECORD_BUSY
      See Also:

    • SYSIDERR

      public static final int SYSIDERR
      See Also:

    • RESP2_CODE_SYSIDERR

      public static final int[] RESP2_CODE_SYSIDERR

    • RESP2_CODE_DUPREC

      public static final int RESP2_CODE_DUPREC
      An attempt is made to add a record to a data set by referring to a file, or a path over a file (with the UNIQUEKEY attribute), in which the same key already exists. This condition is also raised for a coupling facility data table that uses the contention model, even if another task has read the record with the same key for update. (For a coupling facility data table that uses the locking model, and for all other kinds of files, if another task has read the record for update, it is locked, and the WRITE request waits for the lock to be released, rather than returning a DUPREC response immediately.) Default action: terminate the task abnormally.
      See Also:

    • DUPREC

      public static final int DUPREC
      See Also:

    • SUPPRESSED

      public static final int SUPPRESSED
      A user exit program that is invoked at the XDTAD exit point decides not to add the record to the user-maintained or coupling facility data table. Default action: terminate the task abnormally.
      See Also:

    • QIDERR

      public static final int QIDERR
      READQ TS Error Occurs if the specified queue cannot be found in either main or auxiliary storage
      See Also:

    • SYSBUSY

      public static final int SYSBUSY
      See Also:

    • MAPFAIL

      public static final int MAPFAIL
      This condition is fired during a CICS RECEIVE when operator did not change/enter any field-values Not sure what sets this The value has been set from http://publib.boulder.ibm.com/infocenter/cicsts/v3r1/index.jsp?topic=/com.ibm.cics.ts31.doc/dfhp4/topics/dfhp4_eibfields.htm
      See Also:

    • INVMPSZ

      public static final int INVMPSZ
      Not Supported yet
      See Also:

    • PGMIDERR

      public static final int PGMIDERR
      to do Not sure what sets this The value has been set from http://publib.boulder.ibm.com/infocenter/cicsts/v3r1/index.jsp?topic=/com.ibm.cics.ts31.doc/dfhp4/topics/dfhp4_eibfields.htm
      See Also:

    • RETPAGE

      public static final int RETPAGE
      (not-used) This is used in CICS SEND occurs if the SET option is specified and a completed page is ready for return to the application program. Default action: return control to the application program at the point immediately following the BMS SEND TEXT command
      See Also:

    • WRBRK

      public static final int WRBRK
      (not-used) This is used in CICS SEND occurs if a SEND command is interrupted by the terminal operator pressing the ATTN key. It applies only to the 2741 Communication Terminal, and only if write break is supported for CICS.
      See Also:

    • INVLDC

      public static final int INVLDC
      (not-used) This is used in CICS SEND occurs if the specified LDC mnemonic is not included in the LDC list for the logical unit. Default action: terminate the task abnormally.
      See Also:

    • TRANSIDERR

      public static final int TRANSIDERR
      occurs if the transaction identifier specified in a START command cannot be found in the program control table.
      See Also:

    • TERMIDERR

      public static final int TERMIDERR
      See Also:

    • OPENERR

      public static final int OPENERR
      Used in SPOOL
      See Also:

    • CONTAINERERR

      public static final int CONTAINERERR
      See Also:

    • CHANNELERR

      public static final int CHANNELERR
      See Also:

    • DSIDERR

      public static final int DSIDERR
      unrecoverable error Unhandled - not used, error code 300 is not correct
      See Also:

    • USERIDERR

      public static final int[] USERIDERR

    • OVERFLOW

      public static final int OVERFLOW
      Not handled yet - used in statements such as EXEC CICS HANDLE CONDITION OVERFLOW ... EXEC CICS STARTBR
      See Also:

    • EODS

      public static final int EODS
      See Also:

    • INBFMH

      public static final int INBFMH
      See Also:

    • SIGNAL

      public static final int SIGNAL
      See Also:

    • TERMERR

      public static final int TERMERR
      See Also:

    • NOSPACE

      public static final int NOSPACE
      See Also:

    • RCODE_INVREQ

      public static String RCODE_INVREQ

    • RCODE_EOF

      public static String RCODE_EOF

    • RCODE_EODS

      public static String RCODE_EODS

    • RCODE_ENDINPT

      public static String RCODE_ENDINPT

    • RCODE_SYSIDERR

      public static String RCODE_SYSIDERR

    • RCODE_SESSIONERR

      public static String RCODE_SESSIONERR

    • RCODE_SYSBUSY

      public static String RCODE_SYSBUSY

    • RCODE_SESSBUSY

      public static String RCODE_SESSBUSY

    • RCODE_NOTALLOC

      public static String RCODE_NOTALLOC

    • RCODE_LENGERR

      public static String RCODE_LENGERR

    • RCODE_WRBRK

      public static String RCODE_WRBRK

    • RCODE_RDATT

      public static String RCODE_RDATT

    • RCODE_SIGNAL

      public static String RCODE_SIGNAL

    • RCODE_TERMIDERR

      public static String RCODE_TERMIDERR

    • RCODE_NOPASSBKRD

      public static String RCODE_NOPASSBKRD

    • RCODE_NOPASSBKWR

      public static String RCODE_NOPASSBKWR

    • RCODE_IGREQCD

      public static String RCODE_IGREQCD

    • RCODE_CBIDERR

      public static String RCODE_CBIDERR

    • RCODE_PARTNERIDERR

      public static String RCODE_PARTNERIDERR

    • RCODE_NETNAMEIDERR

      public static String RCODE_NETNAMEIDERR

    • RCODE_TERMERR

      public static String RCODE_TERMERR

    • RCODE_EOC

      public static String RCODE_EOC

    • RCODE_INBFMH

      public static String RCODE_INBFMH

    • RCODE_NOSTART

      public static String RCODE_NOSTART

    • RCODE_NONVAL

      public static String RCODE_NONVAL

    • RCODE_FILENOTFOUND

      public static String RCODE_FILENOTFOUND

    • RCODE_ILLOGIC

      public static String RCODE_ILLOGIC

    • RCODE_LOCKED

      public static String RCODE_LOCKED

    • RCODE_RECORDBUSY

      public static String RCODE_RECORDBUSY

    • RCODE_NOTOPEN

      public static String RCODE_NOTOPEN

    • RCODE_DISABLED

      public static String RCODE_DISABLED

    • RCODE_ENDFILE

      public static String RCODE_ENDFILE

    • RCODE_IOERR

      public static String RCODE_IOERR

    • RCODE_NOTFND

      public static String RCODE_NOTFND

    • RCODE_DUPREC

      public static String RCODE_DUPREC

    • RCODE_NOSPACE

      public static String RCODE_NOSPACE

    • RCODE_DUPKEY

      public static String RCODE_DUPKEY

    • RCODE_SUPPRESSED

      public static String RCODE_SUPPRESSED

    • RCODE_LOADING

      public static String RCODE_LOADING

    • RCODE_ISCINVREQ

      public static String RCODE_ISCINVREQ

    • RCODE_NOTAUTH

      public static String RCODE_NOTAUTH

    • RCODE_QZERO

      public static String RCODE_QZERO

    • RCODE_QIDERR

      public static String RCODE_QIDERR

    • RCODE_QBUSY

      public static String RCODE_QBUSY

    • RCODE_ITEMERR

      public static String RCODE_ITEMERR

    • RCODE_NOSTG

      public static String RCODE_NOSTG

    • RCODE_PGMIDERR

      public static String RCODE_PGMIDERR

    • RCODE_RESUNAVAIL

      public static String RCODE_RESUNAVAIL

    • RCODE_CHANNELERR

      public static String RCODE_CHANNELERR

    • RCODE_ENDDATA

      public static String RCODE_ENDDATA

    • RCODE_TRANSIDERR

      public static String RCODE_TRANSIDERR

    • RCODE_EXPIRED

      public static String RCODE_EXPIRED

    • RCODE_USERIDERR

      public static String RCODE_USERIDERR

    • RCODE_ENVDEFERR

      public static String RCODE_ENVDEFERR

    • RCODE_ENQBUSY

      public static String RCODE_ENQBUSY

    • RCODE_JIDERR

      public static String RCODE_JIDERR

    • RCODE_NOJBUFSP

      public static String RCODE_NOJBUFSP

    • RCODE_ROLLEDBACK

      public static String RCODE_ROLLEDBACK

    • RCODE_RETPAGE

      public static String RCODE_RETPAGE

    • RCODE_MAPFAIL

      public static String RCODE_MAPFAIL

    • RCODE_INVMPSZ

      public static String RCODE_INVMPSZ

    • RCODE_INVERRTERM

      public static String RCODE_INVERRTERM

    • RCODE_RTESOME

      public static String RCODE_RTESOME

    • RCODE_RTEFAIL

      public static String RCODE_RTEFAIL

    • RCODE_PARTNFAIL

      public static String RCODE_PARTNFAIL

    • RCODE_INVPARTN

      public static String RCODE_INVPARTN

    • RCODE_INVPARTNSET

      public static String RCODE_INVPARTNSET

    • RCODE_INVLDC

      public static String RCODE_INVLDC

    • RCODE_UNEXPIN

      public static String RCODE_UNEXPIN

    • RCODE_TSIOERR

      public static String RCODE_TSIOERR

    • RCODE_OVERFLOW

      public static String RCODE_OVERFLOW

    • RCODE_IGREQID

      public static String RCODE_IGREQID

    • RCODE_DSSTAT

      public static String RCODE_DSSTAT

    • RCODE_FUNCERR

      public static String RCODE_FUNCERR

    • RCODE_SELNERR

      public static String RCODE_SELNERR

    • RCODE_INVEXITREQ

      public static String RCODE_INVEXITREQ

    • RCODE_NOSPOOL

      public static String RCODE_NOSPOOL

    • RCODE_ALLOCERR

      public static String RCODE_ALLOCERR

    • RCODE_STRELERR

      public static String RCODE_STRELERR

    • RCODE_OPENERR

      public static String RCODE_OPENERR

    • RCODE_SPOLBUSY

      public static String RCODE_SPOLBUSY

    • RCODE_SPOLERR

      public static String RCODE_SPOLERR

    • RCODE_NODEIDERR

      public static String RCODE_NODEIDERR

  • Constructor Details

    • CicsCodes

      public CicsCodes()

  • Method Details

    • isInRange

      public static boolean isInRange(BigDecimal theValue, int[] range)

    • isInRange

      public static boolean isInRange(long theValue, int[] range)

    • isInRange

      public static boolean isInRange(BigDecimal theValue, int range)

    • isInRange

      public static boolean isInRange(long theValue, long expectedValue)