Interface ITaskRelatedUserExit
-
- All Superinterfaces:
ICICSObject
,ICICSResource
,com.ibm.cics.model.meta.ITypedObject
public interface ITaskRelatedUserExit extends ICICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ITaskRelatedUserExit.ConcurrencyTypeValue
Enumeration type for field CONCURRENTSTstatic class
ITaskRelatedUserExit.ConnectStatusValue
Enumeration type for field CONNECTSTstatic class
ITaskRelatedUserExit.FormatEDFStatusValue
Enumeration type for field FORMATEDFSTstatic class
ITaskRelatedUserExit.INDOUBTWAITStatusValue
Enumeration type for field INDOUBTSTstatic class
ITaskRelatedUserExit.OpenAPIStatusValue
Enumeration type for field APISTstatic class
ITaskRelatedUserExit.PurgeableStatusValue
Enumeration type for field PURGEABLESTstatic class
ITaskRelatedUserExit.ShutdownStatusValue
Enumeration type for field SHUTDOWNSTstatic class
ITaskRelatedUserExit.SPICallEnablementValue
Enumeration type for field SPISTstatic class
ITaskRelatedUserExit.StartStatusValue
Enumeration type for field STARTSTATUSstatic class
ITaskRelatedUserExit.TaskStartStatusValue
Enumeration type for field TASKSTART
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
-
Method Summary
-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
-
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSContainer, getCICSRelease, getRegionName
-
-
-
-
Method Detail
-
getObjectType
ICICSType<ITaskRelatedUserExit> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getProgramName
java.lang.String getProgramName()
Getter for field PROGRAMProgram name
Specifies the name of the load module of the exit program.
-
getEntryName
java.lang.String getEntryName()
Getter for field ENTRYNAMEEntry name
Specifies the name of the global or task-related user exit program. The value can be the same as the name of the load module, however a different value is returned when the load module contains more than one exit program.
-
getGAEntryName
java.lang.String getGAEntryName()
Getter for field GAENTRYNAMEName of exit owning global work area
Specifies the name of the currently enabled global, or task-related, user exit program that owns the global work area being used by the exit specified in the entry name field. This field will not contain a value unless a global work area is being used and is owned by another exit program.
-
getFormatEDFStatus
ITaskRelatedUserExit.FormatEDFStatusValue getFormatEDFStatus()
Getter for field FORMATEDFSTFormat execution diagnostic facility (EDF) status
Indicates whether FORMATEDF was specified on the ENABLE command.
- FORMATEDF - On
- NOFORMATEDF - Off
- NOTAPPLIC - This is a global user exit
-
getShutdownStatus
ITaskRelatedUserExit.ShutdownStatusValue getShutdownStatus()
Getter for field SHUTDOWNSTExit CICS shutdown status
Specifies whether the task-related user exit is invoked when CICS shutdown occurs.
- NOSHUTDOWN - The task-related user exit is not invoked.
- NOTAPPLIC - Not applicable.
- SHUTDOWN - The task-related user exit is invoked when CICS shutdown occurs.
-
getStartStatus
ITaskRelatedUserExit.StartStatusValue getStartStatus()
Getter for field STARTSTATUSExit program availability status
Identifies whether the exit program is available for execution.
- STARTED - The exit program is available for execution.
- STOPPED - The exit program is not available for execution.
-
getTaskStartStatus
ITaskRelatedUserExit.TaskStartStatusValue getTaskStartStatus()
Getter for field TASKSTARTStart and end of task invocation status
Indicates whether the exit program is set to be invoked automatically at the start and end of every task.
- NOTASKSTART - The exit program is not set to invocation at the start and end of every task.
- NOTAPPLIC - Not applicable.
- TASKSTART - The exit program is set for invocation at the start and end of every task.
-
getGAUserCount
java.lang.Long getGAUserCount()
Getter for field GAUSECOUNTNumber of work area users
Specifies the number of users of the work area
-
getGALength
java.lang.Long getGALength()
Getter for field GALENGTHLength of global work area
Specifies the length of the global work area for this exit program.
-
getLocalWorkAreaLength
java.lang.Long getLocalWorkAreaLength()
Getter for field TALENGTHLength of local work area
Indicates the length of a local (task-related) work area.
-
getEntry
java.lang.String getEntry()
Getter for field ENTRYEntry-point address of task related user exit
Specifies the entry-point address of the task-related user exit program
-
getConnectStatus
ITaskRelatedUserExit.ConnectStatusValue getConnectStatus()
Getter for field CONNECTSTConnect status
This is valid for task-related user exits only and indicates the state of the connection between the exit and the external resource manager that it support
- CONNECTED - The task-related user exit is connected to its external resource manager subsystem, and API requests can be issued.
- NOTAPPLIC - The exit is not a task-related user exit.
- NOTCONNECTED - The task-related user exit is not connected to its external resource manager subsystem, and therefore API requests cannot be issued.
- UNKNOWN - The task-related user exit has been enabled and started, but not enabled for SPI requests. UNKNOWN can also be returned if CICS is unable to call the task related user exit. In both of these cases, CICS cannot tell whether it is connected to its external resource manager.
-
getINDOUBTWAITStatus
ITaskRelatedUserExit.INDOUBTWAITStatusValue getINDOUBTWAITStatus()
Getter for field INDOUBTSTINDOUBTWAIT enabled status
Indicates whether the task-related user exit is enabled with the INDOUBTWAIT keyword.
- NOTAPPLIC - The exit being inquired upon is a global user exit.
- NOWAIT - The exit is not enabled with the INDOUBTWAIT keyword.
- WAIT - The exit is enabled with the INDOUBTWAIT keyword.
-
getSPIQualifier
java.lang.String getSPIQualifier()
Getter for field QUALIFIERSPI qualifier
This returns, for a task-related user exit that is enabled for SPI calls, the 8-character qualifier returned by the exit.
For global user exits and task-related user exits that are not enabled for SPI calls, returns blanks.
-
getSPICallEnablement
ITaskRelatedUserExit.SPICallEnablementValue getSPICallEnablement()
Getter for field SPISTExit-enabled-for-(SPI) calls option
Indicates whether the task-related user exit is enabled for SPI calls.
- NOSPI - The exit is not enabled for SPI.
- NOTAPPLIC - The exit being inquired upon is a global user exit. This occurs only when the INQUIRE command is explicitly for a global user exit
- SPI - The exit is enabled for SPI.
-
getConcurrencyType
ITaskRelatedUserExit.ConcurrencyTypeValue getConcurrencyType()
Getter for field CONCURRENTSTConcurrency type
Indicates the concurrency status of the task-related user exit program specified by the latest Enable command for this program.
- QUASIRENT - The task-related user exit program is quasi-reentrant and is only able to run under the CICS QR TCB when invoking CICS services through the CICS API. To use any MVS services, this task-related user exit program must switch to a privately-managed TCB.
- THREADSAFE - The task-related user exit program is threadsafe. If APIST is BASEAPI then the task-related user exit program is able to run under whichever TCB is in use by its user task when the program is given control. If APIST is OPENAPI then the TCB used is always an L8 TCB.
- REQUIRED - The task-related user exit program requires an open TCB. This value is returned only if APIST is BASEAPI and means the type of open TCB used is any eligible key 8 open tcb. A concurrency and apist combination of REQUIRED and OPENAPI has the same meaning as THREADSAFE and OPENAPI, therefore for reasons of compatibility with previous releases CICS will always return a value of THREADSAFE in this case.
- NOTAPPLIC - The exit is not a task-related user exit.
-
getOpenAPIStatus
ITaskRelatedUserExit.OpenAPIStatusValue getOpenAPIStatus()
Getter for field APISTOpen API status
Indicates which APIs the task-related user exit uses.
- BASEAPI - The task-related user exit program is enabled as either QUASIRENT or THREADSAFE, but without the OPENAPI option. This means it is restricted to the CICS permitted programming interfaces. BASEAPI is a synonym of CICSAPI.
- OPENAPI - The task-related user exit program is enabled with the THREADSAFE and OPENAPI options. This means that it is permitted to use non-CICS API in a threadsafe manner, for which purpose CICS gives control to the task-related user exit under an open TCB
- NOTAPPLIC - Not applicable.
-
getPurgeableStatus
ITaskRelatedUserExit.PurgeableStatusValue getPurgeableStatus()
Getter for field PURGEABLESTPurgeable status
Indicates whether or not the task-related user exit can be purged.
- PURGEABLE - The task-related user exit program can be purged.
- NOTPURGEABLE - The task-related user exit program cannot be purged and must be force purged.
- NOTAPPLIC - The information is not applicable to this release of CICS.
-
getCICSObjectReference
ITaskRelatedUserExitReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICICSResource
-
-