Interface IEvent
-
- All Superinterfaces:
ICICSObject
,ICPSMManager
,com.ibm.cics.model.meta.ITypedObject
public interface IEvent extends ICPSMManager
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IEvent.EventTypeValue
Enumeration type for field EVALTYPEstatic class
IEvent.SeverityValue
Enumeration type for field SEVERITY
-
Field Summary
-
Fields inherited from interface com.ibm.cics.model.ICPSMManager
COPYRIGHT
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String
getAction()
Getter for field ACTIONIEventReference
getCICSObjectReference()
java.lang.String
getCmas()
Getter for field CMASjava.lang.String
getContext()
Getter for field CONTEXTjava.lang.Long
getCurhsentry()
Getter for field CURHSENTRYjava.lang.Long
getCurhsexit()
Getter for field CURHSEXITjava.lang.Long
getCurhwentry()
Getter for field CURHWENTRYjava.lang.Long
getCurhwexit()
Getter for field CURHWEXITjava.lang.Long
getCurlsentry()
Getter for field CURLSENTRYjava.lang.Long
getCurlsexit()
Getter for field CURLSEXITjava.lang.Long
getCurlwentry()
Getter for field CURLWENTRYjava.lang.Long
getCurlwexit()
Getter for field CURLWEXITjava.lang.Long
getCurvhsentry()
Getter for field CURVHSENTRYjava.lang.Long
getCurvhsexit()
Getter for field CURVHSEXITjava.lang.Long
getCurvlsentry()
Getter for field CURVLSENTRYjava.lang.Long
getCurvlsexit()
Getter for field CURVLSEXITjava.util.Date
getDatetime()
Getter for field DATETIMEjava.lang.String
getDescription()
Getter for field DESCICICSEnums.YesNoValue
getDetail()
Getter for field DETAILIEvent.EventTypeValue
getEventType()
Getter for field EVALTYPEICICSEnums.YesNoValue
getGenalert()
Getter for field GENALERTICICSEnums.YesNoValue
getGenextmsg()
Getter for field GENEXTMSGjava.lang.Long
getHsentry()
Getter for field HSENTRYjava.lang.Long
getHsexit()
Getter for field HSEXITjava.lang.Long
getHwentry()
Getter for field HWENTRYjava.lang.Long
getHwexit()
Getter for field HWEXITjava.lang.Long
getLsentry()
Getter for field LSENTRYjava.lang.Long
getLsexit()
Getter for field LSEXITjava.lang.Long
getLwentry()
Getter for field LWENTRYjava.lang.Long
getLwexit()
Getter for field LWEXITjava.lang.String
getName()
Getter for field NAMEjava.lang.String
getNetview()
Getter for field NETVIEWICICSType<IEvent>
getObjectType()
java.lang.Long
getPriority()
Getter for field PRIORITYjava.lang.Long
getRate()
Getter for field RATEjava.lang.String
getResourceName()
Getter for field KEYjava.lang.String
getResourceType()
Getter for field RESTYPEjava.lang.Long
getSequence()
Getter for field SEQUENCEIEvent.SeverityValue
getSeverity()
Getter for field SEVERITYjava.lang.String
getTarget()
Getter for field TARGETjava.lang.Long
getVhsentry()
Getter for field VHSENTRYjava.lang.Long
getVhsexit()
Getter for field VHSEXITjava.lang.String
getView()
Getter for field VIEWjava.lang.Long
getVlsentry()
Getter for field VLSENTRYjava.lang.Long
getVlsexit()
Getter for field VLSEXIT-
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
-
Methods inherited from interface com.ibm.cics.model.ICPSMManager
getCICSContainer
-
-
-
-
Method Detail
-
getObjectType
ICICSType<IEvent> getObjectType()
- Specified by:
getObjectType
in interfaceICICSObject
- Specified by:
getObjectType
in interfaceICPSMManager
- Specified by:
getObjectType
in interfacecom.ibm.cics.model.meta.ITypedObject
-
getName
java.lang.String getName()
Getter for field NAMEEvent name
The name of the event. For events generated as a result of evaluating an analysis or status definition, the event name is the same as the definition name. For events generated automatically by CICSPlex SM, the name is one of the following:
- !!SAMOPS - System unavailable
- !!SAMSDM - System dump
- !!SAMTDM - Transaction dump
- !!SAMSOS - Short-on-storage
- !!SAMMAX - Maximum tasks
- !!SAMNRM - Non-responsive-MAS
- !!SAMSTL - System stall
- Specified by:
getName
in interfaceICICSObject
-
getTarget
java.lang.String getTarget()
Getter for field TARGETCurrent event target
The name of the CICS system or CICS system group that is the target of the event. Note: The target will be a CICS system group only for events whose type is APM.
-
getSeverity
IEvent.SeverityValue getSeverity()
Getter for field SEVERITYEvent severity
The severity associated with the event:
- VHS - Very high severe
- HS - High severe
- HW - High warning
- LW - Low warning
- LS - Low severe
- VLS - Very low severe
For events generated as a result of evaluating an analysis definition, the severity is assigned as part of the associated evaluation definition. For events generated automatically, the severity is assigned by CICSPlex SM.
-
getEventType
IEvent.EventTypeValue getEventType()
Getter for field EVALTYPEEvent type
The type of analysis that generated the event:
- APM - Analysis point monitoring
- MRM - MAS resource monitoring
- SAM - System availability monitoring
-
getDetail
ICICSEnums.YesNoValue getDetail()
Getter for field DETAILDetailed information availability
For events generated by analysis definitions, indicates whether detailed information about the event is available. The detailed information includes information from the evaluation definition that caused the event to be raised.
A value of NO means the event was generated automatically by CICSPlex SM, rather than by an analysis definition.
-
getGenextmsg
ICICSEnums.YesNoValue getGenextmsg()
Getter for field GENEXTMSGExternal message generation
Indicates whether external messages were generated for the event.
-
getGenalert
ICICSEnums.YesNoValue getGenalert()
Getter for field GENALERTSNA generic alert generation
Indicates whether a SNA generic alert was sent to NetView for the event.
-
getRate
java.lang.Long getRate()
Getter for field RATEInterval between evaluations
The interval, in seconds, between evaluations of the the analysis or status definition that generated the event.
-
getVlsentry
java.lang.Long getVlsentry()
Getter for field VLSENTRYEvaluation count with VLS true before event
The number of consecutive evaluations during which a condition with a severity of VLS (very low severe) must be true before an event is generated. This entry value was specified in the analysis or status definition that generated the event.
-
getLsentry
java.lang.Long getLsentry()
Getter for field LSENTRYEvaluation count with LS true before event
The number of consecutive evaluations during which a condition with a severity of LS (low severe) must be true before an event is generated. This entry value was specified in the analysis or status definition that generated the event.
-
getLwentry
java.lang.Long getLwentry()
Getter for field LWENTRYEvaluation count with LW true before event
The number of consecutive evaluations during which a condition with a severity of LW (low warning) must be true before an event is generated. This entry value was specified in the analysis or status definition that generated the event.
-
getHwentry
java.lang.Long getHwentry()
Getter for field HWENTRYEvaluation count with HW true before event
The number of consecutive evaluations during which a condition with a severity of HW (high warning) must be true before an event is generated. This entry value was specified in the analysis or status definition that generated the event.
-
getHsentry
java.lang.Long getHsentry()
Getter for field HSENTRYEvaluation count with HS true before event
The number of consecutive evaluations during which a condition with a severity of HS (high severe) must be true before an event is generated. This entry value was specified in the analysis or status definition that generated the event.
-
getVhsentry
java.lang.Long getVhsentry()
Getter for field VHSENTRYEvaluation count with VHS true before event
The number of consecutive evaluations during which a condition with a severity of VHS (very high severe) must be true before an event is generated. This entry value was specified in the analysis or status definition that generated the event.
-
getVlsexit
java.lang.Long getVlsexit()
Getter for field VLSEXITEvaluation count with VLS false before resolution
The number of consecutive evaluations during which a condition with a severity of VLS (very low severe) must be false before the event is considered resolved. This exit value was specified in the analysis or status definition that generated the event.
-
getLsexit
java.lang.Long getLsexit()
Getter for field LSEXITEvaluation count with LS false before resolution
The number of consecutive evaluations during which a condition with a severity of LS (low severe) must be false before the event is considered resolved. This exit value was specified in the analysis or status definition that generated the event.
-
getLwexit
java.lang.Long getLwexit()
Getter for field LWEXITEvaluation count with LW false before resolution
The number of consecutive evaluations during which a condition with a severity of LW (low warning) must be false before the event is considered resolved. This exit value was specified in the analysis or status definition that generated the event.
-
getHwexit
java.lang.Long getHwexit()
Getter for field HWEXITEvaluation count with HW false before resolution
The number of consecutive evaluations during which a condition with a severity of HW (high warning) must be false before the event is considered resolved. This exit value was specified in the analysis or status definition that generated the event.
-
getHsexit
java.lang.Long getHsexit()
Getter for field HSEXITEvaluation count with HS false before resolution
The number of consecutive evaluations during which a condition with a severity of HS (high severe) must be false before the event is considered resolved. This exit value was specified in the analysis or status definition that generated the event.
-
getVhsexit
java.lang.Long getVhsexit()
Getter for field VHSEXITEvaluation count with VHS false before resolution
The number of consecutive evaluations during which a condition with a severity of VHS (very high severe) must be false before the event is considered resolved. This exit value was specified in the analysis or status definition that generated the event.
-
getCurvlsentry
java.lang.Long getCurvlsentry()
Getter for field CURVLSENTRYCurrent VLS true evaluation count
The current number of consecutive evaluations for which a condition with a severity of VLS (very low severe) has been true. This value is compared to the Defined VLS Entry to determine whether an event should be raised, or the severity of an existing event should be updated. If the condition is determined to be false, then the Current VLS Entry value is reset to zero. When the Current VLS Entry is equal to the Defined VLS Entry, then an event is raised or the severity of an existing event is increased to VLS, and the Current VLS Entry value is reset to zero.
-
getCurlsentry
java.lang.Long getCurlsentry()
Getter for field CURLSENTRYCurrent LS true evaluation count
The current number of consecutive evaluations for which a condition with a severity of LS (low severe) has been true. This value is compared to the Defined LS Entry to determine whether an event should be raised, or the severity of an existing event should be updated. If the condition is determined to be false, then the Current LS Entry value is reset to zero. When the Current LS Entry is equal to the Defined LS Entry, then an event is raised or the severity of an existing event is increased to LS, and the Current LS Entry value is reset to zero.
-
getCurlwentry
java.lang.Long getCurlwentry()
Getter for field CURLWENTRYCurrent LW true evaluation count
The current number of consecutive evaluations for which a condition with a severity of LW (low warning) has been true. This value is compared to the Defined LW Entry to determine whether an event should be raised, or the severity of an existing event should be updated. If the condition is determined to be false, then the Current LW Entry value is reset to zero. When the Current LW Entry is equal to the Defined LW Entry, then an event is raised and the Current LW Entry value is reset to zero.
-
getCurhwentry
java.lang.Long getCurhwentry()
Getter for field CURHWENTRYCurrent HW true evaluation count
The current number of consecutive evaluations for which a condition with a severity of HW (high warning) has been true. This value is compared to the Defined HW Entry to determine whether an event should be raised, or the severity of an existing event should be updated. If the condition is determined to be false, then the Current HW Entry value is reset to zero. When the Current HW Entry is equal to the Defined HW Entry, then an event is raised and the Current HW Entry value is reset to zero.
-
getCurhsentry
java.lang.Long getCurhsentry()
Getter for field CURHSENTRYCurrent HS true evaluation count
The current number of consecutive evaluations for which a condition with a severity of HS (high severe) has been true. This value is compared to the Defined HS Entry to determine whether an event should be raised, or the severity of an existing event should be updated. If the condition is determined to be false, then the Current HS Entry value is reset to zero. When the Current HS Entry is equal to the Defined HS Entry, then an event is raised or the severity of an existing event is increased to HS, and the Current HS Entry value is reset to zero.
-
getCurvhsentry
java.lang.Long getCurvhsentry()
Getter for field CURVHSENTRYCurrent VHS true evaluation count
The current number of consecutive evaluations for which a condition with a severity of VHS (very high severe) has been true. This value is compared to the Defined VHS Entry to determine whether an event should be raised, or the severity of an existing event should be updated. If the condition is determined to be false,the Current VHS Entry value is reset to zero. When the Current VHS Entry is equal to the Defined VHS Entry, then an event is raised or the severity of an existing event is increased to VHS, and the Current VHS Entry value is reset to zero.
-
getCurvlsexit
java.lang.Long getCurvlsexit()
Getter for field CURVLSEXITCurrent VLS false evaluation count
The current number of consecutive evaluations for which a condition with a severity of VLS (very low severe) has been false. This value is compared to the Defined VLS Exit to determine whether an event should be cancelled, or the severity of an existing event should be updated. If the condition is determined to be true, then the Current VLS Exit value is reset to zero. When the Current VLS Exit is equal to the Defined VLS Exit, then the event is cancelled or (for a Threshold Event) the severity is decreased to LS, and the Current VLS Exit value is reset to zero.
-
getCurlsexit
java.lang.Long getCurlsexit()
Getter for field CURLSEXITCurrent LS false evaluation count
The current number of consecutive evaluations for which a condition with a severity of LS (low severe) has been false. This value is compared to the Defined LS Exit to determine whether an event should be cancelled, or the severity of an existing event should be updated. If the condition is determined to be true, then the Current LS Exit value is reset to zero. When the Current LS Exit is equal to the Defined LS Exit, the event is canceled or (for a Threshold Event) the severity is decreased to VLS, and the Current LS Exit value is reset to zero.
-
getCurlwexit
java.lang.Long getCurlwexit()
Getter for field CURLWEXITCurrent LW false evaluation count
The current number of consecutive evaluations for which a condition with a severity of LW (low warning) has been false. This value is compared to the Defined LW Exit to determine whether an event should be cancelled, or the severity of an existing event should be updated. If the condition is determined to be true, then the Current LW Exit value is reset to zero. When the Current LW Exit is equal to the Defined LW Exit, then the event is cancelled or (for a threshold event) the severity is decreased to LS and the current LW Exit value is reset to zero.
-
getCurhwexit
java.lang.Long getCurhwexit()
Getter for field CURHWEXITCurrent HW false evaluation count
The current number of consecutive evaluations for which a condition with a severity of HW (high warning) has been false. This value is compared to the Defined HW Exit to determine whether an event should be cancelled, or the severity of an existing event should be updated. If the condition is determined to be true, then the Current HW Exit value is reset to zero. When the Current HW Exit is equal to the Defined HW Exit, then the event is cancelled, or (for a Threshold Event) the severity is decreased to LW, and the current HW Exit value is reset to zero.
-
getCurhsexit
java.lang.Long getCurhsexit()
Getter for field CURHSEXITCurrent HS false evaluation count
The current number of consecutive evaluations for which a condition with a severity of HS (high severe) has been false. This value is compared to the Defined HS Exit to determine whether an event should be cancelled, or the severity of an existing event should be updated. If the condition is determined to be true, then the Current HS Exit value is reset to zero. When the Current HS Exit is equal to the Defined HS Exit, then the event is cancelled or (for a Threshold Event) the severity is decreased to HW, and the Current HS Exit value is reset to zero.
-
getCurvhsexit
java.lang.Long getCurvhsexit()
Getter for field CURVHSEXITCurrent VHS false evaluation count
The current number of consecutive evaluations for which a condition with a severity of VHS (very high severe) has been false. This value is compared to the Defined VHS Exit to determine whether an event should be cancelled, or the severity of an existing event should be updated. If the condition is determined to be true, then the Current VHS Exit value is reset to zero. When the Current VHS Exit is equal to the Defined VHS Exit, then the event is cancelled or (for a Threshold Event) the severity is decreased to HS, and the Current VHS Exit value is reset to zero.
-
getNetview
java.lang.String getNetview()
Getter for field NETVIEWCMAS to which Netview attached
Indicates whether an interface to NetView is available from the CMAS in which the event was generated.
-
getDatetime
java.util.Date getDatetime()
Getter for field DATETIMEDate and time when event was created
The local date and time when the event was created.
-
getCmas
java.lang.String getCmas()
Getter for field CMASCMAS in which event was raised
The name of the CMAS in which the event was generated. Depending on what type of event it is, the named CMAS is one of the following:
- APM - The CMAS associated with the analysis point specification.
- MRM - The CMAS to which the target CICS system is connected.
- SAM - The primary CMAS for the target CICS system.
-
getAction
java.lang.String getAction()
Getter for field ACTIONAction name
The name of the action definition associated with the analysis or status definition that generated the event.
-
getView
java.lang.String getView()
Getter for field VIEWAssociated user data
A string of up to 8 characters that allows you to provide additional site-specific data about the event.
-
getPriority
java.lang.Long getPriority()
Getter for field PRIORITYEvent priority
The priority of the event, as specified in the action definition associated with the analysis or status definition that generated the event. The priority of an event can range from 1 to 255, with 255 being the highest priority.
-
getDescription
java.lang.String getDescription()
Getter for field DESCEvent description
A description of the event, as specified in the action definition associated with the analysis or status definition that generated the event.
-
getSequence
java.lang.Long getSequence()
Getter for field SEQUENCEEvent sequence number
The event sequence number.
-
getResourceType
java.lang.String getResourceType()
Getter for field RESTYPEResource type
The type of resource for which the event was generated.
-
getResourceName
java.lang.String getResourceName()
Getter for field KEYName of specific resource that caused event
The specific resource (such as a program or file) that caused the event to be generated.
-
getContext
java.lang.String getContext()
Getter for field CONTEXTName of context to which event applies
The CICSplex identified as the context to which the event applies.
-
getCICSObjectReference
IEventReference getCICSObjectReference()
- Specified by:
getCICSObjectReference
in interfaceICICSObject
- Specified by:
getCICSObjectReference
in interfaceICPSMManager
-
-