Mapping Foundation Class methods to EXEC CICS calls

The following table shows the correspondence between CICS® calls made using the Foundation Classes and the equivalent EXEC CICS API calls.

Table 1. IccAbendData Class
Method EXEC CICS
abendCode ASSIGN ABCODE
ASRAInterrupt ASSIGN ASRAINTRPT
ASRAKeyType ASSIGN ASRAKEY
ASRAPSW ASSIGN ASRAPSW
ASRARegisters ASSIGN ASRAREGS
ASRASpaceType ASSIGN ASRASPC
ASRAStorageType ASSIGN ASRASTG
isDumpAvailable ASSIGN ABDUMP
originalAbendCode ASSIGN ORGABCODE
programName ASSIGN ABPROGRAM
Table 2. IccAbsTime Class
Method EXEC CICS
date FORMATTIME YYDDD/YYMMDD/etc.
dayOfMonth FORMATTIME DAYOFMONTH
dayOfWeek FORMATTIME DAYOFWEEK
daysSince1900 FORMATTIME DAYCOUNT
monthOfYear FORMATTIME MONTHOFYEAR
time FORMATTIME TIME
year FORMATTIME YEAR
Table 3. IccClock Class
Method EXEC CICS
cancelAlarm CANCEL
date FORMATTIME YYDDD/YYMMDD/etc.
dayOfMonth FORMATTIME DAYOFMONTH
dayOfWeek FORMATTIME DAYOFWEEK
daysSince1900 FORMATTIME DAYCOUNT
monthOfYear FORMATTIME MONTHOFYEAR
setAlarm POST
time FORMATTIME TIME
update ASKTIME
year FORMATTIME YEAR
Table 4. IccConsole Class
Method EXEC CICS
write WRITE OPERATOR
writeAndGetReply WRITE OPERATOR
Table 5. IccControl Class
Method EXEC CICS
callingProgramId ASSIGN INVOKINGPROG
cancelAbendHandler HANDLE ABEND CANCEL
commArea ADDRESS COMMAREA
initData ASSIGN INITPARM & INITPARMLEN
programId ASSIGN PROGRAM
resetAbendHandler HANDLE ABEND RESET
setAbendHandler HANDLE ABEND PROGRAM
Table 6. IccDataQueue Class
Method EXEC CICS
empty DELETEQ TD
readItem READQ TD
writeItem WRITEQ TD
Table 7. IccFile Class
Method EXEC CICS
access INQUIRE FILE ADD|BROWSE|DELETE|READ|UPDATE
accessMethod INQUIRE FILE ACCESSMETHOD
deleteRecord DELETE FILE RIDFLD
deleteLockedRecord DELETE FILE
enableStatus INQUIRE FILE ENABLESTATUS
isAddable INQUIRE FILE ADD
isBrowsable INQUIRE FILE BROWSE
isDeletable INQUIRE FILE DELETE
isEmptyOnOpen INQUIRE FILE EMPTYSTATUS
isReadable INQUIRE FILE READ
isRecoverable INQUIRE FILE RECOVSTATUS
isUpdatable INQUIRE FILE UPDATE
keyPosition INQUIRE FILE KEYPOSITION
openStatus INQUIRE FILE OPENSTATUS
readRecord READ FILE
recordFormat INQUIRE FILE RECORDFORMAT
recordLength INQUIRE FILE RECORDSIZE
rewriteRecord REWRITE FILE
setAccess SET FILE ADD BROWSE DELETE etc.
setEmptyOnOpen SET FILE EMPTYSTATUS
setStatus SET FILE OPENSTATUS ENABLESTATUS
type INQUIRE FILE TYPE
unlockRecord UNLOCK FILE
writeRecord WRITE FILE
Table 8. IccFileIterator Class
Method EXEC CICS
IccFileIterator (constructor) STARTBR FILE
~IccFileIterator (destructor) ENDBR FILE
readNextRecord READNEXT FILE
readPreviousRecord READPREV FILE
reset RESETBR FILE
Table 9. IccJournal Class
Method EXEC CICS
wait WAIT JOURNALNUM
writeRecord WRITE JOURNALNUM
Table 10. IccProgram Class
Method EXEC CICS
link LINK PROGRAM
load LOAD PROGRAM
unload RELEASE PROGRAM
Table 11. IccResource Class
Method EXEC CICS
condition (RESP & RESP2)
setRouteOption (SYSID)
Table 12. IccSemaphore Class
Method EXEC CICS
lock ENQ RESOURCE
tryLock ENQ RESOURCE NOSUSPEND
unlock DEQ RESOURCE
Table 13. IccSession Class
Method EXEC CICS
allocate ALLOCATE
connectProcess CONNECT PROCESS CONVID
converse CONVERSE CONVID
extractProcess EXTRACT PROCESS CONVID
flush WAIT CONVID
free FREE CONVID
issueAbend ISSUE ABEND CONVID
issueConfirmation ISSUE CONFIRMATION CONVID
issueError ISSUE ERROR CONVID
issuePrepare ISSUE PREPARE CONVID
issueSignal ISSUE SIGNAL CONVID
receive RECEIVE CONVID
send SEND CONVID
sendInvite SEND CONVID INVITE
sendLast SEND CONVID LAST
state EXTRACT ATTRIBUTES
Table 14. IccStartRequestQ Class
Method EXEC CICS
cancel CANCEL
retrieveData RETRIEVE
start START TRANSID
Table 15. IccSystem Class
Method EXEC CICS
applName ASSIGN APPLID
beginBrowse INQUIRE (FILE, TDQUEUE, etc) START
dateFormat FORMATTIME DATEFORM
endBrowse INQUIRE (FILE, TDQUEUE, etc) END
freeStorage FREEMAIN
getFile INQUIRE FILE
getNextFile INQUIRE FILE NEXT
getStorage GETMAIN SHARED
operatingSystem INQUIRE SYSTEM OPSYS
operatingSystemLevel INQUIRE SYSTEM OPREL
release INQUIRE SYSTEM RELEASE
releaseText INQUIRE SYSTEM RELEASE
sysId ASSIGN SYSID
workArea ADDRESS CWA
Table 16. IccTask Class
Method EXEC CICS
abend ABEND
commitUOW SYNCPOINT
delay DELAY
dump DUMP TRANSACTION
enterTrace ENTER TRACENUM
facilityType ASSIGN STARTCODE, TERMCODE, PRINSYSID, FCI
freeStorage FREEMAIN
isCommandSecurityOn ASSIGN CMDSEC
isCommitSupported ASSIGN STARTCODE
isResourceSecurityOn ASSIGN RESSEC
isRestarted ASSIGN RESTART
isStartDataAvailable ASSIGN STARTCODE
principalSysId ASSIGN PRINSYSID
priority ASSIGN TASKPRIORITY
rollBackUOW SYNCPOINT ROLLBACK
setPrioity CHANGE TASK PRIORITY
startType ASSIGN STARTCODE
suspend SUSPEND
triggerDataQueueId ASSIGN QNAME
userId ASSIGN USERID
waitExternal WAIT EXTERNAL / WAITCICS
waitOnAlarm WAIT EVENT
workArea ADDRESS TWA
Table 17. IccTempStore Class
Method EXEC CICS
empty DELETEQ TS
readItem READQ TS ITEM
readNextItem READQ TS NEXT
rewriteItem WRITEQ TS ITEM REWRITE
writeItem WRITEQ TS ITEM
Table 18. IccTerminal Class
Method EXEC CICS
erase SEND CONTROL ERASE
freeKeyboard SEND CONTROL FREEKB
height ASSIGN SCRNHT
netName ASSIGN NETNAME
receive RECEIVE
receive3270Data RECEIVE BUFFER
send SEND
sendLine SEND
setCursor SEND CONTROL CURSOR
setLine SEND CONTROL CURSOR
setNewLine SEND CONTROL CURSOR
signoff SIGNOFF
signon SIGNON
waitForAID RECEIVE
width ASSIGN SCRNWD
workArea ADDRESS TCTUA
Table 19. IccTerminalData Class
Method EXEC CICS
alternateHeight ASSIGN ALTSCRNHT
alternateWidth ASSIGN ALTSCRNWD
defaultHeight ASSIGN DEFSCRNHT
defaultWidth ASSIGN DEFSCRNWD
graphicCharSetId ASSIGN GCHARS
graphicCharCodeSet ASSIGN GCODES
isAPLKeyboard ASSIGN APLKYBD
isAPLText ASSIGN APLTEXT
isBTrans ASSIGN BTRANS
isColor ASSIGN COLOR
isEWA ASSIGN ESASUPP
isExtended3270 ASSIGN EXTDS
isGoodMorning ASSIGN GMMI
isHighlight ASSIGN HILIGHT
isKatakana ASSIGN KATAKANA
isMSRControl ASSIGN MSRCONTROL
isFieldOutline ASSIGN OUTLINE
isPS ASSIGN PS
isSOSI ASSIGN SOSI
isTextKeyboard ASSIGN TEXTKYBD
isTextPrint ASSIGN TEXTPRINT
isValidation ASSIGN VALIDATION
   
Table 20. IccUser Class
Method EXEC CICS
changePassword CHANGE PASSWORD
verifyPassword VERIFY PASSWORD