Interface IGlobalUserExit
-
- All Superinterfaces:
ICICSObject
,ICICSResource
,com.ibm.cics.model.meta.ITypedObject
public interface IGlobalUserExit extends ICICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IGlobalUserExit.StartStatusValue
Enumeration type for field STARTSTATUS
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description IGlobalUserExitReference
getCICSObjectReference()
java.lang.String
getEntryAddress()
Getter for field ENTRYjava.lang.String
getEntryName()
Getter for field ENTRYNAMEjava.lang.String
getExitPoint()
Getter for field EXITPOINTjava.lang.String
getGAEntryName()
Getter for field GAENTRYNAMEjava.lang.Long
getGALength()
Getter for field GALENGTHjava.lang.Long
getGAUserCount()
Getter for field GAUSECOUNTjava.lang.Long
getNumberOfEnabledExits()
Getter for field NUMEXITSICICSType<IGlobalUserExit>
getObjectType()
java.lang.String
getProgramName()
Getter for field PROGRAMIGlobalUserExit.StartStatusValue
getStartStatus()
Getter for field STARTSTATUS-
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<IGlobalUserExit> 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.
-
getExitPoint
java.lang.String getExitPoint()
Getter for field EXITPOINTExit name
Specifies the name of the CICS exit.
-
getEntryName
java.lang.String getEntryName()
Getter for field ENTRYNAMEEntry name
Specifies the name of the global 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 which owns 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.
-
getStartStatus
IGlobalUserExit.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.
-
getGAUserCount
java.lang.Long getGAUserCount()
Getter for field GAUSECOUNTNumber of global work area users
The number of exit programs that are using the global work area owned by this exit program.
-
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.
-
getNumberOfEnabledExits
java.lang.Long getNumberOfEnabledExits()
Getter for field NUMEXITSNumber of global exit points where exit is enabled
Specifies the number of global exit points where exit is enabled
-
getEntryAddress
java.lang.String getEntryAddress()
Getter for field ENTRYEntry address of global user exit
Specifies the entry address of the global user exit program.
-
getCICSObjectReference
IGlobalUserExitReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICICSResource
-
-