Interface ICaptureSpecification
-
- All Superinterfaces:
ICICSObject,ICICSResource,com.ibm.cics.model.meta.ITypedObject
public interface ICaptureSpecification extends ICICSResource
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classICaptureSpecification.CaptureTypeValueEnumeration type for field CAPTURETYPEstatic classICaptureSpecification.CurrpgmopValueEnumeration type for field CURRPGMOPstatic classICaptureSpecification.CurrtranidopValueEnumeration type for field CURRTRANIDOPstatic classICaptureSpecification.CurruseridopValueEnumeration type for field CURRUSERIDOPstatic classICaptureSpecification.PrimpredopValueEnumeration type for field PRIMPREDOPstatic classICaptureSpecification.PrimpredtypeValueEnumeration type for field PRIMPREDTYPE
-
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 java.lang.StringgetCapturePoint()Getter for field CAPTUREPOINTjava.lang.StringgetCaptureSpecification()Getter for field CAPTURESPECICaptureSpecification.CaptureTypeValuegetCaptureType()Getter for field CAPTURETYPEICaptureSpecificationReferencegetCICSObjectReference()java.lang.StringgetCurrpgm()Getter for field CURRPGMICaptureSpecification.CurrpgmopValuegetCurrpgmop()Getter for field CURRPGMOPjava.lang.StringgetCurrtranid()Getter for field CURRTRANIDICaptureSpecification.CurrtranidopValuegetCurrtranidop()Getter for field CURRTRANIDOPjava.lang.StringgetCurruserid()Getter for field CURRUSERIDICaptureSpecification.CurruseridopValuegetCurruseridop()Getter for field CURRUSERIDOPjava.lang.StringgetEventBinding()Getter for field EVENTBINDINGjava.lang.StringgetEventName()Getter for field EVENTNAMEjava.lang.LonggetEventsCaptured()Getter for field EVNTCAPTUREDjava.lang.LonggetEvntcapfail()Getter for field EVNTCAPFAILjava.lang.LonggetNumdatapred()Getter for field NUMDATAPREDjava.lang.LonggetNuminfosrce()Getter for field NUMINFOSRCEjava.lang.LonggetNumoptpred()Getter for field NUMOPTPREDICICSType<ICaptureSpecification>getObjectType()java.lang.StringgetPrimpred()Getter for field PRIMPREDICaptureSpecification.PrimpredopValuegetPrimpredop()Getter for field PRIMPREDOPICaptureSpecification.PrimpredtypeValuegetPrimpredtype()Getter for field PRIMPREDTYPE-
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<ICaptureSpecification> getObjectType()
- Specified by:
getObjectTypein interfaceICICSObject- Specified by:
getObjectTypein interfacecom.ibm.cics.model.meta.ITypedObject
-
getCaptureSpecification
java.lang.String getCaptureSpecification()
Getter for field CAPTURESPECCapture specification name
The name of this capture specification in the EVENTBINDING. The name can be up to 32 characters in length.
-
getEventBinding
java.lang.String getEventBinding()
Getter for field EVENTBINDINGEvent binding name
Specifies the name (1-32 characters) of the associated event binding.
-
getCaptureType
ICaptureSpecification.CaptureTypeValue getCaptureType()
Getter for field CAPTURETYPECapture point type
Specifies a fullword binary data area to receive a CVDA value indentifying the type of capture point. The possible values are as follows:
- PRECOMMAND
- Capture point is at the start of a CICS API command.
- POSTCOMMAND
- Capture point is on completion of a CICS API command.
- PROGRAMINIT
- Capture point is at the program initiation.
- SYSTEM
- Capture point is a system event.
-
getEventName
java.lang.String getEventName()
Getter for field EVENTNAMEEvent name
Specifies a 32-character data area to receive the associated business event name.
-
getEventsCaptured
java.lang.Long getEventsCaptured()
Getter for field EVNTCAPTUREDEvents captured
The number of events captured
-
getCapturePoint
java.lang.String getCapturePoint()
Getter for field CAPTUREPOINTCapture point
Specifies a 25-character data area to receive the capture point associated with the capture specification. Its contents will match one of the capture point entries in the event binding tooling. Capture point entries consisting of two words or more are separated with an underscore - for example, LINK_PROGRAM or PROGRAM_INITIATION.
-
getEvntcapfail
java.lang.Long getEvntcapfail()
Getter for field EVNTCAPFAILCapture failures
The number of capture failures recorded by capture specification.
-
getCurrpgm
java.lang.String getCurrpgm()
Getter for field CURRPGMCurrent program filter value
Data area to receive the value specified by the application context predicate for the current program name.
-
getCurrpgmop
ICaptureSpecification.CurrpgmopValue getCurrpgmop()
Getter for field CURRPGMOPCurrent program filter operator
Operator that is used together with the value in CURRENT when evaluating the application context predicate on the current program name. The available CVDA values are as follows:
- ALLVALUES
- The predicate always evaluates true, i.e no filtering based on the name of the current program name is performed.
- DOESNOTEQUAL
- Predicate evaluates true if the name of the current program is not equal to the value of CURRPGM.
- DOESNOTSTART
- Predicate evaluates true if the name of the current program does not start with the value of CURRPGM.
- EQUALS
- Predicate evaluates true if the name of the current program is equal to the value of CURRPGM.
- GREATERTHAN
- Predicate evaluates true if the name of the current program is greater than the value of CURRPGM.
- ISNOTGREATER
- Predicate evaluates true if the name of the current program is equal to or less than the value of CURRPGM.
- ISNOTLESS
- Predicate evaluates true if the name of the current program is equal to or greater than the value of CURRPGM.
- LESSTHAN
- Predicate evaluates true if the name of the current program is less than the value of CURRPGM.
- STARTSWITH
- Predicate evaluates true if the name of the current program starts with the value of CURRPGM.
-
getCurrtranid
java.lang.String getCurrtranid()
Getter for field CURRTRANIDCurrent transaction ID filter value
Data area to receive the value specified by the application context predicate for the current transaction name.
-
getCurrtranidop
ICaptureSpecification.CurrtranidopValue getCurrtranidop()
Getter for field CURRTRANIDOPCurrent transaction ID filter operator
Operator that is used together with the value in CURRTRANID when evaluating the application context predicate on the current transaction name. The available CVDA values are as follows:
- ALLVALUES
- The predicate always evaluates true, i.e. no filtering based on the name of the current transaction is performed.
- DOESNOTEQUAL
- Predicate evaluates true if the name of the currently executing transaction is not equal to the value of CURRTRANID.
- DOESNOTSTART
- Predicate evaluates true if the name of the currently executing transaction does not start with the value of CURRTRANID.
- EQUALS
- Predicate evaluates true if the name of the currently executing transaction is equal to the value of CURRTRANID.
- GREATERTHAN
- Predicate evaluates true if the name of the currently executing transaction is greater than the value of CURRTRANID.
- ISNOTGREATER
- Predicate evaluates true if the name of the currently executing transaction is equal to or less than the value of CURRTRANID.
- ISNOTLESS
- Predicate evaluates true if the name of the currently executing transaction is equal to or greater than the value of CURRTRANID.
- LESSTHAN
- Predicate evaluates true if the name of the currently executing transaction is less than the value of CURRRTRANID.
- STARTSWITH
- Predicate evaluates true if the name of the currently executing transaction starts with the value of CURRTRANID.
-
getCurruserid
java.lang.String getCurruserid()
Getter for field CURRUSERIDCurrent user ID filter value
Data area for the user id associated with the current transaction.
-
getCurruseridop
ICaptureSpecification.CurruseridopValue getCurruseridop()
Getter for field CURRUSERIDOPCurrent user ID filter operator
Operator that is used together with the value in CURRUSERID when evaluating the application context predicate on the user id. The available CVDA values are as follows:
- ALLVALUES
- The predicate always evaluates true, i.e no filtering based on the name of the current user id is performed.
- DOESNOTEQUAL
- Predicate evaluates true if the user id of the current user is not equal to the value of CURRUSERID.
- DOESNOTSTART
- Predicate evaluates true if the user id of the current user does not start with the value of CURRUSERID.
- EQUALS
- Predicate evaluates true if the user id of the current user is equal to the value of CURRUSERID.
- GREATERTHAN
- Predicate evaluates true if the user id of the current user is greater than the value of CURRUSERID.
- ISNOTGREATER
- Predicate evaluates true if the user id of the current user is equal to or less than the value of CURRUSERID.
- ISNOTLESS
- Predicate evaluates true if the user id of the current user is equal to or greater than the value of CURRUSERID.
- LESSTHAN
- Predicate evaluates true if the user id of the current user is less than the value of CURRUSERID.
- STARTSWITH
- Predicate evaluates true if the user id of the current user starts with the value of CURRUSERID.
-
getPrimpred
java.lang.String getPrimpred()
Getter for field PRIMPREDPrimary predicate filter value
Data area for the primary predicate for the capture specification.
-
getPrimpredop
ICaptureSpecification.PrimpredopValue getPrimpredop()
Getter for field PRIMPREDOPPrimary predicate filter operator
Operator that is used together with the value in PRIMPRED when evaluating the primary predicate. The available CVDA values are as follows:
- ALLVALUES
- The predicate always evaluates true, i.e no filtering based on the name of the commands resource name is performed.
- DOESNOTEQUAL
- Predicate evaluates true if the resource specified by the EXEC CICS command is not equal to the value of PRIMPRED.
- DOESNOTSTART
- Predicate evaluates true if the resource specified by the EXEC CICS command does not start with the value of PRIMPRED.
- EQUALS
- Predicate evaluates true if the resource specified by the EXEC CICS command equals the value of PRIMPRED.
- GREATERTHAN
- Predicate evaluates true if the resource specified by the EXEC CICS command is greater than the value of PRIMPRED.
- ISNOTGREATER
- Predicate evaluates if the resource specified bythe EXEC CICS command is equal to or less than the value of PRIMPRED.
- ISNOTLESS
- Predicate evaluates true if the resource specified by the EXEC CICS command is equal to or greater than the value of PRIMPRED.
- LESSTHAN
- Predicate evaluates true if the resource specified by the EXEC CICS command is less than the value of PRIMPRED.
- STARTSWITH
- Predicate evaluates true if the resource specified by the EXEC CICS command starts with the value of PRIMPRED.
-
getPrimpredtype
ICaptureSpecification.PrimpredtypeValue getPrimpredtype()
Getter for field PRIMPREDTYPEPrimary predicate type
The type of primary predicate for this capture specification. The available CVDA values are as follows:
- CONTAINER
- The primary predicate is a CICS container.
- CURRENTPGM
- The primary predicate is the current program name.
- EVENT
- The primary predicate is a CICS event.
- FILE
- The primary predicate is a CICS FILE.
- MAP
- The primary predicate is a CICS BMS map.
- MESSAGEID
- The primary predicate is a CICS or CPSM message identifier.
- NONE
- The capture specification has no primary predicate.
- PROGRAM
- The primary predicate is a CICS program name.
- SERVICE
- The primary predicate is a CICS service or a WEBSERVICE resource.
- TDQUEUE
- The primary predicate is a CICS transient data queue.
- TRANCLASS
- The primary predicate is a CICS transaction class name.
- TRANSACTION
- The primary predicate is a CICS transaction identifier.
- TSQUEUE
- The primary predicate is a CICS temporary storage queue.
-
getNumoptpred
java.lang.Long getNumoptpred()
Getter for field NUMOPTPREDOption predicate count
The number of option predicates related to this capture specification.
-
getNumdatapred
java.lang.Long getNumdatapred()
Getter for field NUMDATAPREDData predicate count
The number of data predicates related to this capture specification.
-
getNuminfosrce
java.lang.Long getNuminfosrce()
Getter for field NUMINFOSRCEInformation source count
The number of infomation sources related to this capture specification.
-
getCICSObjectReference
ICaptureSpecificationReference getCICSObjectReference()
- Specified by:
getCICSObjectReferencein interfaceICICSObject- Specified by:
getCICSObjectReferencein interfaceICICSResource
-
-