|
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.objects.CfgAlarmCondition
public class CfgAlarmCondition
Alarm Conditions specify events that you might want to know about and manage as soon as they occur.
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 |
---|
public static final CfgObjectType OBJECT_TYPE
Constructor Detail |
---|
public CfgAlarmCondition(IConfService confService, ConfObject objData, boolean isSaved, java.lang.Object[] additionalParameters)
confService
- configuration service instanceobjData
- configuration protocol object data structureisSaved
- indicator of the object saved stateadditionalParameters
- additional parameters from configuration protocol messagepublic CfgAlarmCondition(IConfService confService, org.w3c.dom.Node xmlData, java.lang.Object[] additionalParameters)
confService
- configuration service instancexmlData
- XML object containing object dataadditionalParameters
- additional parameters from configuration protocol messagepublic CfgAlarmCondition(IConfService confService)
confService
- configuration service instanceMethod Detail |
---|
public void save() throws ConfigException
save
in interface ICfgObject
save
in class CfgObject
ConfigException
- in case of protocol level exception, data transformation,
or server side constraintspublic final java.lang.Integer getDBID()
public final void setDBID(java.lang.Integer value)
value
- new property valuegetDBID()
public final java.lang.String getName()
public final void setName(java.lang.String value)
value
- new property valuegetName()
public final java.lang.String getDescription()
public final void setDescription(java.lang.String value)
value
- new property valuegetDescription()
public final CfgAlarmCategory getCategory()
CfgAlarmCategory
. Default value is CFGACMajor.
public final void setCategory(CfgAlarmCategory value)
CfgAlarmCategory
. Default value is CFGACMajor.
value
- new property valuegetCategory()
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 void setAlarmDetectEvent(CfgDetectEvent value)
CfgDetectEvent
structure which
is used to describe a log event upon which an alarm based on this
alarm condition should be detected. Mandatory.
value
- new property valuegetAlarmDetectEvent()
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 void setAlarmRemovalEvent(CfgRemovalEvent value)
CfgRemovalEvent
structure which
is used to describe a log event upon which an alarm based on this
alarm condition should be removed.
value
- new property valuegetAlarmRemovalEvent()
public final CfgScript getAlarmDetectScript()
CFGAlarmDetection
can be specified. Reserved
for future use. See
CfgScript
.
public final void setAlarmDetectScript(CfgScript value)
CFGAlarmDetection
can be specified. Reserved
for future use. See
CfgScript
.
value
- new property valuegetAlarmDetectScript()
public final void setAlarmDetectScriptDBID(int dbid)
CFGAlarmDetection
can be specified. Reserved
for future use. See
CfgScript
.
dbid
- DBID identifier of referred objectgetAlarmDetectScript()
public final java.lang.Integer getAlarmDetectScriptDBID()
public final java.lang.Integer getClearanceTimeout()
public final void setClearanceTimeout(java.lang.Integer value)
value
- new property valuegetClearanceTimeout()
public final java.util.Collection<CfgScript> getReactionScripts()
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 void setReactionScripts(java.util.Collection<CfgScript> value)
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
.
value
- new property valuegetReactionScripts()
public final java.util.Collection<java.lang.Integer> getReactionScriptDBIDs()
public final void setReactionScriptDBIDs(java.util.Collection<java.lang.Integer> value)
value
- collection of DBID identifiers of referred objectspublic final CfgFlag getIsMasked()
CFGFalse
.
Mandatory. See
CfgFlag
public final void setIsMasked(CfgFlag value)
CFGFalse
.
Mandatory. See
CfgFlag
value
- new property valuegetIsMasked()
public final CfgObjectState getState()
CfgObjectState
public final void setState(CfgObjectState value)
CfgObjectState
value
- new property valuegetState()
public final KeyValueCollection getUserProperties()
public final void setUserProperties(KeyValueCollection value)
value
- new property valuegetUserProperties()
public final java.util.Collection<CfgScript> getClearanceScripts()
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 void setClearanceScripts(java.util.Collection<CfgScript> value)
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.
.
value
- new property valuegetClearanceScripts()
public final java.util.Collection<java.lang.Integer> getClearanceScriptDBIDs()
public final void setClearanceScriptDBIDs(java.util.Collection<java.lang.Integer> value)
value
- collection of DBID identifiers of referred objects
|
Platform SDK Java 8.5 API Reference | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |