Platform SDK Java 8.5 API Reference

com.genesyslab.platform.applicationblocks.com.objects
Class CfgAlarmCondition

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.objects.CfgAlarmCondition
All Implemented Interfaces:
ICfgBase, ICfgObject, java.lang.Cloneable

public class CfgAlarmCondition
extends CfgObject

Alarm Conditions specify events that you might want to know about and manage as soon as they occur.

See also:

CfgDeltaAlarmCondition

CfgScript

CfgApplication


Field Summary
static CfgObjectType OBJECT_TYPE
           
 
Constructor Summary
CfgAlarmCondition(IConfService confService)
          This constructor is intended for creation of detached objects.
CfgAlarmCondition(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
CfgAlarmCondition(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
          This constructor is intended for creation of objects from configuration protocol messages.
 
Method Summary
 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.
 java.util.Collection<java.lang.Integer> getClearanceScriptDBIDs()
          Retrieves dbids of objects that are being linked to by the ClearanceScripts property.
 java.util.Collection<CfgScript> getClearanceScripts()
          A pointer to a list of identifiers of the CfgScript that describe clearance to an alarm based on this alarm condition.
 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()
          An identifier of this object in the Configuration Database.
 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()
          Retrieves dbids of objects that are being linked to by the ReactionScripts property.
 java.util.Collection<CfgScript> getReactionScripts()
          A pointer to a list of identifiers of the CfgScript that describe reactions to an alarm based on this alarm condition.
 CfgObjectState getState()
          Current object state.
 KeyValueCollection getUserProperties()
          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.
 void save()
          Synchronizes changes in the class with Configuration Server.
 void setAlarmDetectEvent(CfgDetectEvent value)
          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.
 void setAlarmDetectScript(CfgScript value)
          A unique identifier of a script which describes the logic to be applied to detect an alarm based on this alarm condition.
 void setAlarmDetectScriptDBID(int dbid)
          A unique identifier of a script which describes the logic to be applied to detect an alarm based on this alarm condition.
 void setAlarmRemovalEvent(CfgRemovalEvent value)
          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.
 void setCategory(CfgAlarmCategory value)
          The category of the alarm condition.
 void setClearanceScriptDBIDs(java.util.Collection<java.lang.Integer> value)
          Sets dbids collection of objects that are being linked to by the ClearanceScripts property.
 void setClearanceScripts(java.util.Collection<CfgScript> value)
          A pointer to a list of identifiers of the CfgScript that describe clearance to an alarm based on this alarm condition.
 void setClearanceTimeout(java.lang.Integer value)
          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.
 void setDBID(java.lang.Integer value)
          An identifier of this object in the Configuration Database.
 void setDescription(java.lang.String value)
          A pointer to the description of the alarm condition.
 void setIsMasked(CfgFlag value)
          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.
 void setName(java.lang.String value)
          A pointer to the name of the alarm condition.
 void setReactionScriptDBIDs(java.util.Collection<java.lang.Integer> value)
          Sets dbids collection of objects that are being linked to by the ReactionScripts property.
 void setReactionScripts(java.util.Collection<CfgScript> value)
          A pointer to a list of identifiers of the CfgScript that describe reactions to an alarm based on this alarm condition.
 void setState(CfgObjectState value)
          Current object state.
 void setUserProperties(KeyValueCollection value)
          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.
 
Methods inherited from class com.genesyslab.platform.applicationblocks.com.CfgObject
clone, delete, doSetFolderId, ensureDataBackup, getFolderId, getObjectDbid, getObjectPath, getObjectType, refresh, reloadObjectWithNewData, reloadObjectWithNewData, removeAccount, resetDataBackup, retrieveAccountPermissions, retrieveACL, retrievePermissions, setAccountPermissions, setAccountPermissions, setFolderId, update, 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, toStringProperties, 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
 

Field Detail

OBJECT_TYPE

public static final CfgObjectType OBJECT_TYPE
Constructor Detail

CfgAlarmCondition

public CfgAlarmCondition(IConfService confService,
                         ConfObject objData,
                         boolean isSaved,
                         java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
objData - configuration protocol object data structure
isSaved - indicator of the object saved state
additionalParameters - additional parameters from configuration protocol message

CfgAlarmCondition

public CfgAlarmCondition(IConfService confService,
                         org.w3c.dom.Node xmlData,
                         java.lang.Object[] additionalParameters)
This constructor is intended for creation of objects from configuration protocol messages. It is internally used by COM AB for objects deserialization.

Parameters:
confService - configuration service instance
xmlData - XML object containing object data
additionalParameters - additional parameters from configuration protocol message

CfgAlarmCondition

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

Parameters:
confService - configuration service instance
Method Detail

save

public void save()
          throws ConfigException
Synchronizes changes in the class with Configuration Server.

Specified by:
save in interface ICfgObject
Overrides:
save in class CfgObject
Throws:
ConfigException - in case of protocol level exception, data transformation, or server side constraints

getDBID

public final java.lang.Integer getDBID()
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Returns:
property value or null

setDBID

public final void setDBID(java.lang.Integer value)
An identifier of this object in the Configuration Database. Generated by Configuration Server and is unique within an object type. Identifiers of deleted objects are not used again. Read-only.

Parameters:
value - new property value
See Also:
getDBID()

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

setName

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

Parameters:
value - new property value
See Also:
getName()

getDescription

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

Returns:
property value or null

setDescription

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

Parameters:
value - new property value
See Also:
getDescription()

getCategory

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

Returns:
property value or null

setCategory

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

Parameters:
value - new property value
See Also:
getCategory()

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

setAlarmDetectEvent

public final void setAlarmDetectEvent(CfgDetectEvent value)
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.

Parameters:
value - new property value
See Also:
getAlarmDetectEvent()

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

setAlarmRemovalEvent

public final void setAlarmRemovalEvent(CfgRemovalEvent value)
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.

Parameters:
value - new property value
See Also:
getAlarmRemovalEvent()

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

setAlarmDetectScript

public final void setAlarmDetectScript(CfgScript value)
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 .

Parameters:
value - new property value
See Also:
getAlarmDetectScript()

setAlarmDetectScriptDBID

public final void setAlarmDetectScriptDBID(int dbid)
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 .

Parameters:
dbid - DBID identifier of referred object
See Also:
getAlarmDetectScript()

getAlarmDetectScriptDBID

public final java.lang.Integer getAlarmDetectScriptDBID()
Retrieves the dbid of the object that is being linked to by the AlarmDetectScript property.

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

setClearanceTimeout

public final void setClearanceTimeout(java.lang.Integer value)
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).

Parameters:
value - new property value
See Also:
getClearanceTimeout()

getReactionScripts

public final java.util.Collection<CfgScript> getReactionScripts()
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

setReactionScripts

public final void setReactionScripts(java.util.Collection<CfgScript> value)
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 .

Parameters:
value - new property value
See Also:
getReactionScripts()

getReactionScriptDBIDs

public final java.util.Collection<java.lang.Integer> getReactionScriptDBIDs()
Retrieves dbids of objects that are being linked to by the ReactionScripts property. It's a snapshot collection containing original values. Modification of this collection instance will not affect actual value of the objects' property.

Returns:
collection of DBID identifiers of referred objects or null

setReactionScriptDBIDs

public final void setReactionScriptDBIDs(java.util.Collection<java.lang.Integer> value)
Sets dbids collection of objects that are being linked to by the ReactionScripts property.

Parameters:
value - collection of DBID identifiers of referred objects

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

setIsMasked

public final void setIsMasked(CfgFlag value)
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

Parameters:
value - new property value
See Also:
getIsMasked()

getState

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

Returns:
property value or null

setState

public final void setState(CfgObjectState value)
Current object state. Mandatory. Refer to CfgObjectState

Parameters:
value - new property value
See Also:
getState()

getUserProperties

public final KeyValueCollection getUserProperties()
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

setUserProperties

public final void setUserProperties(KeyValueCollection value)
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.

Parameters:
value - new property value
See Also:
getUserProperties()

getClearanceScripts

public final java.util.Collection<CfgScript> getClearanceScripts()
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

setClearanceScripts

public final void setClearanceScripts(java.util.Collection<CfgScript> value)
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..

Parameters:
value - new property value
See Also:
getClearanceScripts()

getClearanceScriptDBIDs

public final java.util.Collection<java.lang.Integer> getClearanceScriptDBIDs()
Retrieves dbids of objects that are being linked to by the ClearanceScripts property. It's a snapshot collection containing original values. Modification of this collection instance will not affect actual value of the objects' property.

Returns:
collection of DBID identifiers of referred objects or null

setClearanceScriptDBIDs

public final void setClearanceScriptDBIDs(java.util.Collection<java.lang.Integer> value)
Sets dbids collection of objects that are being linked to by the ClearanceScripts property.

Parameters:
value - collection of DBID identifiers of referred objects

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.