com.ibm.cics.model
Interface IMonitorSpecification

All Superinterfaces:
ICICSObject, ICPSMDefinition, IDefinition, com.ibm.cics.model.meta.ITypedObject

public interface IMonitorSpecification
extends ICPSMDefinition

generated from CICS resourcetable MONSPEC


Nested Class Summary
static class IMonitorSpecification.ActstatusValue
          Enumeration type for field ACTSTATUS
 
Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICPSMDefinition
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,IMonitorSpecification> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 IMonitorSpecification.ActstatusValue getActstatus()
          Getter for field ACTSTATUS
 IMonitorSpecificationReference getCICSObjectReference()
           
 java.lang.Long getCicssamp()
          Getter for field CICSSAMP
 java.lang.Long getConnsamp()
          Getter for field CONNSAMP
 java.lang.Long getDbxsamp()
          Getter for field DBXSAMP
 java.lang.String getDesc()
          Getter for field DESC
 java.lang.Long getFilesamp()
          Getter for field FILESAMP
 java.lang.Long getGlblsamp()
          Getter for field GLBLSAMP
 java.lang.Long getJrnlsamp()
          Getter for field JRNLSAMP
 java.lang.String getName()
          Getter for field NAME
 ICICSType<IMonitorSpecification> getObjectType()
           
 java.lang.Long getProgsamp()
          Getter for field PROGSAMP
 java.lang.Long getRetention()
          Getter for field RETENTION
 java.lang.String getRodmcmas()
          Getter for field RODMCMAS
 java.lang.Long getTdqsamp()
          Getter for field TDQSAMP
 java.lang.Long getTermsamp()
          Getter for field TERMSAMP
 java.lang.Long getTransamp()
          Getter for field TRANSAMP
 
Methods inherited from interface com.ibm.cics.model.ICPSMDefinition
getChangeAgent, getChangeAgentRelease, getChangeTime, getChangeUserID, getCreateTime
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType
 
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject
getAttributeValue
 

Method Detail

getObjectType

ICICSType<IMonitorSpecification> getObjectType()
Specified by:
getObjectType in interface ICICSObject
Specified by:
getObjectType in interface ICPSMDefinition
Specified by:
getObjectType in interface IDefinition
Specified by:
getObjectType in interface com.ibm.cics.model.meta.ITypedObject

getName

java.lang.String getName()
Getter for field NAME

Specification

The name of the monitoring specification.

Specified by:
getName in interface ICICSObject

getRetention

java.lang.Long getRetention()
Getter for field RETENTION

Data retention period

The number of minutes collected data is to be kept after resource monitoring stops. (Resource monitoring stops when the CICS system stops or when the MAS view command is used to stop resource monitoring for the CICS system.) The retention period can be:

1 - 1440
Collected data is to be kept the specified number of minutes.
0
Collected data is not to be kept.
INHERIT
The CICS system is to use the value specified with its associated monitor specification.
Note: This value can be overridden by the RETENTION value set in CSYSDEF and MAS views.


getCicssamp

java.lang.Long getCicssamp()
Getter for field CICSSAMP

Sample interval for CICS region monitoring

The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of 0 means that no resource monitoring is to occur.

Note: The field comes into effect only when the CICSSAMP is set to INHERIT in the associated definition for the CICS system (CSYSDEF).


getGlblsamp

java.lang.Long getGlblsamp()
Getter for field GLBLSAMP

Sample interval for global region monitoring

The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of 0 means that no resource monitoring is to occur.

Note: The field comes into effect only when the GLBLSAMP is set to INHERIT in the associated definition for the CICS system (CSYSDEF).


getDbxsamp

java.lang.Long getDbxsamp()
Getter for field DBXSAMP

Sample interval for DB2 and DBCTRL monitoring

The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of 0 means that no resource monitoring is to occur.

Note: The field comes into effect only when the DBXSAMP is set to INHERIT in the associated definition for the CICS system (CSYSDEF).


getConnsamp

java.lang.Long getConnsamp()
Getter for field CONNSAMP

Sample interval for connection monitoring

The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of 0 means that no resource monitoring is to occur.

Note: The field comes into effect only when the CONNSAMP is set to INHERIT in the associated definition for the CICS system (CSYSDEF).


getFilesamp

java.lang.Long getFilesamp()
Getter for field FILESAMP

Sample interval for file monitoring

The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of 0 means that no resource monitoring is to occur.

Note: The field comes into effect only when the FILESAMP is set to INHERIT in the associated definition for the CICS system (CSYSDEF).


getJrnlsamp

java.lang.Long getJrnlsamp()
Getter for field JRNLSAMP

Sample interval for journal monitoring

The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of 0 means that no resource monitoring is to occur.

Note: The field comes into effect only when the JRNLSAMP is set to INHERIT in the associated definition for the CICS system (CSYSDEF).


getProgsamp

java.lang.Long getProgsamp()
Getter for field PROGSAMP

Sample interval for program monitoring

The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of 0 means that no resource monitoring is to occur.

Note: The field comes into effect only when the PROGSAMP is set to INHERIT in the associated definition for the CICS system (CSYSDEF).


getTermsamp

java.lang.Long getTermsamp()
Getter for field TERMSAMP

Sample interval for terminal monitoring

The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of 0 means that no resource monitoring is to occur.

Note: The field comes into effect only when the TERMSAMP is set to INHERIT in the associated definition for the CICS system (CSYSDEF).


getTdqsamp

java.lang.Long getTdqsamp()
Getter for field TDQSAMP

Sample interval for TDQ monitoring

The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of 0 means that no resource monitoring is to occur.

Note: The field comes into effect only when the TDQSAMP is set to INHERIT in the associated definition for the CICS system (CSYSDEF).


getTransamp

java.lang.Long getTransamp()
Getter for field TRANSAMP

Sample interval for transaction monitoring

The number of seconds in the range 1 - 86400 that CICSPlex SM is to wait between requests to collect sample data for the named type of monitoring. A value of 0 means that no resource monitoring is to occur.

Note: The field comes into effect only when the TRANSAMP is set to INHERIT in the associated definition for the CICS system (CSYSDEF).


getActstatus

IMonitorSpecification.ActstatusValue getActstatus()
Getter for field ACTSTATUS

Monitor activation status

Indicates whether monitoring is to be activated or not during the initialization of an associated CICS system.

The field comes into effect only when 'Monitoring status' is set to 'INHERIT' in the associated definition for the CICS system (CSYSDEF). This field does not apply to monitoring definitions installed dynamically, or dynamic changes made to active monitoring.


getDesc

java.lang.String getDesc()
Getter for field DESC

Description

A description of the monitor specification.


getRodmcmas

java.lang.String getRodmcmas()
Getter for field RODMCMAS

Resource status facility CMAS name

Identifies the CMAS that is to handle all the resource status facility requests associated with this monitor specification.


getCICSObjectReference

IMonitorSpecificationReference getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSObject
Specified by:
getCICSObjectReference in interface ICPSMDefinition
Specified by:
getCICSObjectReference in interface IDefinition

findReferences

<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,IMonitorSpecification> referenceAttribute)
Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute. The list factory can be activated by the caller when necessary. This method does not perform any I/O.



Copyright © 2008-2013 IBM Corp. All Rights Reserved.