Interface ITransactionDump
-
- All Superinterfaces:
ICICSObject
,ICICSResource
,com.ibm.cics.model.meta.ITypedObject
public interface ITransactionDump extends ICICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
ITransactionDump.ChangeAgentValue
Enumeration type for field CHANGEAGENTstatic class
ITransactionDump.InstallAgentValue
Enumeration type for field INSTALLAGENTstatic class
ITransactionDump.ShutdownOptionValue
Enumeration type for field SHUTOPTIONstatic class
ITransactionDump.SystemDumpOptionValue
Enumeration type for field SYSDUMPINGstatic class
ITransactionDump.TransactionDumpOptionValue
Enumeration type for field TRANDUMPINGstatic class
ITransactionDump.TransactionDumpScopeValue
Enumeration type for field TDUMPSCOPE
-
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 ITransactionDump.ChangeAgentValue
getChangeAgent()
Getter for field CHANGEAGENTjava.lang.String
getChangeAgentRelease()
Getter for field CHANGEAGRELjava.util.Date
getChangeTime()
Getter for field CHANGETIMEjava.lang.String
getChangeUserID()
Getter for field CHANGEUSRIDITransactionDumpReference
getCICSObjectReference()
java.lang.String
getDefineSource()
Getter for field DEFINESOURCEjava.util.Date
getDefineTime()
Getter for field DEFINETIMEITransactionDump.InstallAgentValue
getInstallAgent()
Getter for field INSTALLAGENTjava.util.Date
getInstallTime()
Getter for field INSTALLTIMEjava.lang.String
getInstallUserID()
Getter for field INSTALLUSRIDjava.lang.Long
getMaximumTransactionDumps()
Getter for field MAXIMUMICICSType<ITransactionDump>
getObjectType()
ITransactionDump.ShutdownOptionValue
getShutdownOption()
Getter for field SHUTOPTIONITransactionDump.SystemDumpOptionValue
getSystemDumpOption()
Getter for field SYSDUMPINGjava.lang.Long
getSystemDumpsSuppressed()
Getter for field SDMPSUPPjava.lang.Long
getSystemDumpsTaken()
Getter for field SDMPTOTLjava.lang.String
getTransactionDumpCode()
Getter for field TRANDUMPCODEITransactionDump.TransactionDumpOptionValue
getTransactionDumpOption()
Getter for field TRANDUMPINGITransactionDump.TransactionDumpScopeValue
getTransactionDumpScope()
Getter for field TDUMPSCOPEjava.lang.Long
getTransactionDumpsSinceReset()
Getter for field CURRENTjava.lang.Long
getTransactionDumpsSuppressed()
Getter for field TDMPSUPPjava.lang.Long
getTransactionDumpsTaken()
Getter for field TDMPTOTL-
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<ITransactionDump> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getTransactionDumpCode
java.lang.String getTransactionDumpCode()
Getter for field TRANDUMPCODETransaction dump code
The 4-character transaction dump code for which the transaction dump table entry is to be changed. A valid transaction dump code has no leading or imbedded blanks.
-
getTransactionDumpsSinceReset
java.lang.Long getTransactionDumpsSinceReset()
Getter for field CURRENTNumber of dump calls since last reset
The number of dump calls that have been made for this transaction dump code since the value was last reset to 0. This value can be reset using the INITIALIZE action command.
This also includes requests that do not result in dumps, either because they are suppressed for this code or because the number for this code has reached its maximum.
Note that it is possible for this value to be higher than the value in the Transaction Dumps Taken field, which is reset by CICS end-of-day. If this value was initialized shortly before the end-of-day statistics reset, the number of current dumps could exceed the total number of dumps taken.
-
getMaximumTransactionDumps
java.lang.Long getMaximumTransactionDumps()
Getter for field MAXIMUMMaximum number of dump calls
The maximum number of dump calls for this transaction dump code that result in a dump being taken.
Input Values: 0 - 999 (TRANDUMP only)
-
getShutdownOption
ITransactionDump.ShutdownOptionValue getShutdownOption()
Getter for field SHUTOPTIONShutdown option
Indicates whether the CICS system is to be shut down after a call to this transaction dump code.
Input Values: SHUTDOWN, NOSHUTDOWN
-
getSystemDumpOption
ITransactionDump.SystemDumpOptionValue getSystemDumpOption()
Getter for field SYSDUMPINGSystem dump option
Indicates whether a system dump is to be taken for this transaction dump code.
Input Values: SYSDUMP, NOSYSDUMP
-
getTransactionDumpOption
ITransactionDump.TransactionDumpOptionValue getTransactionDumpOption()
Getter for field TRANDUMPINGTransaction dump option
Specifies whether a transaction dump should be taken when a transaction dump request with this code is received. CVDA values are:
- NOTRANDUMP - A transaction dump is not to be taken.
- TRANDUMP - A transaction dump is to be taken.
-
getTransactionDumpsTaken
java.lang.Long getTransactionDumpsTaken()
Getter for field TDMPTOTLNumber of transaction dumps taken
The number of transaction dumps taken for this transaction dump code since the last CICS end-of-day statistics reset. This number does not include suppressed dumps.
-
getTransactionDumpsSuppressed
java.lang.Long getTransactionDumpsSuppressed()
Getter for field TDMPSUPPNumber of transaction dumps suppressed
The number of transaction dumps requested for this transaction dump code (by CICS or a user) that were suppressed by one of the following:
- a user exit
- the dump table
-
getSystemDumpsTaken
java.lang.Long getSystemDumpsTaken()
Getter for field SDMPTOTLNumber of system dumps taken
The number of system dumps taken for this transaction dump code since the last CICS end-of-day statistics reset. This number does not include suppressed dumps.
-
getSystemDumpsSuppressed
java.lang.Long getSystemDumpsSuppressed()
Getter for field SDMPSUPPNumber of system dumps suppressed
The number of system dumps requested for this transaction dump code (by CICS or a user) that were suppressed by one of the following:
- a user exit
- the dump table
- a global system dump suppression
-
getTransactionDumpScope
ITransactionDump.TransactionDumpScopeValue getTransactionDumpScope()
Getter for field TDUMPSCOPETransaction dump scope type
Indicates whether SDUMP requests with this transaction dump code are sent to other MVS images in the sysplex. The MVS images would be those that are running XCF/MRO connected CICS systems related to the CICS system that initiated the dump request.
- LOCAL - SDUMP requests are not sent to related CICS systems.
- RELATED - SDUMP requests are sent to related CICS systems. The CICS systems must be running under MVS/ESA 5.1 or later with the MVS workload manager.
Input Values: LOCAL, RELATED
-
getChangeTime
java.util.Date getChangeTime()
Getter for field CHANGETIMELast modification time
The local date and time when the definition was last changed.
-
getChangeAgent
ITransactionDump.ChangeAgentValue getChangeAgent()
Getter for field CHANGEAGENTLast modification agent
The change agent identifier that made the last modification.
- CSDAPI - The resource was last changed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CSDBATCH - The resource was last changed by a DFHCSDUP job.
- DREPAPI - The resource was last changed by a CICSPlex SM BAS API command.
- DREPBATCH - The resource was last changed by a CICSPlex SM utility.
- DYNAMIC - The resource was last changed dynamically.
- SYSTEM - The resource was last changed by CICS.
- CREATESPI - The resource was last changed by an EXEC CICS CREATE command.
- NOTAPPLIC - This is not applicable for this resource.
- OVERRIDE - Resource was last changed by resource overrides.
- N_A - Resource was created or last updated prior to CICS TS Version 4 Release 1 and support for resource signatures.
-
getChangeAgentRelease
java.lang.String getChangeAgentRelease()
Getter for field CHANGEAGRELLast modification agent release
The CICS release level of the agent that made the last modification to the resource definition.
-
getChangeUserID
java.lang.String getChangeUserID()
Getter for field CHANGEUSRIDLast modification user ID
The user ID that made the last modification to the resource definition.
-
getDefineSource
java.lang.String getDefineSource()
Getter for field DEFINESOURCESource of the resource definition
The source of the definition, depending on which agent made the last change.
-
getDefineTime
java.util.Date getDefineTime()
Getter for field DEFINETIMECreation time
The local date and time when the resource definition record was created on DFHCSD or EYUDREP.
-
getInstallUserID
java.lang.String getInstallUserID()
Getter for field INSTALLUSRIDInstallation user ID
The user ID that installed the resource definition.
-
getInstallTime
java.util.Date getInstallTime()
Getter for field INSTALLTIMEInstallation time
The local date and time when the definition was installed.
-
getInstallAgent
ITransactionDump.InstallAgentValue getInstallAgent()
Getter for field INSTALLAGENTInstallation agent
The install agent identifier that made the installation.
- CSDAPI - The resource was installed by a CEDA transaction, by the programmable interface to DFHEDAP or by an EXEC CICS CSD command.
- CREATESPI - The resource was installed by an EXEC CICS CREATE command.
- DYNAMIC - The resource was installed dynamically.
- SYSTEM - The resource was installed by CICS.
- GRPLIST - The resource was installed by GRPLIST INSTALL.
-
getCICSObjectReference
ITransactionDumpReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICICSResource
-
-