com.ibm.cics.model
Interface IPolicyRule

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

public interface IPolicyRule
extends ICICSResource

generated from CICS resourcetable RULE


Field Summary
 
Fields inherited from interface com.ibm.cics.model.ICICSResource
COPYRIGHT
 
Method Summary
<From extends ICICSObject>
ICICSObjectListFactory<From>
findReferences(IReferenceAttribute<From,IPolicyRule> referenceAttribute)
          Returns an ICICSObjectListFactory that can be used to retrieve all objects that reference this ICICSObject by the supplied IReferenceAttribute.
 java.lang.String getAbendCode()
          Getter for field ABCODE
 java.lang.Long getActualThresholdValue()
          Getter for field THRESHOLD
 java.lang.Long getBaseApplicationMajorVersion()
          Getter for field BASEAPMAJVER
 java.lang.Long getBaseApplicationMicroVersion()
          Getter for field BASEAPMICVER
 java.lang.Long getBaseApplicationMinorVersion()
          Getter for field BASEAPMINVER
 java.lang.String getBaseApplicationName()
          Getter for field BASEAPPLICTN
 java.lang.String getBaseLevel()
          Getter for field BASELEVEL
 java.lang.String getBasePlatformName()
          Getter for field BASEPLATFORM
 java.lang.String getBundleDirectoryName()
          Getter for field BUNDLEDIR
 java.lang.String getBundleID()
          Getter for field BUNDLEID
 java.lang.Long getBundleMajorVersion()
          Getter for field BUNDLEMAJVER
 java.lang.Long getBundleMicroVersion()
          Getter for field BUNDLEMICVER
 java.lang.Long getBundleMinorVersion()
          Getter for field BUNDLEMINVER
 java.lang.String getBundleName()
          Getter for field BUNDLE
 IPolicyRuleReference getCICSObjectReference()
           
 java.util.Date getCreationTime()
          Getter for field DEFINETIME
 java.lang.String getEpAdapter()
          Getter for field EPADAPTER
 java.lang.String getEpAdapterSet()
          Getter for field EPADAPTERSET
 java.lang.String getInstallationAgent()
          Getter for field INSTALLAGENT
 java.util.Date getInstallationTime()
          Getter for field INSTALLTIME
 java.lang.String getInstallationUserID()
          Getter for field INSTALLUSRID
 java.lang.String getLastModificationAgent()
          Getter for field CHANGEAGENT
 java.lang.String getLastModificationAgentRelease()
          Getter for field CHANGEAGREL
 java.util.Date getLastModificationTime()
          Getter for field CHANGETIME
 java.lang.String getLastModificationUserID()
          Getter for field CHANGEUSRID
 ICICSType<IPolicyRule> getObjectType()
           
 java.lang.String getOperationName()
          Getter for field BASEOPERATN
 java.lang.String getOperator()
          Getter for field OPERATOR
 java.lang.String getPolicyName()
          Getter for field POLICY
 java.lang.String getPolicyRule()
          Getter for field RULE
 java.lang.String getPolicySet()
          Getter for field POLICYSET
 java.util.Date getPreviousExceptionTime()
          Getter for field TIME
 java.lang.String getRuleItem()
          Getter for field RULEITEM
 java.lang.String getRuleType()
          Getter for field RULETYPE
 java.lang.String getSourceOfTheResourceDefinition()
          Getter for field DEFINESOURCE
 java.lang.Long getThresholdExceededCount()
          Getter for field COUNT
 java.lang.Long getThresholdValue()
          Getter for field VALUE
 java.lang.String getTriggerAction()
          Getter for field ACTION
 java.lang.String getUserTag()
          Getter for field USERTAG
 java.lang.String getValueUnits()
          Getter for field UNIT
 
Methods inherited from interface com.ibm.cics.model.ICICSResource
getCICSRelease, getRegionName
 
Methods inherited from interface com.ibm.cics.model.ICICSObject
getCICSType, getName
 
Methods inherited from interface com.ibm.cics.model.meta.ITypedObject
getAttributeValue
 

Method Detail

getObjectType

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

getPolicyRule

java.lang.String getPolicyRule()
Getter for field RULE

Policy Rule

The name of the Policy Rule.


getLastModificationAgent

java.lang.String getLastModificationAgent()
Getter for field CHANGEAGENT

Last modification agent

The change agent identifier that made the last modification.


getLastModificationAgentRelease

java.lang.String getLastModificationAgentRelease()
Getter for field CHANGEAGREL

Last modification agent release

The CICS release level of the agent that made the last modification to the resource definition.


getLastModificationUserID

java.lang.String getLastModificationUserID()
Getter for field CHANGEUSRID

Last modification user ID

The user ID that made the last modification to the resource definition.


getSourceOfTheResourceDefinition

java.lang.String getSourceOfTheResourceDefinition()
Getter for field DEFINESOURCE

Source of the resource definition

The source of the definition, depending on which made the last change.


getCreationTime

java.util.Date getCreationTime()
Getter for field DEFINETIME

Creation time

The local date and time when the resource definition record was created on DFHCSD or EYUDREP.


getLastModificationTime

java.util.Date getLastModificationTime()
Getter for field CHANGETIME

Last modification time

The local date and time when the definition was last changed.


getInstallationTime

java.util.Date getInstallationTime()
Getter for field INSTALLTIME

Installation time

The local date and time when the definition was installed.


getInstallationAgent

java.lang.String getInstallationAgent()
Getter for field INSTALLAGENT

Installation agent

The install agent identifier that made the installation:


getInstallationUserID

java.lang.String getInstallationUserID()
Getter for field INSTALLUSRID

Installation user ID

The user ID that installed the resource definition.


getRuleType

java.lang.String getRuleType()
Getter for field RULETYPE

Rule type

The type of resource being monitored. Values are:


getRuleItem

java.lang.String getRuleItem()
Getter for field RULEITEM

Rule item name

The resource being monitored. Values are:


getOperator

java.lang.String getOperator()
Getter for field OPERATOR

Test operator

The operator that will be used on the value to establish whether the rule's condition has become true. Value are:


getThresholdValue

java.lang.Long getThresholdValue()
Getter for field VALUE

Limit value

The limiting value that will be checked to establish whether the rule's condition has become true.


getActualThresholdValue

java.lang.Long getActualThresholdValue()
Getter for field THRESHOLD

Actual threshold value

The actual value used to determine if a threshold has been breached. It is derived from combining the VALUE and UNIT attributes.


getValueUnits

java.lang.String getValueUnits()
Getter for field UNIT

Unit qualifier

The unit qualifier that applies to the limiting value provided. Values are:


getTriggerAction

java.lang.String getTriggerAction()
Getter for field ACTION

Trigger action

The action to be taken should this rule's condition become true. Values are:


getPolicySet

java.lang.String getPolicySet()
Getter for field POLICYSET

Policy set

The name of the run time policy set that contains the policy rule.


getPolicyName

java.lang.String getPolicyName()
Getter for field POLICY

Policy name

The name of the policy to which the rule belongs.


getUserTag

java.lang.String getUserTag()
Getter for field USERTAG

User tag

The user tag of the rule's policy as specified by the policy descriptor bundle XML.


getBundleName

java.lang.String getBundleName()
Getter for field BUNDLE

Bundle Name

The name of the bundle in which the rule's policy was installed.


getBundleID

java.lang.String getBundleID()
Getter for field BUNDLEID

Bundle ID

The ID of the bundle in which the rule's policy was installed.


getBundleMajorVersion

java.lang.Long getBundleMajorVersion()
Getter for field BUNDLEMAJVER

Bundle major version

The major version of the bundle in which the rule's policy was installed.


getBundleMinorVersion

java.lang.Long getBundleMinorVersion()
Getter for field BUNDLEMINVER

Bundle minor version

The minor version of the bundle in which the rule's policy was installed.


getBundleMicroVersion

java.lang.Long getBundleMicroVersion()
Getter for field BUNDLEMICVER

Bundle micro version

The micro version of the bundle in which the rule's policy was installed.


getBundleDirectoryName

java.lang.String getBundleDirectoryName()
Getter for field BUNDLEDIR

Bundle directory name

The fully-qualified name of the directory on zFS for the bundle in which the rule's policy was installed.


getBaseLevel

java.lang.String getBaseLevel()
Getter for field BASELEVEL

Base level

The level from where this rule was originally installed. E.g. If the query is for a scope of APPLICATION and this rule was installed for the PLATFORM in which the application runs then PLATRTYPE would be shown. Value are:


getBasePlatformName

java.lang.String getBasePlatformName()
Getter for field BASEPLATFORM

Base platform name

The name of the platform to which the policy rule applies.


getBaseApplicationName

java.lang.String getBaseApplicationName()
Getter for field BASEAPPLICTN

Base application name

The name of the application for which policy rules are being returned. If no application name is returned, then rules that apply to all applications are returned.


getBaseApplicationMajorVersion

java.lang.Long getBaseApplicationMajorVersion()
Getter for field BASEAPMAJVER

Base application major version

The major version of the application to which the policy rule applies. If no version is returned, then the rule was applied to all applications.


getBaseApplicationMinorVersion

java.lang.Long getBaseApplicationMinorVersion()
Getter for field BASEAPMINVER

Base application minor version

The minor version of the application to which the policy rule applies. If no version is returned, then the rule was applied to all applications.


getBaseApplicationMicroVersion

java.lang.Long getBaseApplicationMicroVersion()
Getter for field BASEAPMICVER

Base application micro version

The micro version of the application to which the policy rule applies. If no version is returned, then the rule was applied to all applications.


getOperationName

java.lang.String getOperationName()
Getter for field BASEOPERATN

Operation name

The name of the application operation to which the policy rule applies. If no application operation name is returned, then the rule was applied to all operations.


getThresholdExceededCount

java.lang.Long getThresholdExceededCount()
Getter for field COUNT

Threshold exceeded count

The count of the number of times that a rule threshold has been exceeded within the current statistics interval.


getAbendCode

java.lang.String getAbendCode()
Getter for field ABCODE

Abend code

The task abend code to be used when a threshold is breached with an ACTION value of ABEND.


getPreviousExceptionTime

java.util.Date getPreviousExceptionTime()
Getter for field TIME

Previous exception time

Time stamp of the last occasion when the rule threshold was exceeded.


getEpAdapterSet

java.lang.String getEpAdapterSet()
Getter for field EPADAPTERSET

EP adapter set name

The name of the event processing adapter set that encapsulates the event processing adapter that will be called when a threshold is breached with and ACTION value of EVENT.


getEpAdapter

java.lang.String getEpAdapter()
Getter for field EPADAPTER

EP adapter name

The name of the event processing adapter that will be called when a threshold is breached with and ACTION value of EVENT.


getCICSObjectReference

IPolicyRuleReference getCICSObjectReference()
Specified by:
getCICSObjectReference in interface ICICSObject

findReferences

<From extends ICICSObject> ICICSObjectListFactory<From> findReferences(IReferenceAttribute<From,IPolicyRule> 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.