Packagetwaver
Interfacepublic interface IAlarm extends IData, flash.events.IEventDispatcher, IClient
Implementors Alarm

This interface defines the common properties and behaviours for Alarm class. See Alarm class for more information about alarm mechanism in TWaver Flex.



Public Properties
 PropertyDefined By
  acked : Boolean
Whether this alarm is acknowledged.
IAlarm
  alarmSeverity : AlarmSeverity
Get alarm severity.
IAlarm
 Inheritedchildren : ICollection
[read-only] Get all children data as a collection.
IData
 InheritedchildrenCount : int
[read-only] Get total children count.
IData
  cleared : Boolean
Get the alarm cleared status.
IAlarm
 InheritedclientProperties : ICollection
[read-only] Get a ICollection that contians all client proerty name.
IClient
  elementID : Object
[read-only] Get the element ID where this alarm occured.
IAlarm
 InheritedhasChildren : Boolean
[read-only] Check whether this data has children data.
IData
 Inheritedicon : String
The small icon of this data.
IData
 Inheritedid : Object
[read-only] The ID of this data.
IData
 Inheritedname : String
Get the name of this data.
IData
 Inheritedparent : IData
Get parent data.
IData
 InheritedtoolTip : String
Get tooltip of this data.
IData
Public Methods
 MethodDefined By
 Inherited
addChild(child:IData, index:int = 0):Boolean
Add the specified data as a child of current data at the specified children index location.
IData
 Inherited
addPropertyChangeListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void
Add a property change listener on this data so it can be notified on any property changed.
IData
 Inherited
clearChildren():Boolean
Clear all children objects from this data.
IData
 Inherited
deserializeXML(serializer:XMLSerializer, dataXML:XML):void
Deserialize data from specified XML data.
IData
 Inherited
dispatchPropertyChangeEvent(property:String, oldValue:Object, newValue:Object):Boolean
Dispatch property change event.
IData
 Inherited
getChildAt(index:int):IData
Get child data from specified children location.
IData
 Inherited
getClient(clientProp:String):*
Get the specified client property.
IClient
 Inherited
getPropertyValue(property:String):Object
Get an user defined property on this data.
IData
 Inherited
hasOwnProperty(name:String):Boolean
Whether current data has created specified property.
IData
 Inherited
isDescendantOf(data:IData):Boolean
Check whether this data is a descendant of the specified data.
IData
 Inherited
isParentOf(data:IData):Boolean
Check whether this data is the parent of specified data.
IData
 Inherited
isRelatedTo(data:IData):Boolean
Check whether this data and the specified data has any relationship of descendant.
IData
 Inherited
removeChild(child:IData):Boolean
Remove the specified child data from children of current data.
IData
 Inherited
removePropertyChangeListener(listener:Function):void
Remove the specified property change listener from this data.
IData
 Inherited
serializeXML(serializer:XMLSerializer, newInstance:IData):void
Serialize this data into XML.
IData
 Inherited
setClient(clientProp:String, newValue:*):IClient
Set a client property by specified property name and property value.
IClient
 Inherited
setPropertyValue(property:String, value:Object):void
Set an user defined property on this data.
IData
 Inherited
toChildren(matchFunction:Function = null):ICollection
Return all children as a collection filtered by the specified function.
IData
 Inherited
toString():String
IData
Property Detail
ackedproperty
acked:Boolean

Whether this alarm is acknowledged.


Implementation
    public function get acked():Boolean
    public function set acked(value:Boolean):void
alarmSeverityproperty 
alarmSeverity:AlarmSeverity

Get alarm severity. Every alarm combines an alarm severity to indicate the alarm severe level.


Implementation
    public function get alarmSeverity():AlarmSeverity
    public function set alarmSeverity(value:AlarmSeverity):void
clearedproperty 
cleared:Boolean

Get the alarm cleared status. Cleared alarm means the problem of this alarm has been covered.


Implementation
    public function get cleared():Boolean
    public function set cleared(value:Boolean):void
elementIDproperty 
elementID:Object  [read-only]

Get the element ID where this alarm occured.


Implementation
    public function get elementID():Object