Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgDeltaAlarmCondition

java.lang.Object
  extended by com.genesyslab.platform.applicationblocks.com.CfgBase
      extended by com.genesyslab.platform.applicationblocks.com.CfgObject
          extended by com.genesyslab.platform.applicationblocks.com.CfgDelta
              extended by com.genesyslab.platform.applicationblocks.com.objects.CfgDeltaAlarmCondition
All Implemented Interfaces:
ICfgBase, ICfgDelta, ICfgObject, java.lang.Cloneable

public class CfgDeltaAlarmCondition
extends CfgDelta

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

CfgDeltaAlarmCondition

public CfgDeltaAlarmCondition(IConfService confService)
This constructor is intended for creation of detached objects.

Parameters:
confService - configuration service instance

CfgDeltaAlarmCondition

public CfgDeltaAlarmCondition(IConfService confService,
                              ConfObjectDelta objData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object delta data

CfgDeltaAlarmCondition

public CfgDeltaAlarmCondition(IConfService confService,
                              org.w3c.dom.Node xmlData)
This constructor is intended for creation of delta objects from configuration protocol messages. It is internally used by COM AB for delta objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object delta data
Method Detail

getDBID

public final java.lang.Integer getDBID()
The DBID of the target CfgAlarmCondition configuration object.

Returns:
target object DBID

retrieveCfgAlarmCondition

public final CfgAlarmCondition retrieveCfgAlarmCondition()
                                                  throws ConfigException
Read base CfgAlarmCondition configuration object caused this event.

Returns:
configuration object read
Throws:
ConfigException - in case of problem while object reading

getName

public final java.lang.String getName()
A pointer to the name of the alarm condition. Mandatory. Must be unique within the Configuration Database.

Returns:
property value or null

getDescription

public final java.lang.String getDescription()
A pointer to the description of the alarm condition.

Returns:
property value or null

getCategory

public final CfgAlarmCategory getCategory()
The category of the alarm condition. Mandatory. See type CfgAlarmCategory . Default value is CFGACMajor.

Returns:
property value or null

getAlarmDetectEvent

public final 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. Mandatory.

Returns:
property value or null

getAlarmRemovalEvent

public final 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.

Returns:
property value or null

getAlarmDetectScript

public final CfgScript getAlarmDetectScript()
A unique identifier of a script which describes the logic to be applied to detect an alarm based on this alarm condition. Only a script whose type is CFGAlarmDetection can be specified. Reserved for future use. See CfgScript .

Returns:
instance of referred object or null

getAlarmDetectScriptDBID

public final java.lang.Integer getAlarmDetectScriptDBID()
Retrieves the dbid of the object that is being linked to by the AlarmDetectScript property. Configuration server provides it only if the property value has been changed.

Returns:
DBID identifier of referred object or null

getClearanceTimeout

public final 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. Default value is 24 hours (24*60*60 = 86400).

Returns:
property value or null

getAddedReactionScripts

public final 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. 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 .

Returns:
list of configuration objects or null

getAddedReactionScriptDBIDs

public final 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. 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 .

Returns:
collection of DBID identifiers of referred objects or null

getReactionScriptDBIDs

@Deprecated
public final java.util.Collection<java.lang.Integer> getReactionScriptDBIDs()
Deprecated. 

See Also:
getAddedReactionScriptDBIDs()

getIsMasked

public final 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. This corresponds to the default value of CFGFalse. Mandatory. See CfgFlag

Returns:
property value or null

getState

public final CfgObjectState getState()
Current object state. Mandatory. Refer to CfgObjectState

Returns:
property value or null

getAddedUserProperties

public final 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.

Returns:
property value or null

getAddedClearanceScripts

public final 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. 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..

Returns:
list of configuration objects or null

getAddedClearanceScriptDBIDs

public final 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. 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..

Returns:
collection of DBID identifiers of referred objects or null

getClearanceScriptDBIDs

@Deprecated
public final java.util.Collection<java.lang.Integer> getClearanceScriptDBIDs()
Deprecated. 

See Also:
getAddedClearanceScriptDBIDs()

getDeletedReactionScripts

public final 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.

Returns:
list of configuration objects or null

getDeletedReactionScriptDBIDs

public final 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.

Returns:
collection of DBID identifiers of referred objects or null

getDeletedUserProperties

public final KeyValueCollection getDeletedUserProperties()
A pointer to the list of deleted user-defined properties. Has the same structure as parameter userProperties.

Returns:
property value or null

getChangedUserProperties

public final KeyValueCollection getChangedUserProperties()
A pointer to the list of user-defined properties whose values have been changed. Has the same structure as parameter userProperties

Returns:
property value or null

getDeletedClearanceScripts

public final 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.

Returns:
list of configuration objects or null

getDeletedClearanceScriptDBIDs

public final 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.

Returns:
collection of DBID identifiers of referred objects or null

Platform SDK Java 8.5 API Reference

Send comments on this topicTechpubs.webadmin@genesys.com.
Document version: 8.5.302.00
Copyright © 2006–2017 Genesys Telecommunications Laboratories, Inc. All rights reserved.