|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.genesyslab.platform.applicationblocks.com.CfgBase
com.genesyslab.platform.applicationblocks.com.CfgObject
com.genesyslab.platform.applicationblocks.com.CfgDelta
com.genesyslab.platform.applicationblocks.com.objects.CfgDeltaAlarmCondition
public class CfgDeltaAlarmCondition
The changes to make to a
CfgAlarmCondition
object.
Constructor Summary | |
---|---|
CfgDeltaAlarmCondition(IConfService confService)
This constructor is intended for creation of detached objects. |
|
CfgDeltaAlarmCondition(IConfService confService,
ConfObjectDelta objData)
This constructor is intended for creation of delta objects from configuration protocol messages. |
|
CfgDeltaAlarmCondition(IConfService confService,
org.w3c.dom.Node xmlData)
This constructor is intended for creation of delta objects from configuration protocol messages. |
Method Summary | |
---|---|
java.util.Collection<java.lang.Integer> |
getAddedClearanceScriptDBIDs()
A pointer to a list of identifiers of the
CfgScript
that describe
clearance to an alarm based on this alarm condition. |
java.util.Collection<CfgScript> |
getAddedClearanceScripts()
A pointer to a list of identifiers of the
CfgScript
that describe
clearance to an alarm based on this alarm condition. |
java.util.Collection<java.lang.Integer> |
getAddedReactionScriptDBIDs()
A pointer to a list of identifiers of the
CfgScript
that describe
reactions to an alarm based on this alarm condition. |
java.util.Collection<CfgScript> |
getAddedReactionScripts()
A pointer to a list of identifiers of the
CfgScript
that describe
reactions to an alarm based on this alarm condition. |
KeyValueCollection |
getAddedUserProperties()
A pointer to the list of user-defined properties.Parameter userProperties has the following structure: Each key-value pair of the primary list (TKVList *userProperties) uses the key for the name of a user-defined section, and the value for a secondary list, that also has the TKVList structure and specifies the properties defined within that section. |
CfgDetectEvent |
getAlarmDetectEvent()
A pointer to the
CfgDetectEvent
structure which
is used to describe a log event upon which an alarm based on this
alarm condition should be detected. |
CfgScript |
getAlarmDetectScript()
A unique identifier of a script which describes the logic to be applied to detect an alarm based on this alarm condition. |
java.lang.Integer |
getAlarmDetectScriptDBID()
Retrieves the dbid of the object that is being linked to by the AlarmDetectScript property. |
CfgRemovalEvent |
getAlarmRemovalEvent()
A pointer to the
CfgRemovalEvent
structure which
is used to describe a log event upon which an alarm based on this
alarm condition should be removed. |
CfgAlarmCategory |
getCategory()
The category of the alarm condition. |
KeyValueCollection |
getChangedUserProperties()
A pointer to the list of user-defined properties whose values have been changed. |
java.util.Collection<java.lang.Integer> |
getClearanceScriptDBIDs()
Deprecated. |
java.lang.Integer |
getClearanceTimeout()
The period of time, in seconds, upon which an alarm based on this alarm condition has to be cleared since the moment it was detected. |
java.lang.Integer |
getDBID()
The DBID of the target CfgAlarmCondition configuration object. |
java.util.Collection<java.lang.Integer> |
getDeletedClearanceScriptDBIDs()
A pointer to a list of identifiers of the scripts excluded from clearance to the alarm based on this alarm condition. |
java.util.Collection<CfgScript> |
getDeletedClearanceScripts()
A pointer to a list of identifiers of the scripts excluded from clearance to the alarm based on this alarm condition. |
java.util.Collection<java.lang.Integer> |
getDeletedReactionScriptDBIDs()
A pointer to a list of identifiers of the scripts excluded from reactions to the alarm based on this alarm condition. |
java.util.Collection<CfgScript> |
getDeletedReactionScripts()
A pointer to a list of identifiers of the scripts excluded from reactions to the alarm based on this alarm condition. |
KeyValueCollection |
getDeletedUserProperties()
A pointer to the list of deleted user-defined properties. |
java.lang.String |
getDescription()
A pointer to the description of the alarm condition. |
CfgFlag |
getIsMasked()
Determines whether an alarm which is based on this alarm condition should be communicated to Solution Control Interface and reactions to the alarm should be performed. |
java.lang.String |
getName()
A pointer to the name of the alarm condition. |
java.util.Collection<java.lang.Integer> |
getReactionScriptDBIDs()
Deprecated. |
CfgObjectState |
getState()
Current object state. |
CfgAlarmCondition |
retrieveCfgAlarmCondition()
Read base CfgAlarmCondition configuration object caused this event. |
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgDelta |
---|
ensureDataBackup, retrieveObject, save, toStringProperties, update |
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject |
---|
clone, delete, doSetFolderId, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, updateACL |
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgBase |
---|
equals, flushChildrenContent, getConfigurationService, getData, getEndpoint, getLinkListCollection, getLinkValue, getLogger, getMetaData, getParent, getProperty, getProperty, getProperty, getRawObjectData, hashCode, initStruct, isSaved, lockObject, resolveLink, setProperty, toString, toXml, updateChildrenSavedState |
Methods inherited from class java.lang.Object |
---|
finalize, getClass, notify, notifyAll, wait, wait, wait |
Methods inherited from interface com.genesyslab.platform.applicationblocks.com.ICfgBase |
---|
getEndpoint, getProperty, getRawObjectData, setProperty, toXml |
Constructor Detail |
---|
public CfgDeltaAlarmCondition(IConfService confService)
confService
- configuration service instancepublic CfgDeltaAlarmCondition(IConfService confService, ConfObjectDelta objData)
confService
- configuration service instanceobjData
- configuration protocol object delta datapublic CfgDeltaAlarmCondition(IConfService confService, org.w3c.dom.Node xmlData)
confService
- configuration service instancexmlData
- XML object containing object delta dataMethod Detail |
---|
public final java.lang.Integer getDBID()
public final CfgAlarmCondition retrieveCfgAlarmCondition() throws ConfigException
ConfigException
- in case of problem while object readingpublic final java.lang.String getName()
public final java.lang.String getDescription()
public final CfgAlarmCategory getCategory()
CfgAlarmCategory
. Default value is CFGACMajor.
public final CfgDetectEvent getAlarmDetectEvent()
CfgDetectEvent
structure which
is used to describe a log event upon which an alarm based on this
alarm condition should be detected. Mandatory.
public final CfgRemovalEvent getAlarmRemovalEvent()
CfgRemovalEvent
structure which
is used to describe a log event upon which an alarm based on this
alarm condition should be removed.
public final CfgScript getAlarmDetectScript()
CFGAlarmDetection
can be specified. Reserved
for future use. See
CfgScript
.
public final java.lang.Integer getAlarmDetectScriptDBID()
public final java.lang.Integer getClearanceTimeout()
public final java.util.Collection<CfgScript> getAddedReactionScripts()
CfgScript
that describe
reactions to an alarm based on this alarm condition. Only scripts
whose type is
CFGAlarmReaction
can be specified. When
used as an entry in CfgDeltaAlarmCondition
(see below),
it is a pointer to a list of identifiers of the scripts added to
the existing list. See
CfgScript
.
public final java.util.Collection<java.lang.Integer> getAddedReactionScriptDBIDs()
CfgScript
that describe
reactions to an alarm based on this alarm condition. Only scripts
whose type is
CFGAlarmReaction
can be specified. When
used as an entry in CfgDeltaAlarmCondition
(see below),
it is a pointer to a list of identifiers of the scripts added to
the existing list. See
CfgScript
.
@Deprecated public final java.util.Collection<java.lang.Integer> getReactionScriptDBIDs()
getAddedReactionScriptDBIDs()
public final CfgFlag getIsMasked()
CFGFalse
.
Mandatory. See
CfgFlag
public final CfgObjectState getState()
CfgObjectState
public final KeyValueCollection getAddedUserProperties()
public final java.util.Collection<CfgScript> getAddedClearanceScripts()
CfgScript
that describe
clearance to an alarm based on this alarm condition. Only scripts
whose type is CFGAlarmReaction
can be specified. When
used as an entry in CfgDeltaAlarmCondition
(see below),
it is a pointer to a list of identifiers of the scripts added to
the existing list. See
CfgScript.
.
public final java.util.Collection<java.lang.Integer> getAddedClearanceScriptDBIDs()
CfgScript
that describe
clearance to an alarm based on this alarm condition. Only scripts
whose type is CFGAlarmReaction
can be specified. When
used as an entry in CfgDeltaAlarmCondition
(see below),
it is a pointer to a list of identifiers of the scripts added to
the existing list. See
CfgScript.
.
@Deprecated public final java.util.Collection<java.lang.Integer> getClearanceScriptDBIDs()
getAddedClearanceScriptDBIDs()
public final java.util.Collection<CfgScript> getDeletedReactionScripts()
public final java.util.Collection<java.lang.Integer> getDeletedReactionScriptDBIDs()
public final KeyValueCollection getDeletedUserProperties()
public final KeyValueCollection getChangedUserProperties()
public final java.util.Collection<CfgScript> getDeletedClearanceScripts()
public final java.util.Collection<java.lang.Integer> getDeletedClearanceScriptDBIDs()
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |