A B C D E F G H I K L M N O P Q R S T U V W X

A

AIDValue - class com.ibm.cics.server.AIDValue.
This class provides a set of constants for use with getAIDbyte() method in the TerminalPrincipalFacility class.
ALARM - Static variable in interface com.ibm.cics.server.TerminalSendCommonBits
 
ALLOCATED - Static variable in class com.ibm.cics.server.ConversationState
 
API - class com.ibm.cics.server.API.
This abstract class provides for common initialisation for every class that corresponds to a part of the CICS API, except for ABENDs and exceptions, and it ensures sufficient initialisation of the environment to allow CICS API calls to be made.
API() - Constructor for class com.ibm.cics.server.API
 
AUTOAUTH - Static variable in class com.ibm.cics.server.TcpipRequest
 
AUTOREGISTER - Static variable in class com.ibm.cics.server.TcpipRequest
 
AUXILIARY - Static variable in class com.ibm.cics.server.TSQType
 
AbendCancelException - exception com.ibm.cics.server.AbendCancelException.
Provides a Java exception that corresponds to a CICS ABEND CANCEL.
AbendError - error com.ibm.cics.server.AbendError.
Class for an "unhandleable" CICS ABEND.
AbendException - exception com.ibm.cics.server.AbendException.
Class that provides a Java exception that corresponds to a CICS ABEND.
AddressResource - class com.ibm.cics.server.AddressResource.
This class provides the implementation of synchronization based on the address of a data area.
AddressResource() - Constructor for class com.ibm.cics.server.AddressResource
Construct a default AddressResource.
AllocationErrorException - exception com.ibm.cics.server.AllocationErrorException.
Class that represents the CICS ALLOCERR condition.
AttachInitiator - class com.ibm.cics.server.AttachInitiator.
This bean is the main interface to APPC.
AttachInitiator() - Constructor for class com.ibm.cics.server.AttachInitiator
 
AttachInitiatorBeanInfo - class com.ibm.cics.server.AttachInitiatorBeanInfo.
This Class provides the BeanInfo for an AttachInitiator.
AttachInitiatorBeanInfo() - Constructor for class com.ibm.cics.server.AttachInitiatorBeanInfo
 
abend(String) - Method in class com.ibm.cics.server.Task
Request a normal ABEND of the task with specific abend code.
abend(String, boolean) - Method in class com.ibm.cics.server.Task
Request a normal ABEND of the task with specific abend code and optional dump.
abend() - Method in class com.ibm.cics.server.Task
Request a normal ABEND of the task with no abend code and no dump.
addFaultstring(String, String) - Static method in class com.ibm.cics.server.SoapFault
Add a new faultstring to the fault that has been created.
addSubcode(String) - Static method in class com.ibm.cics.server.SoapFault
Add a new subcode to the fault that has been created.
addSymbol(String, String) - Method in class com.ibm.cics.server.Document
Usage:
Add a symbol and it's value to the symbol table associated with the Document object.
appendBinary(byte[]) - Method in class com.ibm.cics.server.Document
Usage:
Append a Java byte array to the Document object.
appendBookmark(String) - Method in class com.ibm.cics.server.Document
Usage:
Append a bookmark to the Document object.
appendDocument(Document) - Method in class com.ibm.cics.server.Document
Usage:
Append another Document object to the Document object.
appendFromDocRetrieve(byte[]) - Method in class com.ibm.cics.server.Document
Usage:
Append a retrieved document to the Document object.
appendFromTemplate(String) - Method in class com.ibm.cics.server.Document
Usage:
Append a template to the Document object.
appendSymbol(String) - Method in class com.ibm.cics.server.Document
Usage:
Append the data associated with the symbol in the symbol table to the Document object.
appendSymbol(String, String) - Method in class com.ibm.cics.server.Document
Usage:
Append the data associated with the symbol in the symbol table to the Document object.
appendTemplate(String) - Method in class com.ibm.cics.server.Document
Usage:
Append the template specified by the document template definition to the Document object.
appendTemplate(String, String) - Method in class com.ibm.cics.server.Document
Usage:
Append the template specified by the document template definition to the Document object.
appendText(String) - Method in class com.ibm.cics.server.Document
Usage:
Append text to the Document object.
appendText(String, String) - Method in class com.ibm.cics.server.Document
Usage:
Append text to the Document object.

B

BASICAUTH - Static variable in class com.ibm.cics.server.TcpipRequest
 

C

CCErrorException - exception com.ibm.cics.server.CCErrorException.
Class that represents the CICS CCERROR condition.
CCSIDErrorException - exception com.ibm.cics.server.CCSIDErrorException.
Class that represents the CICS CCSIDERR condition
CERTIFICAUTH - Static variable in class com.ibm.cics.server.TcpipRequest
 
CICS_REGION_AND_API_ALLOWED - Static variable in class com.ibm.cics.server.IsCICS
 
CICS_REGION_BUT_API_DISALLOWED - Static variable in class com.ibm.cics.server.IsCICS
 
CLEAR - Static variable in class com.ibm.cics.server.AIDValue
 
CLIENT - Static variable in class com.ibm.cics.server.SoapFault
Use for the faultcode when the fault is caused by the Client
CLIENTAUTH - Static variable in class com.ibm.cics.server.TcpipRequest
 
CONFFREE - Static variable in class com.ibm.cics.server.ConversationState
 
CONFIRM - Static variable in class com.ibm.cics.server.SyncLevel
 
CONFRECEIVE - Static variable in class com.ibm.cics.server.ConversationState
 
CONFSEND - Static variable in class com.ibm.cics.server.ConversationState
 
COPYRIGHT - Static variable in interface com.ibm.cics.server.ResetOnInitialization
 
COPYRIGHT - Static variable in interface com.ibm.cics.server.TidyUpOnTermination
 
CWAHolder - class com.ibm.cics.server.CWAHolder.
This class holds an array of bytes that is a copy of the contents of the CWA.
CWAHolder() - Constructor for class com.ibm.cics.server.CWAHolder
Constructs a CWAHolder without a value.
CWAHolder(byte[]) - Constructor for class com.ibm.cics.server.CWAHolder
Constructs a CWAHolder without a value.
CertificateInfo - class com.ibm.cics.server.CertificateInfo.
Usage:
This Class provides the Java implementation of CICS API command EXTRACT CERTIFICATE.
Channel - class com.ibm.cics.server.Channel.
This is the Java implementation of CICS Channels
ChannelErrorException - exception com.ibm.cics.server.ChannelErrorException.
Class that represents the CICS CHANNELERR condition
ChannelFactory - class com.ibm.cics.server.ChannelFactory.
This is the Factory for creating CICS Channels
CicsConditionException - exception com.ibm.cics.server.CicsConditionException.
Class that provides a Java class which is used as an exception corresponding to a CICS condition.
CicsError - error com.ibm.cics.server.CicsError.
Class that provides the superclass for all CICS error classes.
CicsException - exception com.ibm.cics.server.CicsException.
Class that provides the superclass for all CICS exception classes.
CicsResponseConditionException - exception com.ibm.cics.server.CicsResponseConditionException.
This class provides the base for those exceptions that correspond to CICS conditions for which a response code (in the EIBRCODE field of the EIB) is defined.
CicsRuntimeException - exception com.ibm.cics.server.CicsRuntimeException.
Class that provides the superclass for all CICS RuntimeExceptions.
CicsSecurityManager - class com.ibm.cics.server.CicsSecurityManager.
This class provides a security manager for the CICS environment.
CicsSecurityManager() - Constructor for class com.ibm.cics.server.CicsSecurityManager
The constructor for the CICS supplied security manager
CodePageErrorException - exception com.ibm.cics.server.CodePageErrorException.
Class that represents the CICS CODEPAGEERR condition
CommAreaHolder - class com.ibm.cics.server.CommAreaHolder.
The class that represents a COMMAREA.
CommAreaHolder() - Constructor for class com.ibm.cics.server.CommAreaHolder
Constructs a CommAreaHolder without a value.
CommAreaHolder(byte[]) - Constructor for class com.ibm.cics.server.CommAreaHolder
Constructs a CommAreaHolder for an existing byte[].
Container - class com.ibm.cics.server.Container.
This is the Java implementation of CICS Containers
ContainerErrorException - exception com.ibm.cics.server.ContainerErrorException.
Class that represents the CICS CONTAINERERR condition
ContainerIterator - class com.ibm.cics.server.ContainerIterator.
This is the ContainerIterator which allows CICS Java programs to browse all Containers in a Channel.
Conversation - class com.ibm.cics.server.Conversation.
This class implements the interface that is common to both ends of an APPC conversation.
ConversationPrincipalFacility - class com.ibm.cics.server.ConversationPrincipalFacility.
 
ConversationSendOptions - class com.ibm.cics.server.ConversationSendOptions.
This class presents a way to specify the following options on the SEND command: [INVITE|LAST] [CONFIRM|WAIT] The various set methods check that only valid combinations of options are allowed.
ConversationSendOptions() - Constructor for class com.ibm.cics.server.ConversationSendOptions
 
ConversationState - class com.ibm.cics.server.ConversationState.
This class implements an enumeration representing the different states in which an APPC conversation can be.
Cursor - class com.ibm.cics.server.Cursor.
This class provides a set of methods and variables that correspond to the CURSOR of a CICS terminal.
Cursor(int, int) - Constructor for class com.ibm.cics.server.Cursor
Construct a cursor for a screen of the supplied width and height and an initial position of (1,1).
Cursor(int, int, int, int) - Constructor for class com.ibm.cics.server.Cursor
Construct a cursor for a screen of the supplied width and height and a supplied initial position.
cancel() - Method in class com.ibm.cics.server.StartRequest
Cancel a previous start request
checkAccept(String, int) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkAccess(Thread) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkAccess(ThreadGroup) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkAwtEventQueueAccess() - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkConnect(String, int) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkConnect(String, int, Object) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkCreateClassLoader() - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkDelete(String) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkExec(String) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkExit(int) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkLink(String) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkListen(int) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkMemberAccess(Class, int) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkMulticast(InetAddress) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkMulticast(InetAddress, byte) - Method in class com.ibm.cics.server.CicsSecurityManager
Deprecated.  
checkPackageAccess(String) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkPackageDefinition(String) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkPrintJobAccess() - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkPropertiesAccess() - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkPropertyAccess(String) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkPropertyAccess(String, String) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkRead(FileDescriptor) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkRead(String) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkRead(String, Object) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkSecurityAccess(String) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkSetFactory() - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkSystemClipboardAccess() - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkTopLevelWindow(Object) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkWrite(FileDescriptor) - Method in class com.ibm.cics.server.CicsSecurityManager
 
checkWrite(String) - Method in class com.ibm.cics.server.CicsSecurityManager
 
clear() - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Clear the terminal.
clearAll() - Method in class com.ibm.cics.server.ConversationSendOptions
 
clearConfirm() - Method in class com.ibm.cics.server.ConversationSendOptions
 
clearInvite() - Method in class com.ibm.cics.server.ConversationSendOptions
 
clearLast() - Method in class com.ibm.cics.server.ConversationSendOptions
 
clearWait() - Method in class com.ibm.cics.server.ConversationSendOptions
 
close() - Method in class com.ibm.cics.server.HttpSession
Usage:
Close a session with a host on a remote server.
com.ibm.cics.server - package com.ibm.cics.server
 
commit() - Method in class com.ibm.cics.server.Task
Commit the work done as part of the task.
containerIterator() - Method in class com.ibm.cics.server.Channel
Create a ContainerIterator for the Channel
containerIterator() - Method in class com.ibm.cics.server.Task
Create a ContainerIterator for the current Channel.
converse(DataHolder) - Method in class com.ibm.cics.server.Conversation
DTC converse
converse(DataHolder, int, boolean) - Method in class com.ibm.cics.server.Conversation
DTC Converse
converse(DataHolder) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Send then receive 3270 data stream from the terminal
converseASIS(DataHolder) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Send then receive 3270 data stream from the terminal without uppercase translation
create(int, String, String, String, String, String) - Static method in class com.ibm.cics.server.SoapFault
Create a new soapfault.
create(int, String, String, String) - Static method in class com.ibm.cics.server.SoapFault
Create a new soapfault.
create(int, String, String) - Static method in class com.ibm.cics.server.SoapFault
Create a new soapfault.
create(int, String) - Static method in class com.ibm.cics.server.SoapFault
Create a new soapfault.
create(String, String, String, String, String, String) - Static method in class com.ibm.cics.server.SoapFault
Create a new soapfault.
createBinary(byte[]) - Method in class com.ibm.cics.server.Document
Usage:
Add a Java byte array to the empty Document object.
createChannel(String) - Method in class com.ibm.cics.server.Task
Create a Channel to hold the default number (16) of Containers.
createChannel(String, int) - Method in class com.ibm.cics.server.Task
Create a Channel with room for a specific number of Containers.
createContainer(String) - Method in class com.ibm.cics.server.Channel
Create a Container in this Channel
createFromDoc(Document) - Method in class com.ibm.cics.server.Document
Usage:
Add another Document object to the empty Document object.
createFromDocRetrieve(byte[]) - Method in class com.ibm.cics.server.Document
Usage:
Add a retrieved document to the empty Document object.
createFromTemplate(String) - Method in class com.ibm.cics.server.Document
Usage:
Add a template to the empty Document object.
createTemplate(String) - Method in class com.ibm.cics.server.Document
Usage:
Add the template specified by the document template definition to the empty Document object.
createTemplate(String, String) - Method in class com.ibm.cics.server.Document
Usage:
Add the template specified by the document template definition to the empty Document object.
createText(String) - Method in class com.ibm.cics.server.Document
Usage:
Add text to the empty Document object.
createText(String, String) - Method in class com.ibm.cics.server.Document
Usage:
Add text to the empty Document object.

D

DATA - Static variable in interface com.ibm.cics.server.RetrieveBits
 
DATATYPE_BIT - Static variable in class com.ibm.cics.server.Container
 
DATATYPE_CHAR - Static variable in class com.ibm.cics.server.Container
 
DataHolder - class com.ibm.cics.server.DataHolder.
This class holds an array of bytes that is the data read from a TDQ.
DataHolder() - Constructor for class com.ibm.cics.server.DataHolder
Constructs a DataHolder without a value.
DestinationSelectionErrorException - exception com.ibm.cics.server.DestinationSelectionErrorException.
Class that represents the CICS SELNERR condition.
DestinationStatusChangeException - exception com.ibm.cics.server.DestinationStatusChangeException.
Class that represents the CICS DSSTAT condition.
Document - class com.ibm.cics.server.Document.
Usage:
This Class provides the Java implementation of the CICS DOCUMENT API.
Document() - Constructor for class com.ibm.cics.server.Document
Usage:
Public default constructor which will create a empty (default) Document object which can have relevant DOCUMENT calls performed on it by relevant methods from this class.
DocumentLocation - class com.ibm.cics.server.DocumentLocation.
Usage:
This Class provides a wrapper for the AT and TO keywords for CICS DOCUMENT API command DOCUMENT INSERT.
DocumentLocation(String) - Constructor for class com.ibm.cics.server.DocumentLocation
Usage:
Public constructor which accepts an AT string.
DocumentLocation(String, String) - Constructor for class com.ibm.cics.server.DocumentLocation
Usage:
Public constructor which accepts an AT string and TO string.
DumpOpenErrorException - exception com.ibm.cics.server.DumpOpenErrorException.
Class that represents the CICS OPENERR condition.
DuplicateKeyException - exception com.ibm.cics.server.DuplicateKeyException.
Class that represents the CICS DUPKEY condition.
DuplicateRecordException - exception com.ibm.cics.server.DuplicateRecordException.
Class that represents the CICS DUPREC condition.
data - Variable in class com.ibm.cics.server.RetrievedData
 
decrement() - Method in class com.ibm.cics.server.Cursor
Decrement the cursor position.
delete() - Method in class com.ibm.cics.server.Container
Delete the Container in CICS, and remove it from the owning Channel.
delete() - Method in class com.ibm.cics.server.Document
Usage:
Delete the Document.
delete() - Method in class com.ibm.cics.server.KSDS
Delete a record from a KSDS file.
delete(byte[]) - Method in class com.ibm.cics.server.KSDS
 
delete() - Method in class com.ibm.cics.server.RRDS
Delete a record from an RRDS file.
delete(long) - Method in class com.ibm.cics.server.RRDS
Delete a record from an RRDS file.
delete() - Static method in class com.ibm.cics.server.SoapFault
Delete deletes a soapfault
delete() - Method in class com.ibm.cics.server.TDQ
Delete a Transient Data Queue.
delete() - Method in class com.ibm.cics.server.TSQ
Delete a Temporary Storage Queue (TSQ).
deleteContainer(String) - Method in class com.ibm.cics.server.Channel
Delete a Container from this Channel
deleteGeneric(byte[]) - Method in class com.ibm.cics.server.KSDS
 
dequeue() - Method in class com.ibm.cics.server.AddressResource
 
dequeue() - Method in class com.ibm.cics.server.NameResource
Unlock the named resource.
disableTaskTrace() - Method in class com.ibm.cics.server.Task
Switch off task trace flag (Method is not supported in this release of CICS TS)
disableTrace() - Static method in class com.ibm.cics.server.Region
Disable main TRACE flag for the region (Method is not supported in this release of CICS TS)
disableTrace(BitSet) - Static method in class com.ibm.cics.server.Region
Disable region trace flags (Method is not supported in this release of CICS TS)
driveReInit() - Static method in class com.ibm.cics.server.WrapperHelper
Call the drive_ibmJVMReInitialize() methods on any objects that require it.
driveTidyUp() - Static method in class com.ibm.cics.server.WrapperHelper
Call the drive_ibmJVMTidyUp() methods on any objects that require it.
drive_ibmJVMReinitialize() - Method in interface com.ibm.cics.server.ResetOnInitialization
 
drive_ibmJVMTidyUp() - Method in class com.ibm.cics.server.HttpRequest
Call the ibmJVMTidyUp method from a non-resettable JVM
drive_ibmJVMTidyUp() - Method in class com.ibm.cics.server.TcpipRequest
Method to drive the static ibmJVMTidyUp method in a non-resettable JVM
drive_ibmJVMTidyUp() - Method in interface com.ibm.cics.server.TidyUpOnTermination
 

E

EI - Static variable in interface com.ibm.cics.server.RegionTraceBits
 
ENTER - Static variable in class com.ibm.cics.server.AIDValue
 
EQUAL - Static variable in class com.ibm.cics.server.SearchType
 
ERASE - Static variable in interface com.ibm.cics.server.TerminalSendCommonBits
 
ERASEAUP - Static variable in interface com.ibm.cics.server.TerminalSendControlBits
 
ESDS - class com.ibm.cics.server.ESDS.
This class is the implementation class for the ESDS kind of file.
ESDS() - Constructor for class com.ibm.cics.server.ESDS
Construct a default ESDS object.
ESDS_Browse - class com.ibm.cics.server.ESDS_Browse.
This class implements the CICS File Control interface for browsing ESDS files via RBA.
EndException - exception com.ibm.cics.server.EndException.
Class that represents the CICS END condition.
EndOfChainIndicatorException - exception com.ibm.cics.server.EndOfChainIndicatorException.
Class that represents the CICS EOC condition.
EndOfDataException - exception com.ibm.cics.server.EndOfDataException.
Class that represents the CICS ENDDATA condition.
EndOfDataSetIndicatorException - exception com.ibm.cics.server.EndOfDataSetIndicatorException.
Class that represents the CICS EODS condition.
EndOfFileException - exception com.ibm.cics.server.EndOfFileException.
Class that represents the CICS ENDFILE condition.
EndOfFileIndicatorException - exception com.ibm.cics.server.EndOfFileIndicatorException.
Class that represents the CICS EOF condition.
EndOfInputIndicatorException - exception com.ibm.cics.server.EndOfInputIndicatorException.
Class that represents the CICS ENDINPT condition.
EndOfProgramException - exception com.ibm.cics.server.EndOfProgramException.
Class that provides the Java class that is used as an exception to indicate that a program has terminated.
EnterRequest - class com.ibm.cics.server.EnterRequest.
This Bean provides the Java equivalent to the EXEC CICS ENTER command.
EnterRequest() - Constructor for class com.ibm.cics.server.EnterRequest
Construct an EnterRequest bean.
ErrorException - exception com.ibm.cics.server.ErrorException.
Class that represents the CICS ERROR condition.
enableTaskTrace() - Method in class com.ibm.cics.server.Task
Switch on task trace flag (Method is not supported in this release of CICS TS)
enableTrace() - Static method in class com.ibm.cics.server.Region
Enable main TRACE flag for the region (Method is not supported in this release of CICS TS)
enableTrace(BitSet) - Static method in class com.ibm.cics.server.Region
Enable region trace flags (Method is not supported in this release of CICS TS)
end() - Method in class com.ibm.cics.server.FileBrowse
End the browse.
endBrowseFormField() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Signal the end of the form field browse.
endBrowseHeader(HttpSession) - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Signal the end of the HTTP header browse.
endBrowseHeader() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Signal the end of the HTTP header browse.
enqueue() - Method in class com.ibm.cics.server.AddressResource
 
enqueue() - Method in class com.ibm.cics.server.NameResource
Attempt to lock the named resource.
enterTrace() - Method in class com.ibm.cics.server.EnterRequest
Perform a trace entry request
enterTrace(byte[]) - Method in class com.ibm.cics.server.EnterRequest
Perform a trace entry request with supplied data
equals(Object) - Method in class com.ibm.cics.server.ConversationState
 
equals(Object) - Method in class com.ibm.cics.server.SearchType
 
equals(Object) - Method in class com.ibm.cics.server.SyncLevel
 
equals(Object) - Method in class com.ibm.cics.server.TSQType
 
erase() - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Erase the terminal.
err - Variable in class com.ibm.cics.server.Task
A PrintWriter which is directed at the user's terminal, if the Principal Facility is a terminal, or to System.err if it is not.

F

FCI_START_NO_DATA - Static variable in class com.ibm.cics.server.Task
 
FCI_START_WITH_DATA - Static variable in class com.ibm.cics.server.Task
 
FCI_TASK_WITH_FACILITY - Static variable in class com.ibm.cics.server.Task
 
FCI_TRIGGERED_NO_FACILITY - Static variable in class com.ibm.cics.server.Task
 
FORMFEED - Static variable in interface com.ibm.cics.server.TerminalSendControlBits
 
FORMFEED - Static variable in interface com.ibm.cics.server.TerminalSendTextBits
 
FREE - Static variable in class com.ibm.cics.server.ConversationState
 
FREEKB - Static variable in interface com.ibm.cics.server.TerminalSendCommonBits
 
FRSET - Static variable in interface com.ibm.cics.server.TerminalSendBits
 
FRSET - Static variable in interface com.ibm.cics.server.TerminalSendControlBits
 
FileBrowse - class com.ibm.cics.server.FileBrowse.
This class is the superclass of all of the browse-related implementation classes.
FileDisabledException - exception com.ibm.cics.server.FileDisabledException.
Class that represents the CICS DISABLED condition.
FileNotFoundException - exception com.ibm.cics.server.FileNotFoundException.
Class that represents the CICS FILENOTFOUND condition.
FormField - class com.ibm.cics.server.FormField.
Usage:
This Class extends the NameValueData class and the class returned from HttpRequest methods: getFormField() getNextFormField()
FunctionErrorException - exception com.ibm.cics.server.FunctionErrorException.
Class that represents the CICS FUNCERR condition.
fixedErrForJVMLifetime - Static variable in class com.ibm.cics.server.Task
 
fixedOutForJVMLifetime - Static variable in class com.ibm.cics.server.Task
Standard output and standard error can be redirected to two places by this class.
flush() - Method in class com.ibm.cics.server.Conversation
 
forceAbend(String) - Method in class com.ibm.cics.server.Task
Force the task to ABEND with a specific abend code and a dump.
forceAbend(String, boolean) - Method in class com.ibm.cics.server.Task
Force the task to ABEND with a specific abend code and optional dump.
forceAbend() - Method in class com.ibm.cics.server.Task
Force the task to ABEND with no abend code and no dump.
free() - Method in class com.ibm.cics.server.Conversation
 

G

GTEQ - Static variable in class com.ibm.cics.server.SearchType
 
get() - Method in class com.ibm.cics.server.Container
Get the data from the Container.
get(String) - Method in class com.ibm.cics.server.Container
Get the data from the Container.
getABCODE() - Method in class com.ibm.cics.server.AbendCancelException
Return the particular ABEND code associated with an AbendCancelException.
getABCODE() - Method in class com.ibm.cics.server.AbendError
Return the particular ABEND code associated with an AbendError.
getABCODE() - Method in class com.ibm.cics.server.AbendException
Return the particular ABEND code associated with an AbendException.
getAIDbyte() - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Return the AID (Action Identifier) key last entered by the user at the terminal.
getAPPLID() - Static method in class com.ibm.cics.server.Region
Return the APPLID of the region.
getAddress() - Method in class com.ibm.cics.server.AddressResource
Return the address used for the synchronization resource.
getApiStatus() - Static method in class com.ibm.cics.server.IsCICS
getApiStatus () returns the status of the current execution environment
getAsText() - Method in class com.ibm.cics.server.SyncLevelEditor
 
getAsText() - Method in class com.ibm.cics.server.TSQNameEditor
Return the queue name as a String.
getAsText() - Method in class com.ibm.cics.server.TSQTypeEditor
 
getAuthenticate() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns an integer which indicates the authentication requested for the client using the transaction.
getBodyCharset() - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Returns the HTTP body characterset of the servers response.
getBodyCharset() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the HTTP body characterset in which the HTTP body was encoded in by the client.
getBodyCharset() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns the HTTP body characterset in which the HTTP body was encoded in by the client.
getCCSID() - Method in class com.ibm.cics.server.Container
Get the CCSID value of the data returned by getNoConvert().
getCWA(CWAHolder) - Static method in class com.ibm.cics.server.Region
Return a copy of the Common Work Area (CWA).
getCertificate() - Method in class com.ibm.cics.server.CertificateInfo
Usage:
Returns the full certificate obtained by the constructor.
getCertificateInfo() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns the owner certificate.
getCertificateInfo(int) - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns the requested certificate, either the owner or the issuer certificate.
getChannel(String) - Method in class com.ibm.cics.server.Task
Return the named Channel object if it matches the current channel's name or has been created through the JCICS API by this task earlier at this Link level.
getCharacterset() - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Returns the HTTP body characterset of the servers response.
getCharactersetTrim() - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Returns the HTTP body characterset of the servers response.
getClientAddress() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns the client's TCPIP address.
getClientHostAddress() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns the client's TCPIP address in a Jave byte array.
getClientHostName() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns the client's name as known by the Domain Name Server.
getColumn() - Method in class com.ibm.cics.server.Cursor
Get the current cursor column position.
getCommonName() - Method in class com.ibm.cics.server.CertificateInfo
Usage:
Returns the common name from the client certificate obtained by the constructor.
getConfirm() - Method in class com.ibm.cics.server.ConversationSendOptions
 
getContainer(String) - Method in class com.ibm.cics.server.Channel
Get a Container by name from this Channel
getContent(HttpSession) - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Returns the body of the servers response.
getContent(String, String) - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the body of the HTTP request.
getContent() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the body of the HTTP request.
getContent(String, String) - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns the body of the HTTP request.
getContent() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns the body of the HTTP request.
getContentAsContainer(HttpSession, String, String) - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Stores the body of the HTTP response in a named container.
getContentAsContainer(HttpSession, String) - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Stores the body of the HTTP response in a named container.
getContentAsContainer(String, String) - Method in class com.ibm.cics.server.HttpRequest
Usage:
Stores the body of the HTTP request in a named container.
getContentAsContainer(String) - Method in class com.ibm.cics.server.HttpRequest
Usage:
Stores the body of the HTTP request in a named container.
getContentAsContainer(String, String) - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Stores the body of the HTTP request in a named container.
getContentAsContainer(String) - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Stores the body of the HTTP request in a named container.
getConvId() - Method in class com.ibm.cics.server.Conversation
Get the conversation identifier for a conversation.
getCountry() - Method in class com.ibm.cics.server.CertificateInfo
Usage:
Returns the country from the client certificate obtained by the constructor.
getCurrentChannel() - Method in class com.ibm.cics.server.Task
Return the current Channel, if any.
getCursor() - Method in class com.ibm.cics.server.Terminal
Return the Cursor associated with the terminal.
getDataComplete() - Method in class com.ibm.cics.server.Conversation
Has all data been received?
getDefaultPropertyIndex() - Method in class com.ibm.cics.server.AttachInitiatorBeanInfo
 
getDefaultPropertyIndex() - Method in class com.ibm.cics.server.StartRequestBeanInfo
 
getDefaultPropertyIndex() - Method in class com.ibm.cics.server.TSQBeanInfo
 
getDelimiter() - Method in class com.ibm.cics.server.SymbolList
Usage:
Returns delimiter value.
getDescription() - Method in class com.ibm.cics.server.Resource
Return the description of the resource.
getDescription() - Method in class com.ibm.cics.server.SynchronizationResource
Return the description of the synchronization resource.
getDocSize() - Method in class com.ibm.cics.server.Document
Usage:
Returns the size of the document associated with the Document object.
getDocToken() - Method in class com.ibm.cics.server.Document
Usage:
Returns the document token associated with the Document object.
getErrorCode() - Method in class com.ibm.cics.server.Conversation
What was the last error code on this conversation?
getErrorOccurred() - Method in class com.ibm.cics.server.Conversation
Has there been an error on this conversation?
getFCI() - Method in class com.ibm.cics.server.Task
Return the FCI for the task.
getFormField() - Method in class com.ibm.cics.server.FormField
Usage:
Returns the value of a FormField-value pair.
getFormField(String) - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the value of a field from the HTML form.
getFormField(String, String, String) - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the value of a field from the HTML form.
getFormFieldData(String) - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the value of a field from the HTML form.
getFormFieldData(String, String, String) - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the value of a field from the HTML form.
getHeader(HttpSession, String) - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Returns the contents of a HTTP header.
getHeader() - Method in class com.ibm.cics.server.HttpHeader
Usage:
Returns the value of a HttpHeader-value pair.
getHeader(String) - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the contents of a HTTP header.
getHost() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the host string from the HTTP request.
getHost() - Method in class com.ibm.cics.server.HttpSession
Usage:
Obtain this sessions host information.
getHttpMethod() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the HTTP method string on the request line of the inbound message.
getHttpReleaseNumber() - Method in class com.ibm.cics.server.HttpSession
Usage:
Obtain this sessions HTTPRNUM value.
getHttpRequestInstance() - Static method in class com.ibm.cics.server.HttpRequest
Usage:
Class method that returns the HttpRequest object.
getHttpVersion() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the HTTP version string on the request line of the inbound message.
getHttpVersionNumber() - Method in class com.ibm.cics.server.HttpSession
Usage:
Obtain this sessions HTTPVNUM value.
getID() - Method in class com.ibm.cics.server.StartRequest
Return the ID that uniquely identifies the start request.
getIDAsString() - Method in class com.ibm.cics.server.StartRequest
Return the ID that uniquely identifies the start request as a string, using the platform's default character encoding to convert from the byte[] format in which the name is stored.
getInvite() - Method in class com.ibm.cics.server.ConversationSendOptions
 
getLast() - Method in class com.ibm.cics.server.ConversationSendOptions
 
getLength() - Method in class com.ibm.cics.server.Container
Get the length of the data in the Container.
getLength(String) - Method in class com.ibm.cics.server.Container
Get the length of the data in the Container.
getLength() - Method in class com.ibm.cics.server.SymbolList
Usage:
Returns the length of the symbol list.
getLengthNoConvert() - Method in class com.ibm.cics.server.Container
Get the length of the data in the Container without conversion.
getLocality() - Method in class com.ibm.cics.server.CertificateInfo
Usage:
Returns the locality from the client certifcate obtained by the constructor.
getMaxDataLen() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns an maximum data length value for the socket.
getMediaType() - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Returns the mediatype of the servers response.
getMediaType() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the media type of the HTTP body sent by the client.
getMediaType() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns the media type of the HTTP body sent by the client.
getMediaTypeTrim() - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Returns the mediatype of the servers response.
getName() - Method in class com.ibm.cics.server.Channel
Get the name of the Channel as known to CICS
getName() - Method in class com.ibm.cics.server.Container
Get the name of the Container as known to CICS.
getName() - Method in class com.ibm.cics.server.NameResource
Return the name of the CICS resource.
getName() - Method in class com.ibm.cics.server.NameValueData
Usage:
Returns the name of a name-value pair.
getName() - Method in class com.ibm.cics.server.Resource
Return the name of the CICS resource.
getName() - Method in class com.ibm.cics.server.TSQ
Return the name of the TSQ as a string, using the platform's default character encoding to convert from the internal byte[] format in which the name is stored.
getName() - Method in class com.ibm.cics.server.Terminal
Return the name of the terminal.
getNetName() - Method in class com.ibm.cics.server.ConversationPrincipalFacility
Return the NETNAME.
getNextFormField() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the next name-value pair from the HTML form to be browsed.
getNextHeader(HttpSession) - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Returns the next HTTP header name-value pair to be browsed.
getNextHeader() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the next HTTP header name-value pair to be browsed.
getNoConvert() - Method in class com.ibm.cics.server.Container
Get the data from the Container without conversion.
getNoData() - Method in class com.ibm.cics.server.Conversation
Have we received a message without data?
getOrgUnit() - Method in class com.ibm.cics.server.CertificateInfo
Usage:
Returns the organization unit from the client certificate obtained by the constructor.
getOrganization() - Method in class com.ibm.cics.server.CertificateInfo
Usage:
Returns the organization from the client certificate obtained by the constructor.
getOwner() - Method in class com.ibm.cics.server.ContainerIterator
Get the owner of this iterator.
getPath() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the PATH specified in the request line on the inbound message.
getPath() - Method in class com.ibm.cics.server.HttpSession
Usage:
Obtain this sessions path information.
getPipData() - Method in class com.ibm.cics.server.ConversationPrincipalFacility
Return the PIP data as an array of bytes.
getPortNumber() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the port number associated with the HTTP request.
getPortNumber() - Method in class com.ibm.cics.server.HttpSession
Usage:
Obtain this sessions port number.
getPortNumber() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns the TCPIP port number associated with the transaction.
getPrinSysId() - Method in class com.ibm.cics.server.ConversationPrincipalFacility
Return the PRINSYSID.
getPrincipalFacility() - Method in class com.ibm.cics.server.Task
Return the principal facility for the current task.
getPrivacy() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns an integer which indicates the privacy requested for the client using the transaction.
getProcess() - Method in class com.ibm.cics.server.AttachInitiator
 
getProcess() - Method in class com.ibm.cics.server.ConversationPrincipalFacility
Return the process name.
getProfile() - Method in class com.ibm.cics.server.AttachInitiator
 
getProgramName() - Method in class com.ibm.cics.server.Task
Return the CICS PROGRAM name.
getPropertyDescriptors() - Method in class com.ibm.cics.server.AttachInitiatorBeanInfo
Return an array of PropertyDescriptors describing the properties of an AttachInitiator.
getPropertyDescriptors() - Method in class com.ibm.cics.server.StartRequestBeanInfo
Return an array of PropertyDescriptors describing the properties of a StartRequest.
getPropertyDescriptors() - Method in class com.ibm.cics.server.TSQBeanInfo
Return an array of PropertyDescriptors describing the properties of a TSQ.
getQNAME() - Method in class com.ibm.cics.server.Task
Return the QNAME for the task.
getQueryString() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the query string on the request line of the HTTP request.
getQueue() - Method in class com.ibm.cics.server.AttachInitiator
 
getQueueName() - Method in class com.ibm.cics.server.StartRequest
Return the queueName of the start request.
getQueueName() - Method in class com.ibm.cics.server.TSQ
Return the queueName of the TSQ.
getQueueNameAsString() - Method in class com.ibm.cics.server.StartRequest
Return the queue name of the start request as a string, using the platform's default character encoding to convert from the internal byte[] format in which the name is stored.
getRESP2() - Method in class com.ibm.cics.server.CicsConditionException
Return the RESP2 value for the CICS Condition represented by the CicsConditionException.
getRTerminal() - Method in class com.ibm.cics.server.StartRequest
Get the name specified as the terminal name to be retrieved by the started task.
getRTransaction() - Method in class com.ibm.cics.server.StartRequest
Get the name specified as the transaction name to be retrieved by the started task.
getRequestID() - Method in class com.ibm.cics.server.FileBrowse
 
getRequestType() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the type of request received, either HTTPYES or HTTPNO.
getResource() - Method in class com.ibm.cics.server.EnterRequest
Return the Resource
getResponseCode() - Method in class com.ibm.cics.server.CicsResponseConditionException
Return the response code value for the CICS Condition represented by the CicsResponseConditionException.
getRow() - Method in class com.ibm.cics.server.Cursor
Get the current cursor row position.
getSTARTCODE() - Method in class com.ibm.cics.server.Task
Return the STARTCODE for the task.
getSYSID() - Static method in class com.ibm.cics.server.Region
Return the SYSID for the region.
getScheme() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the scheme from the HTTP request.
getScheme() - Method in class com.ibm.cics.server.HttpSession
Usage:
Obtain this sessions scheme information.
getSerialNum() - Method in class com.ibm.cics.server.CertificateInfo
Usage:
Returns the serial number of the certificate assigned by the certificate issuer obtained by the constructor.
getServerAddress() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns the server's TCPIP address.
getServerHostAddress() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns the server's TCPIP address in a Java byte array.
getServerHostName() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns the server's name as known by the Domain Name Server.
getSignalReceived() - Method in class com.ibm.cics.server.Conversation
Have we received a SIGNAL?
getState() - Method in class com.ibm.cics.server.CertificateInfo
Usage:
Returns the state or province from the client certificate obtained by the constructor.
getState() - Method in class com.ibm.cics.server.Conversation
 
getStatusCode() - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Returns the status code of the servers response.
getStatusText() - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Returns the status text of the servers response.
getSymbolList() - Method in class com.ibm.cics.server.SymbolList
Usage:
Returns the symbol list as a String
getSymbolListAsByteArray() - Method in class com.ibm.cics.server.SymbolList
 
getSyncLevel() - Method in class com.ibm.cics.server.AttachInitiator
 
getSyncLevel() - Method in class com.ibm.cics.server.Conversation
 
getSyncOnReturn() - Method in class com.ibm.cics.server.Program
Will this program always performs a SYNCPOINT when it returns? This only applies to remote programs.
getSysId() - Method in class com.ibm.cics.server.AttachInitiator
 
getSysId() - Method in class com.ibm.cics.server.RemotableResource
Return the name of the CICS system.
getTCTUA(TCTUAHolder) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Return a copy of the Terminal User Area (TCTUA).
getTERMCODE() - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Return the TERMCODE for the principal facility.
getTWA(TWAHolder) - Method in class com.ibm.cics.server.Task
Return a copy of the Task Work Area (TWA).
getTags() - Method in class com.ibm.cics.server.SyncLevelEditor
 
getTags() - Method in class com.ibm.cics.server.TSQTypeEditor
 
getTask() - Static method in class com.ibm.cics.server.Task
Return the Task object representing the task as part of which the current thread is executing.
getTaskNumber() - Method in class com.ibm.cics.server.Task
Return the task number.
getTcpipRequestInstance() - Static method in class com.ibm.cics.server.TcpipRequest
Usage:
Class method that returns the TcpipRequest object.
getTcpipService() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns the name of the TCPIP service associated with the transaction.
getTerminal() - Method in class com.ibm.cics.server.StartRequest
Return the name of the terminal to be used as the principal facility of the started task.
getTime() - Method in class com.ibm.cics.server.StartRequest
Return the time at which the task will be started.
getTraceIdentifier() - Method in class com.ibm.cics.server.EnterRequest
Return the TraceIdentifier
getTransId() - Method in class com.ibm.cics.server.Program
Return the name of the CICS (mirror) transaction to be used to run the remote program.
getTransId() - Method in class com.ibm.cics.server.StartRequest
Return the name of the Transaction to be started.
getTransactionName() - Method in class com.ibm.cics.server.Task
Return the transaction name.
getType() - Method in class com.ibm.cics.server.TSQ
Return the type of the TSQ.
getUSERID() - Method in class com.ibm.cics.server.Task
Return the USERID that is signed on to the task's principal facility.
getUnescaped() - Method in class com.ibm.cics.server.SymbolList
Usage:
Returns the unescaped indicator.
getUrimap() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns the urimap associated with the HTTP request.
getUrimap() - Method in class com.ibm.cics.server.HttpSession
Usage:
Obtain this sessions urimap information.
getUser() - Method in class com.ibm.cics.server.Terminal
Return the name of the user currently signed on to the terminal.
getUserID() - Method in class com.ibm.cics.server.CertificateInfo
Usage:
Returns the userid connected with the client certificate obtained by the constructor.
getUserId() - Method in class com.ibm.cics.server.ConversationPrincipalFacility
Return the USERID.
getValue() - Method in class com.ibm.cics.server.NameValueData
Usage:
Returns the value of a name-value pair.
getVersion() - Method in class com.ibm.cics.server.HttpSession
Usage:
Obtain this sessions version information.
getWait() - Method in class com.ibm.cics.server.ConversationSendOptions
 

H

HttpClientRequest - class com.ibm.cics.server.HttpClientRequest.
Usage:
This class provides the Java implementation of HTTP client requests related to the following CICS API commands: WEB SEND SESSTOKEN WEB WRITE SESSTOKEN
HttpClientRequest(String, String) - Constructor for class com.ibm.cics.server.HttpClientRequest
Usage:
The METHOD and MEDIATYPE information is saved in the HttpClientRequest object for later use by the send methods.
HttpClientResponse - class com.ibm.cics.server.HttpClientResponse.
Usage:
This class provides the Java implementation of HTTP client response related to the following CICS API commands: WEB RECEIVE SESSTOKEN WEB READ SESSTOKEN WEB STARTBROWSE SESSTOKEN WEB READNEXT SESSTOKEN WEB ENDBROWSE SESSTOKEN
HttpClientResponse() - Constructor for class com.ibm.cics.server.HttpClientResponse
Usage:
Public default constructor.
HttpHeader - class com.ibm.cics.server.HttpHeader.
Usage:
This Class extends the NameValueData class and the class returned from HttpRequest methods: getHeader() getNextHeader()
HttpRequest - class com.ibm.cics.server.HttpRequest.
Usage:
This class provides the Java implementation of HTTP requests related to the following CICS API WEB server commands: WEB EXTRACT WEB READ HTTPHEADER WEB READ FORMFIELD WEB STARTBROWSE HTTPHEADER WEB READNEXT HTTPHEADER WEB ENDBROWSE HTTPHEADER WEB STARTBROWSE FORMFIELD WEB READNEXT FORMFIELD WEB ENDBROWSE FORMFIELD WEB RECEIVE
HttpResponse - class com.ibm.cics.server.HttpResponse.
Usage:
This class provides the Java implementation of HTTP responses related to the following CICS API WEB server commands: WEB WRITE WEB SEND
HttpResponse() - Constructor for class com.ibm.cics.server.HttpResponse
Usage:
Public default constructor.
HttpSession - class com.ibm.cics.server.HttpSession.
Usage:
This class provides the Java implementation of HTTP client requests related to the following CICS API commands: WEB OPEN WEB CLOSE WEB EXTRACT SESSTOKEN
HttpSession(String) - Constructor for class com.ibm.cics.server.HttpSession
Usage:
Sets WEB OPEN command option URIMAP.
HttpSession(String, String) - Constructor for class com.ibm.cics.server.HttpSession
Usage:
Sets WEB OPEN command option HOST and SCHEME.
HttpSession(String, String, int) - Constructor for class com.ibm.cics.server.HttpSession
Usage:
Sets WEB OPEN command option HOST, SCHEME and PORTNUMBER.
hasNext() - Method in class com.ibm.cics.server.ContainerIterator
Determine if there is another Container in the Channel.
hashCode() - Method in class com.ibm.cics.server.ConversationState
 
hashCode() - Method in class com.ibm.cics.server.SearchType
 
hashCode() - Method in class com.ibm.cics.server.SyncLevel
 
hashCode() - Method in class com.ibm.cics.server.TSQType
 

I

IOErrorException - exception com.ibm.cics.server.IOErrorException.
Class that represents the CICS IOERR condition.
ISCInvalidRequestException - exception com.ibm.cics.server.ISCInvalidRequestException.
Class that represents the CICS ISCINVREQ condition.
ISSUER - Static variable in class com.ibm.cics.server.CertificateInfo
 
InboundFMHException - exception com.ibm.cics.server.InboundFMHException.
Class that represents the CICS INBFMH condition.
InboundSignalException - exception com.ibm.cics.server.InboundSignalException.
Class that represents the CICS SIGNAL condition.
InvalidControlBlockIdException - exception com.ibm.cics.server.InvalidControlBlockIdException.
Class that represents the CICS CBIDERR condition.
InvalidDirectionException - exception com.ibm.cics.server.InvalidDirectionException.
Class that represents the CICS IGREQCD condition.
InvalidErrorTerminalException - exception com.ibm.cics.server.InvalidErrorTerminalException.
Class that represents the CICS INVERRTERM condition.
InvalidExitRequestException - exception com.ibm.cics.server.InvalidExitRequestException.
Class that represents the CICS INVEXITREQ condition.
InvalidJournalIdException - exception com.ibm.cics.server.InvalidJournalIdException.
Class that represents the CICS JIDERR condition.
InvalidLDCException - exception com.ibm.cics.server.InvalidLDCException.
Class that represents the CICS INVLDC condition.
InvalidMapSizeException - exception com.ibm.cics.server.InvalidMapSizeException.
Class that represents the CICS INVMPSZ condition.
InvalidNodeIdException - exception com.ibm.cics.server.InvalidNodeIdException.
Class that represents the CICS NODEIDERR condition.
InvalidPartitionException - exception com.ibm.cics.server.InvalidPartitionException.
Class that represents the CICS INVPARTN condition.
InvalidPartitionSetException - exception com.ibm.cics.server.InvalidPartitionSetException.
Class that represents the CICS INVPARTNSET condition.
InvalidProgramIdException - exception com.ibm.cics.server.InvalidProgramIdException.
Class that represents the CICS PGMIDERR condition.
InvalidQueueIdException - exception com.ibm.cics.server.InvalidQueueIdException.
Class that represents the CICS QIDERR condition.
InvalidREQIDPrefixException - exception com.ibm.cics.server.InvalidREQIDPrefixException.
Class that represents the CICS IGREQID condition.
InvalidRequestException - exception com.ibm.cics.server.InvalidRequestException.
Class that represents the CICS INVREQ condition.
InvalidRetrieveOptionException - exception com.ibm.cics.server.InvalidRetrieveOptionException.
Class that represents the CICS ENVDEFERR condition.
InvalidSystemIdException - exception com.ibm.cics.server.InvalidSystemIdException.
Class that represents the CICS SYSIDERR condition.
InvalidTSRequestException - exception com.ibm.cics.server.InvalidTSRequestException.
Class that represents the CICS INVTSREQ condition.
InvalidTaskIdException - exception com.ibm.cics.server.InvalidTaskIdException.
Class that represents the CICS TASKIDERR condition.
InvalidTerminalIdException - exception com.ibm.cics.server.InvalidTerminalIdException.
Class that represents the CICS TERMIDERR condition.
InvalidTransactionIdException - exception com.ibm.cics.server.InvalidTransactionIdException.
Class that represents the CICS TRANSIDERR condition.
InvalidUserIdException - exception com.ibm.cics.server.InvalidUserIdException.
Class that represents the CICS USERIDERR condition.
IsCICS - class com.ibm.cics.server.IsCICS.
Class to call the JNI function ..._DTCisCICS () to, currently, obtain whether we're currently in CICS and/or we can use the CICS API.
IsCICS() - Constructor for class com.ibm.cics.server.IsCICS
 
ItemErrorException - exception com.ibm.cics.server.ItemErrorException.
Class that represents the CICS ITEMERR condition.
ItemHolder - class com.ibm.cics.server.ItemHolder.
This class holds an array of bytes that is the data read from a TSQ.
ItemHolder() - Constructor for class com.ibm.cics.server.ItemHolder
Constructs a ItemHolder without a value.
increment() - Method in class com.ibm.cics.server.Cursor
Increment the cursor position.
increment(int) - Method in class com.ibm.cics.server.Cursor
Increment the cursor position by the supplied amount.
incrementRow() - Method in class com.ibm.cics.server.Cursor
Increment the row of the cursor (by 1).
initRedirect(String, PrintStream, String, String, Integer, String) - Method in interface com.ibm.cics.server.OutputRedirectionPlugin
 
initiate() - Method in class com.ibm.cics.server.AttachInitiator
 
initiate(byte[]) - Method in class com.ibm.cics.server.AttachInitiator
 
insertBinary(byte[], DocumentLocation) - Method in class com.ibm.cics.server.Document
Usage:
Insert a Java byte array into the Document object.
insertBookmark(String, DocumentLocation) - Method in class com.ibm.cics.server.Document
Usage:
Insert a bookmark into the Document object.
insertDocument(Document, DocumentLocation) - Method in class com.ibm.cics.server.Document
Usage:
Insert a Document object into the Document object.
insertFromDocRetrieve(byte[], DocumentLocation) - Method in class com.ibm.cics.server.Document
Usage:
Insert a retrieved document into the Document object.
insertFromTemplate(String, DocumentLocation) - Method in class com.ibm.cics.server.Document
Usage:
Insert a template into the Document object.
insertSymbol(String, DocumentLocation) - Method in class com.ibm.cics.server.Document
Usage:
Insert the data associated with the symbol in the symbol table into the Document object.
insertSymbol(String, String, DocumentLocation) - Method in class com.ibm.cics.server.Document
Usage:
Insert the data associated with the symbol in the symbol table into the Document object.
insertTemplate(String, DocumentLocation) - Method in class com.ibm.cics.server.Document
Usage:
Insert the template specified by the document template definition into the Document object.
insertTemplate(String, String, DocumentLocation) - Method in class com.ibm.cics.server.Document
Usage:
Insert the template specified by the document template definition into the Document object.
insertText(String, DocumentLocation) - Method in class com.ibm.cics.server.Document
Usage:
Insert text into the Document object.
insertText(String, String, DocumentLocation) - Method in class com.ibm.cics.server.Document
Usage:
Insert text into the Document object.
invoke(Channel, String) - Method in class com.ibm.cics.server.WebService
Invoke the named operation on the webservice.
invoke(Channel, String, String) - Method in class com.ibm.cics.server.WebService
Invoke the named operation on the webservice using a specified URI.
isBodyComplete() - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Returns a boolean which indicates whether the body returned by getContent() was completely returned.
isBodyComplete() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns a boolean which indicates whether the body returned by getContent() was completely returned or the last portion of the body was returned by the last getContent() call.
isBodyComplete() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns a boolean which indicates whether the body returned by getContent() method was complete or not.
isBodyPartial() - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Returns a boolean which indicates whether body returned by getContent() was a partial body or not.
isBodyPartial() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns a boolean which indicates whether the body returned by getContent() was a partial body or not.
isBodyPartial() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns a boolean which indicates whether the body returned by getContent() method was a partial body or not.
isBodyTruncated() - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Returns a boolean which indicates whether the body returned by getContent() was truncated or not.
isBodyTruncated() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns a boolean which indicates whether the body returned by getContent() was truncated or not.
isBodyTruncated() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns a boolean which indicates whether the body returned by getContent() method was truncated or not.
isChecked() - Method in class com.ibm.cics.server.StartRequest
Is this start request to be checked?
isClientAuth() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns a boolean which indicates whether the Secure Sockets Layer (SSL) is client authorised or not.
isDataHttp() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns a boolean which indicates the request type.
isException() - Method in class com.ibm.cics.server.EnterRequest
Is a trace entry to be produced on an exception if trace flags are off?
isProtected() - Method in class com.ibm.cics.server.StartRequest
Is this start request to be protected?
isSSL() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Returns a boolean which indicates whether the Secure Sockets Layer (SSL) is being used.
isSchemeHttp() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns a boolean which indicates if the scheme is HTTP or not.
isSchemeHttps() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Returns a boolean which indicates if the scheme is HTTPS or not.
isXRBA() - Method in class com.ibm.cics.server.ESDS
isXRBA.
issue() - Method in class com.ibm.cics.server.StartRequest
Issue the start request passing no data to the started task.
issue(byte[]) - Method in class com.ibm.cics.server.StartRequest
Issue the start request, passing a byte array to the started task.
issue(Channel) - Method in class com.ibm.cics.server.StartRequest
Issue the start request, passing a Channel to the started task.
issueAbend() - Method in class com.ibm.cics.server.Conversation
 
issueConfirmation() - Method in class com.ibm.cics.server.Conversation
 
issueError() - Method in class com.ibm.cics.server.Conversation
 
issuePrepare() - Method in class com.ibm.cics.server.Conversation
 
issueSignal() - Method in class com.ibm.cics.server.Conversation
 

K

KSDS - class com.ibm.cics.server.KSDS.
This class is the implementation class for the KSDS kind of file.
KSDS() - Constructor for class com.ibm.cics.server.KSDS
Construct a default KSDS bean.
KeyHolder - class com.ibm.cics.server.KeyHolder.
This class holds an array of bytes that is the key of a file.
KeyHolder() - Constructor for class com.ibm.cics.server.KeyHolder
Constructs a KeyHolder without a value.
KeyHolder(byte[]) - Constructor for class com.ibm.cics.server.KeyHolder
Constructs a KeyHolder without a value.
KeyedFile - class com.ibm.cics.server.KeyedFile.
This is the implementation class for the KeyedFile interface.
KeyedFile() - Constructor for class com.ibm.cics.server.KeyedFile
Construct a default KeyedFile object.
KeyedFileBrowse - class com.ibm.cics.server.KeyedFileBrowse.
This class implements browsing a keyed file.

L

LengthErrorException - exception com.ibm.cics.server.LengthErrorException.
Class that represents the CICS LENGERR condition.
LogicException - exception com.ibm.cics.server.LogicException.
Class that represents the CICS ILLOGIC condition.
link() - Method in class com.ibm.cics.server.Program
Perform a simple link to the program without passing in a COMMAREA.
link(byte[]) - Method in class com.ibm.cics.server.Program
Link to the program, passing in a COMMAREA.
link(byte[], int) - Method in class com.ibm.cics.server.Program
Version of the link() method that takes the DATALENGTH parameter.
link(IByteBuffer) - Method in class com.ibm.cics.server.Program
Version of the link() method that takes a single IByteBuffer.
link(IByteBuffer, IByteBuffer) - Method in class com.ibm.cics.server.Program
Version of the link() method that takes a separate IByteBuffer for the input data and output data.
link(Channel) - Method in class com.ibm.cics.server.Program
Perform a link to the program passing a CHANNEL.
lookup(int) - Static method in class com.ibm.cics.server.ConversationState
 
lookup(int) - Static method in class com.ibm.cics.server.SyncLevel
 

M

MAIN - Static variable in class com.ibm.cics.server.TSQType
 
MSG0001 - Static variable in class com.ibm.cics.server.Message
 
MSG0002 - Static variable in class com.ibm.cics.server.Message
 
MSG0003 - Static variable in class com.ibm.cics.server.Message
 
MSG0004 - Static variable in class com.ibm.cics.server.Message
 
MapErrorException - exception com.ibm.cics.server.MapErrorException.
Class that represents the CICS MAPERROR condition.
MapFailureException - exception com.ibm.cics.server.MapFailureException.
Class that represents the CICS MAPFAIL condition.
MapPageOverflowException - exception com.ibm.cics.server.MapPageOverflowException.
Class that represents the CICS OVERFLOW condition.
Message - class com.ibm.cics.server.Message.
 
Message() - Constructor for class com.ibm.cics.server.Message
 

N

NLEOM - Static variable in interface com.ibm.cics.server.TerminalSendTextBits
 
NOAUTHENTIC - Static variable in class com.ibm.cics.server.TcpipRequest
 
NONE - Static variable in class com.ibm.cics.server.SyncLevel
 
NOSSL - Static variable in class com.ibm.cics.server.TcpipRequest
 
NOTALLOCATED - Static variable in class com.ibm.cics.server.ConversationState
 
NOTSET - Static variable in class com.ibm.cics.server.Container
 
NOTSET - Static variable in class com.ibm.cics.server.Document
 
NOTSET - Static variable in class com.ibm.cics.server.HttpClientRequest
 
NOTSET - Static variable in class com.ibm.cics.server.HttpClientResponse
 
NOTSET - Static variable in class com.ibm.cics.server.HttpRequest
 
NOTSET - Static variable in class com.ibm.cics.server.HttpResponse
 
NOTSET - Static variable in class com.ibm.cics.server.HttpSession
 
NOTSET - Static variable in class com.ibm.cics.server.SymbolList
 
NOTSET - Static variable in class com.ibm.cics.server.TcpipRequest
 
NOTSUPPORTED - Static variable in class com.ibm.cics.server.TcpipRequest
 
NOT_CICS_REGION - Static variable in class com.ibm.cics.server.IsCICS
 
NULL - Static variable in class com.ibm.cics.server.AIDValue
 
NUMBER_OF_BITS - Static variable in interface com.ibm.cics.server.RegionTraceBits
 
NUMBER_OF_BITS - Static variable in interface com.ibm.cics.server.RetrieveBits
 
NUMBER_OF_BITS - Static variable in interface com.ibm.cics.server.TerminalSendBits
 
NUMBER_OF_BITS - Static variable in interface com.ibm.cics.server.TerminalSendCommonBits
 
NUMBER_OF_BITS - Static variable in interface com.ibm.cics.server.TerminalSendControlBits
 
NUMBER_OF_BITS - Static variable in interface com.ibm.cics.server.TerminalSendTextBits
 
NameErrorException - exception com.ibm.cics.server.NameErrorException.
Class that represents the CICS NAMEERROR condition.
NameResource - class com.ibm.cics.server.NameResource.
This class provides the implementation for named synchronized resources.
NameResource() - Constructor for class com.ibm.cics.server.NameResource
Construct a default NameResource.
NameValueData - class com.ibm.cics.server.NameValueData.
Usage:
This abstract class is used to store name value pairs.
NoJournalBufferSpaceException - exception com.ibm.cics.server.NoJournalBufferSpaceException.
Class that represents the CICS NOJBUFSP condition.
NoPassbookReadException - exception com.ibm.cics.server.NoPassbookReadException.
Class that represents the CICS NOPASSBKRD condition.
NoPassbookWriteException - exception com.ibm.cics.server.NoPassbookWriteException.
Class that represents the CICS NOPASSBKWR condition.
NoSpaceException - exception com.ibm.cics.server.NoSpaceException.
Class that represents the CICS NOSPACE condition.
NoSpoolException - exception com.ibm.cics.server.NoSpoolException.
Class that represents the CICS NOSPOOL condition.
NoStorageException - exception com.ibm.cics.server.NoStorageException.
Class that represents the CICS NOSTG condition.
NonHttpDataException - exception com.ibm.cics.server.NonHttpDataException.
Usage:
This exception is produced when the java program has called HttpRequest method getContent() which invokes CICS API command WEB RECEIVE and the data returned from the command is of type NONHTTP.
NotAllocatedException - exception com.ibm.cics.server.NotAllocatedException.
Class that represents the CICS NOTALLOC condition.
NotAuthorisedException - exception com.ibm.cics.server.NotAuthorisedException.
Class that represents the CICS NOTAUTH condition.
NotOpenException - exception com.ibm.cics.server.NotOpenException.
Class that represents the CICS NOTOPEN condition.
NotValidException - exception com.ibm.cics.server.NotValidException.
Class that represents the CICS NONVAL condition.
next() - Method in class com.ibm.cics.server.ContainerIterator
Get the next Container from the Channel.
next(long, RecordHolder) - Method in class com.ibm.cics.server.ESDS_Browse
Read the next record during a browse, changing the current position.
next(RecordHolder) - Method in class com.ibm.cics.server.ESDS_Browse
Read the next record during a browse.
next(byte[], RecordHolder, KeyHolder) - Method in class com.ibm.cics.server.KeyedFileBrowse
Read the next record during a browse, changing the current position.
next(RecordHolder, KeyHolder) - Method in class com.ibm.cics.server.KeyedFileBrowse
Read the next record during a browse.
next(long, RecordHolder) - Method in class com.ibm.cics.server.RRDS_Browse
Read the next record during a browse, changing the current position.
next(RecordHolder) - Method in class com.ibm.cics.server.RRDS_Browse
Read the next record during a browse.

O

OWNER - Static variable in class com.ibm.cics.server.CertificateInfo
 
OutputRedirectionPlugin - interface com.ibm.cics.server.OutputRedirectionPlugin.
Usage:
This interface provides a single method to the CICS Wrapper class for use when redirecting requests for STDOUT and STDERR.
open() - Method in class com.ibm.cics.server.HttpSession
Usage:
Open a session with a host on a remote server.
out - Variable in class com.ibm.cics.server.Task
A PrintWriter which is directed at the user's terminal, if the Principal Facility is a terminal, or to System.out if it is not.

P

PA1 - Static variable in class com.ibm.cics.server.AIDValue
 
PA2 - Static variable in class com.ibm.cics.server.AIDValue
 
PA3 - Static variable in class com.ibm.cics.server.AIDValue
 
PENDFREE - Static variable in class com.ibm.cics.server.ConversationState
 
PENDRECEIVE - Static variable in class com.ibm.cics.server.ConversationState
 
PF1 - Static variable in class com.ibm.cics.server.AIDValue
 
PF10 - Static variable in class com.ibm.cics.server.AIDValue
 
PF11 - Static variable in class com.ibm.cics.server.AIDValue
 
PF12 - Static variable in class com.ibm.cics.server.AIDValue
 
PF13 - Static variable in class com.ibm.cics.server.AIDValue
 
PF14 - Static variable in class com.ibm.cics.server.AIDValue
 
PF15 - Static variable in class com.ibm.cics.server.AIDValue
 
PF16 - Static variable in class com.ibm.cics.server.AIDValue
 
PF17 - Static variable in class com.ibm.cics.server.AIDValue
 
PF18 - Static variable in class com.ibm.cics.server.AIDValue
 
PF19 - Static variable in class com.ibm.cics.server.AIDValue
 
PF2 - Static variable in class com.ibm.cics.server.AIDValue
 
PF20 - Static variable in class com.ibm.cics.server.AIDValue
 
PF21 - Static variable in class com.ibm.cics.server.AIDValue
 
PF22 - Static variable in class com.ibm.cics.server.AIDValue
 
PF23 - Static variable in class com.ibm.cics.server.AIDValue
 
PF24 - Static variable in class com.ibm.cics.server.AIDValue
 
PF3 - Static variable in class com.ibm.cics.server.AIDValue
 
PF4 - Static variable in class com.ibm.cics.server.AIDValue
 
PF5 - Static variable in class com.ibm.cics.server.AIDValue
 
PF6 - Static variable in class com.ibm.cics.server.AIDValue
 
PF7 - Static variable in class com.ibm.cics.server.AIDValue
 
PF8 - Static variable in class com.ibm.cics.server.AIDValue
 
PF9 - Static variable in class com.ibm.cics.server.AIDValue
 
PRINT - Static variable in interface com.ibm.cics.server.TerminalSendCommonBits
 
PartitionFailureException - exception com.ibm.cics.server.PartitionFailureException.
Class that represents the CICS PARTNFAIL condition.
Program - class com.ibm.cics.server.Program.
This Bean provides the Java interface to CICS Program Control equivalent to the LINK and XCTL commands.
Program() - Constructor for class com.ibm.cics.server.Program
Construct a Program bean.
previous(long, RecordHolder) - Method in class com.ibm.cics.server.ESDS_Browse
Read the previous record during a browse, changing the current position.
previous(RecordHolder) - Method in class com.ibm.cics.server.ESDS_Browse
Read the previous record during a browse.
previous(byte[], RecordHolder, KeyHolder) - Method in class com.ibm.cics.server.KeyedFileBrowse
Read the previous record during a browse, changing the current position.
previous(RecordHolder, KeyHolder) - Method in class com.ibm.cics.server.KeyedFileBrowse
Read the previous record during a browse.
previous(long, RecordHolder) - Method in class com.ibm.cics.server.RRDS_Browse
Read the previous record during a browse, changing the current position.
previous(RecordHolder) - Method in class com.ibm.cics.server.RRDS_Browse
Read the previous record during a browse.
put(byte[]) - Method in class com.ibm.cics.server.Container
Put some byte[] array data into the Container.
put(byte[], String) - Method in class com.ibm.cics.server.Container
Put some byte[] array data into the Container.
put(String) - Method in class com.ibm.cics.server.Container
Put some String data into the Container.

Q

QUEUE - Static variable in interface com.ibm.cics.server.RetrieveBits
 
QueueBusyException - exception com.ibm.cics.server.QueueBusyException.
Class that represents the CICS QBUSY condition.
QueueZeroException - exception com.ibm.cics.server.QueueZeroException.
Class that represents the CICS QZERO condition.
queue - Variable in class com.ibm.cics.server.RetrievedData
 

R

RECEIVE - Static variable in class com.ibm.cics.server.ConversationState
 
RECEIVER - Static variable in class com.ibm.cics.server.SoapFault
Use for the faultcode when the fault is caused by the Receiver
REQUIRED - Static variable in class com.ibm.cics.server.TcpipRequest
 
ROLLBACK - Static variable in class com.ibm.cics.server.ConversationState
 
RRDS - class com.ibm.cics.server.RRDS.
This class is the implementation class for the RRDS kind of file.
RRDS() - Constructor for class com.ibm.cics.server.RRDS
Construct a default RRDS object.
RRDS_Browse - class com.ibm.cics.server.RRDS_Browse.
This class implements the CICS File Control interface for browsing RRDS files via RRN.
RTERMID - Static variable in interface com.ibm.cics.server.RetrieveBits
 
RTRANSID - Static variable in interface com.ibm.cics.server.RetrieveBits
 
ReadAttentionException - exception com.ibm.cics.server.ReadAttentionException.
Class that represents the CICS RDATT condition.
RecordHolder - class com.ibm.cics.server.RecordHolder.
This class holds an array of bytes that is the data read from a file.
RecordHolder() - Constructor for class com.ibm.cics.server.RecordHolder
Constructs a RecordHolder without a value.
RecordNotFoundException - exception com.ibm.cics.server.RecordNotFoundException.
Class that represents the CICS NOTFND condition.
Region - class com.ibm.cics.server.Region.
This class provides a set of methods and variables that correspond to a CICS region.
Region() - Constructor for class com.ibm.cics.server.Region
 
RegionTraceBits - interface com.ibm.cics.server.RegionTraceBits.
This interface provides a set of constants that should be used to construct a java.util.BitSet for use with the TRACE-related API.
RemotableResource - class com.ibm.cics.server.RemotableResource.
This abstract class provides the common implementation for resources that can be accessed on other systems.
RemotableResource() - Constructor for class com.ibm.cics.server.RemotableResource
Construct a default RemotableResource.
ResetOnInitialization - interface com.ibm.cics.server.ResetOnInitialization.
This interface is used by classes that need to register themselves as requiring resetting on entry to the JVM.
Resource - class com.ibm.cics.server.Resource.
This abstract class provides the common implementation for named resources.
Resource() - Constructor for class com.ibm.cics.server.Resource
Construct a default resource.
ResourceUnavailableException - exception com.ibm.cics.server.ResourceUnavailableException.
Class that represents the CICS ENQBUSY condition.
RetrieveBits - interface com.ibm.cics.server.RetrieveBits.
This interface provides a set of constants that should be used to construct a java.util.BitSet for use with the Task.retrieve() method.
RetrievedData - class com.ibm.cics.server.RetrievedData.
This class holds the data retrieved for a task that has been STARTed.
RetrievedDataHolder - class com.ibm.cics.server.RetrievedDataHolder.
This class holds the values that can be retrieved for a (started) task.
RetrievedDataHolder() - Constructor for class com.ibm.cics.server.RetrievedDataHolder
Constructs a RetrievedDataHolder.
ReturnedPageException - exception com.ibm.cics.server.ReturnedPageException.
Class that represents the CICS RETPAGE condition.
RolledBackException - exception com.ibm.cics.server.RolledBackException.
Class that represents the CICS ROLLEDBACK condition.
RouteFailedException - exception com.ibm.cics.server.RouteFailedException.
Class that represents the CICS RTEFAIL condition.
RoutePartiallyFailedException - exception com.ibm.cics.server.RoutePartiallyFailedException.
Class that represents the CICS RTESOME condition.
read(long, RecordHolder) - Method in class com.ibm.cics.server.ESDS
Read a specific record from an ESDS file.
read(byte[], RecordHolder) - Method in class com.ibm.cics.server.KeyedFile
Read a specific record from a file.
read(byte[], SearchType, RecordHolder) - Method in class com.ibm.cics.server.KeyedFile
Read a record from a file using the specified type of search.
read(long, RecordHolder) - Method in class com.ibm.cics.server.RRDS
Read a specific record from an RRDS file.
readData(DataHolder) - Method in class com.ibm.cics.server.TDQ
Read data from a TDQ.
readDataConditional(DataHolder) - Method in class com.ibm.cics.server.TDQ
Read data from a TDQ.
readForUpdate(long, RecordHolder) - Method in class com.ibm.cics.server.ESDS
Read a specific record from an ESDS file and lock it for update.
readForUpdate(byte[], RecordHolder) - Method in class com.ibm.cics.server.KeyedFile
Read a specific record from a file, locking it for update.
readForUpdate(byte[], SearchType, RecordHolder) - Method in class com.ibm.cics.server.KeyedFile
Read a record from a file using the specified type of search, locking it for update.
readForUpdate(long, RecordHolder) - Method in class com.ibm.cics.server.RRDS
Read a specific record from an RRDS file and lock it for update.
readGeneric(byte[], RecordHolder) - Method in class com.ibm.cics.server.KeyedFile
Read a record from a file using a generic key.
readGeneric(byte[], SearchType, RecordHolder) - Method in class com.ibm.cics.server.KeyedFile
Read a record from a file using a generic key and specifying the type of search..
readGenericForUpdate(byte[], RecordHolder) - Method in class com.ibm.cics.server.KeyedFile
Read a record for update from a file using a generic key.
readGenericForUpdate(byte[], SearchType, RecordHolder) - Method in class com.ibm.cics.server.KeyedFile
Read a record for update from a file using a generic key.
readItem(int, ItemHolder) - Method in class com.ibm.cics.server.TSQ
Read a specified item from a TSQ.
readNextItem(ItemHolder) - Method in class com.ibm.cics.server.TSQ
Read the next item from a TSQ.
receive(DataHolder) - Method in class com.ibm.cics.server.Conversation
DTC converse
receive(DataHolder, int, boolean) - Method in class com.ibm.cics.server.Conversation
DTC converse
receive(DataHolder) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Receive 3270 data stream from the terminal
receiveASIS(DataHolder) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Receive 3270 data stream from the terminal without uppercase translation
receiveBuffer(DataHolder) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Receive 3270 buffer from the terminal
receiveBufferASIS(DataHolder) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Receive 3270 buffer from the terminal without uppercase translation
registerInitializer(ResetOnInitialization) - Static method in class com.ibm.cics.server.WrapperHelper
This method is called by the first insatnce of any class loaded that requires reinitialization at each JVM use.
registerTerminator(TidyUpOnTermination) - Static method in class com.ibm.cics.server.WrapperHelper
This method is called by the first insatnce of any class loaded that requires reinitialization at each JVM use.
remove() - Method in class com.ibm.cics.server.ContainerIterator
Remove an element from the Channel.
reset(long) - Method in class com.ibm.cics.server.ESDS_Browse
Reset the browse.
reset(byte[]) - Method in class com.ibm.cics.server.KeyedFileBrowse
Reset the browse.
reset(byte[], SearchType) - Method in class com.ibm.cics.server.KeyedFileBrowse
Reset the browse.
reset(byte[], boolean) - Method in class com.ibm.cics.server.KeyedFileBrowse
Reset the browse.
reset(byte[], boolean, SearchType) - Method in class com.ibm.cics.server.KeyedFileBrowse
Reset the browse.
reset(long) - Method in class com.ibm.cics.server.RRDS_Browse
Reset the browse.
retrieve() - Method in class com.ibm.cics.server.Document
Usage:
Return a copy of the Document object in a Java byte array.
retrieve(String) - Method in class com.ibm.cics.server.Document
Usage:
Return a copy of the Document object in a Java byte array.
retrieve(String, boolean) - Method in class com.ibm.cics.server.Document
Usage:
Return a copy of the Document object in a Java byte array.
retrieve(BitSet, RetrievedDataHolder) - Method in class com.ibm.cics.server.Task
Retrieve any data specified when this task was started.
rewrite(byte[]) - Method in class com.ibm.cics.server.ESDS
Update a record in a file.
rewrite(byte[]) - Method in class com.ibm.cics.server.KeyedFile
Update a record in a file.
rewrite(byte[]) - Method in class com.ibm.cics.server.RRDS
Update a record in a file.
rewriteItem(int, byte[]) - Method in class com.ibm.cics.server.TSQ
Rewrite an existing item.
rewriteItemConditional(int, byte[]) - Method in class com.ibm.cics.server.TSQ
Rewrite an existing item.
rollback() - Method in class com.ibm.cics.server.Task
Roll back the work done as part of the task.

S

SCCSID - Static variable in interface com.ibm.cics.server.ResetOnInitialization
 
SCCSID - Static variable in interface com.ibm.cics.server.TidyUpOnTermination
 
SEND - Static variable in class com.ibm.cics.server.ConversationState
 
SENDER - Static variable in class com.ibm.cics.server.SoapFault
Use for the faultcode when the fault is caused by the Sender
SERVER - Static variable in class com.ibm.cics.server.SoapFault
Use for the faultcode when the fault is caused by the Server
SSL - Static variable in class com.ibm.cics.server.TcpipRequest
 
STRELERRException - exception com.ibm.cics.server.STRELERRException.
Class that represents the CICS STRELERR condition.
SUPPORTED - Static variable in class com.ibm.cics.server.TcpipRequest
 
SYNCFREE - Static variable in class com.ibm.cics.server.ConversationState
 
SYNCPOINT - Static variable in class com.ibm.cics.server.SyncLevel
 
SYNCRECEIVE - Static variable in class com.ibm.cics.server.ConversationState
 
SYNCSEND - Static variable in class com.ibm.cics.server.ConversationState
 
SYSTEM - Static variable in interface com.ibm.cics.server.RegionTraceBits
 
SearchType - class com.ibm.cics.server.SearchType.
This class implements an enumeration of the different search types that can be used with generic keys.
SessionBusyException - exception com.ibm.cics.server.SessionBusyException.
Class that represents the CICS SESSBUSY condition.
SessionErrorException - exception com.ibm.cics.server.SessionErrorException.
Class that represents the CICS SESSIONERR condition.
SoapFault - class com.ibm.cics.server.SoapFault.
This class provides the Java interface to CICS SOAPFAULT API.
SoapFault() - Constructor for class com.ibm.cics.server.SoapFault
 
SpoolBusyException - exception com.ibm.cics.server.SpoolBusyException.
Class that represents the CICS SPOLBUSY condition.
SpoolErrorException - exception com.ibm.cics.server.SpoolErrorException.
Class that represents the CICS SPOLERR condition.
StartFailedException - exception com.ibm.cics.server.StartFailedException.
Class that represents the CICS NOSTART condition.
StartRequest - class com.ibm.cics.server.StartRequest.
This Bean provides the Java equivalent to the EXEC CICS START command.
StartRequest() - Constructor for class com.ibm.cics.server.StartRequest
Construct a StartRequest bean.
StartRequestBeanInfo - class com.ibm.cics.server.StartRequestBeanInfo.
This Class provides the BeanInfo for a StartRequest.
StartRequestBeanInfo() - Constructor for class com.ibm.cics.server.StartRequestBeanInfo
 
SuppressedException - exception com.ibm.cics.server.SuppressedException.
Class that represents the CICS SUPPRESSED condition.
SymbolErrorException - exception com.ibm.cics.server.SymbolErrorException.
Usage:
This class represents the CICS SYMBOLERR condition.
SymbolList - class com.ibm.cics.server.SymbolList.
Usage:
This Class provides a wrapper for the symbol list keywords SYMBOLLIST, DELIMITER and UNESCAPED of the CICS DOCUMENT API.
SymbolList(String) - Constructor for class com.ibm.cics.server.SymbolList
Usage:
Public constructor which accepts a SYMBOLLIST string
SymbolList(byte[]) - Constructor for class com.ibm.cics.server.SymbolList
 
SymbolList(String, char, boolean) - Constructor for class com.ibm.cics.server.SymbolList
Usage:
Public constructor which accepts a SYMBOLLIST string, a DELIMITER character and a UNESCAPED indicator.
SymbolList(byte[], char, boolean) - Constructor for class com.ibm.cics.server.SymbolList
 
SyncLevel - class com.ibm.cics.server.SyncLevel.
This class implements an enumeration of the different synchronization levels that can be specified for an APPC conversation.
SyncLevelEditor - class com.ibm.cics.server.SyncLevelEditor.
This Class provides a property editor for the syncLevel property of an AttachInitiator.
SyncLevelEditor() - Constructor for class com.ibm.cics.server.SyncLevelEditor
 
SynchronizationResource - class com.ibm.cics.server.SynchronizationResource.
This abstract class provides the common implementation for synchronized resources.
SynchronizationResource() - Constructor for class com.ibm.cics.server.SynchronizationResource
Construct a default SynchronizationResource.
SystemBusyException - exception com.ibm.cics.server.SystemBusyException.
Class that represents the CICS SYSBUSY condition.
sccsid - Static variable in class com.ibm.cics.server.SoapFault
 
send(byte[]) - Method in class com.ibm.cics.server.Conversation
Send data.
send(byte[], ConversationSendOptions) - Method in class com.ibm.cics.server.Conversation
 
send(ConversationSendOptions) - Method in class com.ibm.cics.server.Conversation
 
send(HttpSession) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Send an request without a body to the server.
send(byte[]) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Send a 3270 data stream to the terminal.
send(byte[], BitSet) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Send a 3270 data stream to the terminal with options.
sendChunk(HttpSession, String) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Send an application buffer to the server as part of a chunked request.
sendChunk(HttpSession, byte[]) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Send an application buffer to the server as part of a chunked request.
sendChunk(String) - Method in class com.ibm.cics.server.HttpResponse
Usage:
Send a chunk of the chunked response to the client.
sendChunk(byte[]) - Method in class com.ibm.cics.server.HttpResponse
Usage:
Send a chunk of the chunked response to the client.
sendContainer(HttpSession, Container) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Send data stored in a container to the server.
sendContainer(Container) - Method in class com.ibm.cics.server.HttpResponse
Usage:
Send the data stored in a container to the client.
sendControl(Cursor) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Send cursor control to the terminal.
sendControl(Cursor, BitSet) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Send cursor control and device controls to the terminal.
sendControl(BitSet) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Send device controls to the terminal.
sendDocument(HttpSession, Document) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Send a document to the server.
sendDocument(Document, short, String, String) - Method in class com.ibm.cics.server.HttpResponse
Usage:
Send a document to the client.
sendDocument(Document) - Method in class com.ibm.cics.server.HttpResponse
Usage:
Send a document to the client.
sendFrom(HttpSession, String) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Send an application buffer to the server.
sendFrom(HttpSession, byte[]) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Send an application buffer to the server.
sendFrom(String) - Method in class com.ibm.cics.server.HttpResponse
Usage:
Send an application buffer to the client.
sendFrom(byte[]) - Method in class com.ibm.cics.server.HttpResponse
Usage:
Send an application buffer to the client.
sendLastChunk(HttpSession) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Indicate that the chunked request is complete.
sendLastChunk() - Method in class com.ibm.cics.server.HttpResponse
Usage:
Indicate that the chunked response is complete.
sendText(byte[]) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Send text to the terminal.
sendText(byte[], Cursor) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Send text to the terminal, specifying a cursor position.
sendText(byte[], Cursor, BitSet) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Send text to the terminal, specifying cursor position and options.
sendText(byte[], BitSet) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Send text to the terminal, specifying options.
setAPPLID(String) - Static method in class com.ibm.cics.server.Region
 
setActionEventual() - Method in class com.ibm.cics.server.HttpResponse
Usage:
Sets WEB SEND command option ACTION to EVENTUAL.
setActionExpect() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option ACTION to EXPECT.
setActionImmediate() - Method in class com.ibm.cics.server.HttpResponse
Usage:
Sets WEB SEND command option ACTION to IMMEDIATE.
setAddress(byte[]) - Method in class com.ibm.cics.server.AddressResource
Sets the synchronization address
setAsText(String) - Method in class com.ibm.cics.server.SyncLevelEditor
 
setAsText(String) - Method in class com.ibm.cics.server.TSQNameEditor
 
setAsText(String) - Method in class com.ibm.cics.server.TSQTypeEditor
 
setAuthenticationBasic() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option AUTHENTICATE to BASIC.This method also clears any username or password information already set by method setAuthenticationBasic(String userName, String password).
setAuthenticationBasic(String, String) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option AUTHENTICATE to BASIC and sets the WEB SEND SESSTOKEN command options USERNAME, USERNAMELEN, PASSWORD and PASSWORDLEN.
setAuthenticationNone() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option AUTHENTICATE to NONE.
setCWA(byte[]) - Static method in class com.ibm.cics.server.Region
Update the contents of the CWA from an array of bytes.
setCertificate(String) - Method in class com.ibm.cics.server.HttpSession
Usage:
Sets WEB OPEN command option CERTIFICATE.
setCharacterset(String) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option CHARACTERSET.
setCharacterset(String) - Method in class com.ibm.cics.server.HttpRequest
Usage:
Sets WEB RECEIVE command option CHARACTERSET.
setCharacterset(String) - Method in class com.ibm.cics.server.HttpResponse
Usage:
Sets WEB SEND command option CHARACTERSET.
setCharacterset(String) - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Sets WEB RECEIVE command option CHARACTERSET.
setChecked(boolean) - Method in class com.ibm.cics.server.StartRequest
Control whether start request is checked or not.
setCiphers(String, short) - Method in class com.ibm.cics.server.HttpSession
Usage:
Sets WEB OPEN command options CIPHER and NUMCIPHERS.
setClientCodePage(String) - Method in class com.ibm.cics.server.HttpRequest
Usage:
Sets WEB RECEIVE command option CHARACTERSET.
setClientCodePage(String) - Method in class com.ibm.cics.server.HttpResponse
Usage:
Sets WEB SEND command option CHARACTERSET.
setClientCodePage(String) - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Sets WEB RECEIVE command option CHARACTERSET.
setClientConvert() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option CLIENTCONV to CLICONVERT.
setClientConvert() - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Sets WEB RECEIVE SESSTOKEN command option CLIENTCONV to CLICONVERT.
setClose() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option CLOSESTATUS to CLOSE.
setClose() - Method in class com.ibm.cics.server.HttpResponse
Usage:
Sets WEB SEND command option CLOSESTATUS to CLOSE.
setCodePage(String) - Method in class com.ibm.cics.server.HttpSession
Usage:
Sets WEB OPEN command option CODEPAGE.
setColumn(int) - Method in class com.ibm.cics.server.Cursor
Set the column of the cursor to the supplied value.
setConfirm() - Method in class com.ibm.cics.server.ConversationSendOptions
 
setDelimiter(char) - Method in class com.ibm.cics.server.SymbolList
Usage:
Store the delimiter value.
setDescription(String) - Method in class com.ibm.cics.server.Resource
Sets the description of the resource.
setDescription(String) - Method in class com.ibm.cics.server.SynchronizationResource
Sets the description of the synchronization resource.
setDocDelete() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option DOCSTATUS to DOCDELETE.
setDocDelete() - Method in class com.ibm.cics.server.HttpResponse
Usage:
Sets WEB SEND command option DOCSTATUS to DOCDELETE.
setException(boolean) - Method in class com.ibm.cics.server.EnterRequest
Control whether trace entry is produced on exception if trace flags are off
setHostCodePage(String) - Method in class com.ibm.cics.server.HttpRequest
Usage:
Sets WEB RECEIVE command option HOSTCODEPAGE.
setHostCodePage(String) - Method in class com.ibm.cics.server.HttpResponse
Usage:
Sets WEB SEND command option HOSTCODEPAGE.
setHostCodePage(String) - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Sets WEB RECEIVE command option HOSTCODEPAGE.
setID(byte[]) - Method in class com.ibm.cics.server.StartRequest
Set the ID that uniquely identifies the start request.
setIDFromString(String) - Method in class com.ibm.cics.server.StartRequest
Set the ID that uniquely identifies the start request from a String.
setInvite() - Method in class com.ibm.cics.server.ConversationSendOptions
 
setLast() - Method in class com.ibm.cics.server.ConversationSendOptions
 
setMaxLength(int) - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Sets WEB RECEIVE SESSTOKEN command option MAXLENGTH.
setMaxLength(int) - Method in class com.ibm.cics.server.HttpRequest
Usage:
Sets WEB RECEIVE command option MAXLENGTH.
setMaxLength(int) - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Sets WEB RECEIVE command option MAXLENGTH.
setMediaType(String) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option MEDIATYPE.
setMediaType(String) - Method in class com.ibm.cics.server.HttpResponse
Usage:
Sets WEB SEND command option MEDIATYPE.
setMethodDelete() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option METHOD to DELETE.
setMethodGet() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option METHOD to GET.
setMethodHead() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option METHOD to HEAD.
setMethodOptions() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option METHOD to OPTIONS.
setMethodPost() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option METHOD to POST.
setMethodPut() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option METHOD to PUT.
setMethodTrace() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option METHOD to TRACE.
setName(String) - Method in class com.ibm.cics.server.NameResource
Sets the resource name corresponding to this object.
setName(String) - Method in class com.ibm.cics.server.Resource
Sets the CICS resource name corresponding to this object.
setName(String) - Method in class com.ibm.cics.server.TSQ
Sets the name of the TSQ.
setNextCOMMAREA(byte[]) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Set the COMMAREA to be used with the next transaction to be run on input from the terminal.
setNextChannel(Channel) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Set the Channel to be used with the next transaction to be run on input from the terminal.
setNextTransaction(String) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Set the next transaction to be run on input from the terminal.
setNoClientConvert() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option CLIENTCONV to NOCLICONVERT.
setNoClientConvert() - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Sets WEB RECEIVE SESSTOKEN command option CLIENTCONV to NOCLICONVERT.
setNoClose() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option CLOSESTATUS to NOCLOSE.
setNoClose() - Method in class com.ibm.cics.server.HttpResponse
Usage:
Sets WEB SEND command option CLOSESTATUS to NOCLOSE.
setNoDocDelete() - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option DOCSTATUS to NODOCDELETE.
setNoDocDelete() - Method in class com.ibm.cics.server.HttpResponse
Usage:
Sets WEB SEND command option DOCSTATUS to NODOCDELETE.
setNoServerConvert() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Sets WEB RECEIVE command option SERVERCONV to NOSRVCONVERT.
setNoServerConvert() - Method in class com.ibm.cics.server.HttpResponse
Usage:
Sets WEB SEND command option SERVERCONV to NOSRVCONVERT.
setNoServerConvert() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Sets WEB RECEIVE command option SERVERCONV to NOSRVCONVERT.
setNoTruncate() - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Sets WEB RECEIVE SESSTOKEN command option NOTRUNCATE.
setNoTruncate() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Sets WEB RECEIVE command option NOTRUNCATE.
setNoTruncate() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Sets WEB RECEIVE command option NOTRUNCATE.
setPath(String) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option PATH.
setProcess(String) - Method in class com.ibm.cics.server.AttachInitiator
Sets the process of the attach.
setProfile(String) - Method in class com.ibm.cics.server.AttachInitiator
Sets the profile of the attach.
setProtected(boolean) - Method in class com.ibm.cics.server.StartRequest
Control whether start request is protected or not.
setQueryString(String) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option QUERYSTRING.
setQueue(boolean) - Method in class com.ibm.cics.server.AttachInitiator
 
setQueueName(byte[]) - Method in class com.ibm.cics.server.StartRequest
Sets the queueName of the start request.
setQueueName(byte[]) - Method in class com.ibm.cics.server.TSQ
Sets the queueName of the TSQ.
setQueueNameFromString(String) - Method in class com.ibm.cics.server.StartRequest
Sets the queue name of the start request.
setRTerminal(String) - Method in class com.ibm.cics.server.StartRequest
Set the terminal name to be retrieved by the started task.
setRTransaction(String) - Method in class com.ibm.cics.server.StartRequest
Set the transaction name to be retrieved by the started task.
setResource(String) - Method in class com.ibm.cics.server.EnterRequest
Set the Resource
setRow(int) - Method in class com.ibm.cics.server.Cursor
Set the row of the cursor to the supplied value.
setSYSID(String) - Static method in class com.ibm.cics.server.Region
 
setServerConvert() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Sets WEB RECEIVE command option SERVERCONV to SRVCONVERT.
setServerConvert() - Method in class com.ibm.cics.server.HttpResponse
Usage:
Sets WEB SEND command option SERVERCONV to SRVCONVERT.
setServerConvert() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Sets WEB RECEIVE command option SERVERCONV to SRVCONVERT.
setStatus(short, String) - Method in class com.ibm.cics.server.HttpResponse
Usage:
Sets WEB SEND command option STATUSCODE and STATUSTEXT..
setSymbolList(SymbolList) - Method in class com.ibm.cics.server.Document
Usage:
Add a symbol list to the symbol table associated with the Document object.
setSymbolList(String) - Method in class com.ibm.cics.server.SymbolList
Usage:
Store the symbol list.
setSymbolList(byte[]) - Method in class com.ibm.cics.server.SymbolList
 
setSyncLevel(SyncLevel) - Method in class com.ibm.cics.server.AttachInitiator
 
setSyncOnReturn(boolean) - Method in class com.ibm.cics.server.Program
Control whether the program always performs a SYNCPOINT when it returns.
setSysId(String) - Method in class com.ibm.cics.server.AttachInitiator
Sets the SYSID of the remote region that this Attach is targetted at.
setSysId(String) - Method in class com.ibm.cics.server.RemotableResource
Sets the SYSID of the remote region that really owns this resource.
setTCTUA(byte[]) - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Update the contents of the TCTUA from an array of bytes.
setTWA(byte[]) - Method in class com.ibm.cics.server.Task
Update the contents of the TWA from an array of bytes.
setTerminal(String) - Method in class com.ibm.cics.server.StartRequest
Set the name of the terminal to be used as the principal facility of the started task.
setTime(Calendar) - Method in class com.ibm.cics.server.StartRequest
Set the time at which the task will be started.
setTraceIdentifier(short) - Method in class com.ibm.cics.server.EnterRequest
Set the TraceIdentifier
setTransId(String) - Method in class com.ibm.cics.server.Program
Set the transaction name to be used when running the program remotely, instead of CPMI.
setTransId(String) - Method in class com.ibm.cics.server.StartRequest
Set the name of the Transaction to be started.
setTruncate() - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Resets WEB RECEIVE SESSTOKEN command option NOTRUNCATE.
setTruncate() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Resets WEB RECEIVE command option NOTRUNCATE.
setTruncate() - Method in class com.ibm.cics.server.TcpipRequest
Usage:
Resets WEB RECEIVE command option NOTRUNCATE.
setType(TSQType) - Method in class com.ibm.cics.server.TSQ
Sets the type of the TSQ.
setUnescaped(boolean) - Method in class com.ibm.cics.server.SymbolList
Usage:
Store the unescaped indicator.
setUrimap(String) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Sets WEB SEND SESSTOKEN command option URIMAP.
setWait() - Method in class com.ibm.cics.server.ConversationSendOptions
 
setXRBA(boolean) - Method in class com.ibm.cics.server.ESDS
SetXRBA.
startBrowse(long) - Method in class com.ibm.cics.server.ESDS
Create a browse against the file.
startBrowse(byte[]) - Method in class com.ibm.cics.server.KeyedFile
Create a browse against the file.
startBrowse(byte[], SearchType) - Method in class com.ibm.cics.server.KeyedFile
Create a browse against the file with a starting position determined by the type of search specified.
startBrowse(long) - Method in class com.ibm.cics.server.RRDS
Start a browse on a file
startBrowseFormField() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Signal the start of HTML form field browse from the first name-value pair.
startBrowseFormField(String) - Method in class com.ibm.cics.server.HttpRequest
Usage:
Signal the start of HTML form field browse from a specific name-value pair.
startBrowseFormField(String, String, String) - Method in class com.ibm.cics.server.HttpRequest
Usage:
Signal the start of HTML form field browse from a specific name-value pair.
startBrowseHeader(HttpSession) - Method in class com.ibm.cics.server.HttpClientResponse
Usage:
Signal the start of a browse of the HTTP headers from the first name-value pair.
startBrowseHeader() - Method in class com.ibm.cics.server.HttpRequest
Usage:
Signal the start of a browse of the HTTP headers from the first name-value pair.
startGenericBrowse(byte[], int) - Method in class com.ibm.cics.server.KeyedFile
Create a browse against the file using a generic key to specify the starting position.
startGenericBrowse(byte[], int, SearchType) - Method in class com.ibm.cics.server.KeyedFile
Create a browse against the file with a starting position determined by the type of search specified.

T

TCIDERRException - exception com.ibm.cics.server.TCIDERRException.
Class that represents the CICS TCIDERR condition.
TCTUAHolder - class com.ibm.cics.server.TCTUAHolder.
This class holds an array of bytes that is a copy of the contents of the TCTUA.
TCTUAHolder() - Constructor for class com.ibm.cics.server.TCTUAHolder
Constructs a TCTUAHolder without a value.
TCTUAHolder(byte[]) - Constructor for class com.ibm.cics.server.TCTUAHolder
Constructs a TCTUAHolder
TDQ - class com.ibm.cics.server.TDQ.
This Class provides the Java implementation of CICS Transient Data Queues (TDQs).
TDQ() - Constructor for class com.ibm.cics.server.TDQ
Construct a TDQ bean.
TSIOErrorException - exception com.ibm.cics.server.TSIOErrorException.
Class that represents the CICS TSIOERR condition.
TSQ - class com.ibm.cics.server.TSQ.
This Class provides the Java interface to CICS Temporary Storage Queues (TSQs).
TSQ() - Constructor for class com.ibm.cics.server.TSQ
Construct a TSQ bean.
TSQBeanInfo - class com.ibm.cics.server.TSQBeanInfo.
This Class provides the BeanInfo for a TSQ.
TSQBeanInfo() - Constructor for class com.ibm.cics.server.TSQBeanInfo
 
TSQNameEditor - class com.ibm.cics.server.TSQNameEditor.
This Class provides a property editor for the name property of a TSQ.
TSQNameEditor() - Constructor for class com.ibm.cics.server.TSQNameEditor
 
TSQType - class com.ibm.cics.server.TSQType.
This class implements an enumeration of the different types of TSQ.
TSQTypeEditor - class com.ibm.cics.server.TSQTypeEditor.
This Class provides a property editor for the type property of a TSQ.
TSQTypeEditor() - Constructor for class com.ibm.cics.server.TSQTypeEditor
 
TWAHolder - class com.ibm.cics.server.TWAHolder.
This class holds an array of bytes that is a copy of the contents of the TWA.
TWAHolder() - Constructor for class com.ibm.cics.server.TWAHolder
Constructs a TWAHolder without a value.
TWAHolder(byte[]) - Constructor for class com.ibm.cics.server.TWAHolder
Constructs a TWAHolder.
Task - class com.ibm.cics.server.Task.
This class provides a set of methods and variables that correspond to a CICS task.
TcpipRequest - class com.ibm.cics.server.TcpipRequest.
Usage:
This class provides the Java implementation of TCPIP requests related to the following CICS API commands: EXTRACT CERTIFICATE EXTRACT TCPIP WEB RECEIVE
TemplateErrorException - exception com.ibm.cics.server.TemplateErrorException.
Usage:
This exception represents the CICS TEMPLATERR condition
Terminal - class com.ibm.cics.server.Terminal.
This Class provides the Java interface to a CICS Terminal.
Terminal(String) - Constructor for class com.ibm.cics.server.Terminal
 
Terminal(String, String) - Constructor for class com.ibm.cics.server.Terminal
 
TerminalException - exception com.ibm.cics.server.TerminalException.
Class that represents the CICS TERMERR condition.
TerminalPrincipalFacility - class com.ibm.cics.server.TerminalPrincipalFacility.
This Class provides the Java interface to a CICS Terminal.
TerminalPrincipalFacilityExtended - class com.ibm.cics.server.TerminalPrincipalFacilityExtended.
Deprecated. This class was provided in CICS TS 1.3 to support additional functionality for the TerminalPrincipalFacility class, when using the Enterprise Toolkit for OS/390 (Java program objects). In CICS TS 2.1 and later, for interpreted Java (JVM programs), the additional functionality is now available directly in the TerminalPrincipalFacility class.
TerminalSendBits - interface com.ibm.cics.server.TerminalSendBits.
This interface provides a set of constants that should be used to construct a java.util.BitSet for use with the SEND-related API.
TerminalSendCommonBits - interface com.ibm.cics.server.TerminalSendCommonBits.
This interface provides a set of constants that should be used to construct a java.util.BitSet for use with the SEND-related API.
TerminalSendControlBits - interface com.ibm.cics.server.TerminalSendControlBits.
This interface provides a set of constants that should be used to construct a java.util.BitSet for use with sendControl().
TerminalSendTextBits - interface com.ibm.cics.server.TerminalSendTextBits.
This interface provides a set of constants that should be used to construct a java.util.BitSet for use sendText().
TidyUpOnTermination - interface com.ibm.cics.server.TidyUpOnTermination.
This interface is used by classes that need to register themselves as requiring resetting on exit from the JVM.
TimeExpiredException - exception com.ibm.cics.server.TimeExpiredException.
Class that represents the CICS EXPIRED condition.
TimedOutException - exception com.ibm.cics.server.TimedOutException.
Usage:
This exception represents the CICS TIMEDOUT condition
TokenErrorException - exception com.ibm.cics.server.TokenErrorException.
Class that represents the CICS TOKENERR condition
TransferOfControlException - exception com.ibm.cics.server.TransferOfControlException.
Class that represents the CICS SYSIDERR condition.
termId - Variable in class com.ibm.cics.server.RetrievedData
 
toBinary() - Method in class com.ibm.cics.server.Cursor
Convert the Cursor to a binary value.
toString() - Method in class com.ibm.cics.server.ConversationState
 
toString() - Method in class com.ibm.cics.server.SyncLevel
 
toString() - Method in class com.ibm.cics.server.TSQType
 
transId - Variable in class com.ibm.cics.server.RetrievedData
 
tryEnqueue() - Method in class com.ibm.cics.server.AddressResource
 
tryEnqueue() - Method in class com.ibm.cics.server.NameResource
Attempt to lock the named resource without suspending.

U

UNABLE_TO_DETERMINE_STATUS - Static variable in class com.ibm.cics.server.IsCICS
 
USER - Static variable in interface com.ibm.cics.server.RegionTraceBits
 
UnexpectedInformationException - exception com.ibm.cics.server.UnexpectedInformationException.
Class that represents the CICS UNEXPIN condition.

V

value - Variable in class com.ibm.cics.server.CWAHolder
The array of bytes comprising the item.
value - Variable in class com.ibm.cics.server.CommAreaHolder
The array of bytes comprising the COMMAREA.
value - Variable in class com.ibm.cics.server.DataHolder
The array of bytes comprising the item.
value - Variable in class com.ibm.cics.server.ItemHolder
The array of bytes comprising the item.
value - Variable in class com.ibm.cics.server.KeyHolder
The array of bytes comprising the item.
value - Variable in class com.ibm.cics.server.RecordHolder
The array of bytes comprising the item.
value - Variable in class com.ibm.cics.server.RetrievedDataHolder
The data retrieved for the (started) task.
value - Variable in class com.ibm.cics.server.TCTUAHolder
The array of bytes comprising the item.
value - Variable in class com.ibm.cics.server.TWAHolder
The array of bytes comprising the item.

W

WAIT - Static variable in interface com.ibm.cics.server.TerminalSendBits
 
WebService - class com.ibm.cics.server.WebService.
This class provides the Java interface to CICS WebService resources.
WebService() - Constructor for class com.ibm.cics.server.WebService
Construct a WebService bean.
WrapperHelper - class com.ibm.cics.server.WrapperHelper.
Usage:
This Class is not part of the JCICS API
WrapperHelper() - Constructor for class com.ibm.cics.server.WrapperHelper
 
WriteBreakException - exception com.ibm.cics.server.WriteBreakException.
Class that represents the CICS WRBRK condition.
WrongStatusException - exception com.ibm.cics.server.WrongStatusException.
Class that represents the CICS WRONGSTAT condition.
waitTerminal() - Method in class com.ibm.cics.server.TerminalPrincipalFacility
Deprecated. All methods operating on this class are synchronous so there is no need to wait for them to complete.
write(byte[]) - Method in class com.ibm.cics.server.ESDS
Write a new record to a file.
write(byte[], byte[]) - Method in class com.ibm.cics.server.ESDS
Write a new record to a file via an alternate key.
write(byte[], byte[]) - Method in class com.ibm.cics.server.KSDS
Write a new record to a file.
write(int, int, String, String, String, String, String) - Static method in class com.ibm.cics.server.Message
Write a message using message facilities of the underlying CICS platform.
write(long, byte[]) - Method in class com.ibm.cics.server.RRDS
Write a new record to a file.
writeData(byte[]) - Method in class com.ibm.cics.server.TDQ
Write data to a TDQ.
writeHeader(HttpSession, String, String) - Method in class com.ibm.cics.server.HttpClientRequest
Usage:
Add HTTP header information to the request This is equivalent to CICS API command WEB WRITE SESSTOKEN.
writeHeader(String, String) - Method in class com.ibm.cics.server.HttpResponse
Usage:
Add HTTP header information to the response.
writeItem(byte[]) - Method in class com.ibm.cics.server.TSQ
Simplest version of WRITEQ TS.
writeItemConditional(byte[]) - Method in class com.ibm.cics.server.TSQ
Write an item to a TSQ.

X

xctl() - Method in class com.ibm.cics.server.Program
Transfer control to the program, terminating the current program.
xctl(byte[]) - Method in class com.ibm.cics.server.Program
Transfer control to the program, terminating the current program, passing in a COMMAREA.
xctl(Channel) - Method in class com.ibm.cics.server.Program
Transfer control to the program, terminating the current program, passing a CHANNEL.

A B C D E F G H I K L M N O P Q R S T U V W X