Packagetwaver
Classpublic class Alarm
InheritanceAlarm Inheritance Data Inheritance flash.events.EventDispatcher
Implements IAlarm

Alarm is a predefined data object for an alarm condition in a telecom network management system. This defination is based on the ITU-T X.733, OSS/J Quality of the Service API, and the convention of OSS and telecom industry.

In TWaver, the alarm object used to present the OSS server side alarm. An alarm means a network problem which is detected by OSS and is created by the server side of OSS. The server may transfer the alarm information to the client side and show it on the network topology view.

TWaver just defines the most general and most often used properties for alarm object. Just remember this alarm object is defined for UI side to use, not for server side or for database storage. The OSS server side should have a more comprehensive alarm object with more business properties. TWaver alarm can be considered a simple version of the server side alarm object.

TWaver alarm is a very lightweight object, you can create thousands of alarms and load into DataBox to show. However, it is always a good idea to load the alarms or elements only when UI need to show it. Using SubNetwork or more lazy-loading mechanism provided by TWaver to make your UI more lighweight, high performance, and elegant. Flex is mostly runs inside the browser. Not like Java Swing or other desktop UI platform, TWaver Flex is not designed to be used in the OSS which needs to show huge volume data. So always avoid load big volume data into TWaver Flex.

All TWaver alarms saved in AlarmBox, which is an alarm container provided by ElementBox. Use elementBox.alarmBox to access AlarmBox. AlarmBox manages all alarm objects for this the ElementBox. Each alarm object can be specified an ElementID property, which indicates where the alarm occured.

Alarm object can be customized to carry more additiona information. Use setPropertyValue to create a new property with any object type.

	 var alarm:Alarm = new Alarm();
	 box.alarmBox.add(alarm);
	 

See also

twaver.AlarmBox
twaver.AlarmSeverity
twaver.AlarmState
twaver.ElementBox


Public Properties
 PropertyDefined By
  acked : Boolean
Get the acked status.
Alarm
  alarmSeverity : AlarmSeverity
Get the alarm severity value.
Alarm
 Inheritedchildren : ICollection
[read-only] Get all children data objects of this data object.
Data
 InheritedchildrenCount : int
[read-only] Get all children total count for this data.
Data
  cleared : Boolean
Get the alarm cleared status.
Alarm
 InheritedclientProperties : ICollection
[read-only] Get a ICollection that contians all client proerty name.
Data
  elementID : Object
[read-only] Get the element ID this alarm accured.
Alarm
 InheritedhasChildren : Boolean
[read-only] Check whether this data has children objects.
Data
 Inheritedicon : String
Get icon value for this data.
Data
 Inheritedid : Object
[read-only] Get the ID value of this data.
Data
 Inheritedname : String
Get name of this data.
Data
 Inheritedparent : IData
Get parent data object.
Data
 InheritedtoolTip : String
Get the tooltip text of this data.
Data
Public Methods
 MethodDefined By
  
Alarm(alarmID:Object = null, elementID:Object = null, alarmSeverity:AlarmSeverity = null, acked:Boolean = false, cleared:Boolean = false)
Constructor
Alarm
 Inherited
addChild(child:IData, index:int = -1):Boolean
Add a child data object for this data.
Data
 Inherited
addPropertyChangeListener(listener:Function, priority:int = 0, useWeakReference:Boolean = false):void
Add a property change listener to this data to monitoring property change event.
Data
 Inherited
clearChildren():Boolean
Clear all children from this data.
Data
 Inherited
deserializeXML(serializer:XMLSerializer, xml:XML):void
Deserialize given XML data to data objects.
Data
 Inherited
dispatchPropertyChangeEvent(property:String, oldValue:Object, newValue:Object):Boolean
Dispatch property change event to all installed listeners.
Data
 Inherited
getChildAt(index:int):IData
Get child as specified index location.
Data
 Inherited
getClient(clientProp:String):*
Get specified client property value.
Data
 Inherited
getPropertyValue(property:String):Object
Get specified property value from this data.
Data
 Inherited
hasOwnProperty(name:String):Boolean
Whether this data has specified property.
Data
 Inherited
isDescendantOf(data:IData):Boolean
Check whether this data is a descendant of the specified data object.
Data
 Inherited
isParentOf(data:IData):Boolean
Check whether this data is the parent of specified data.
Data
 Inherited
isRelatedTo(data:IData):Boolean
Check whether this data has descendant relationship with the specified data.
Data
 Inherited
removeChild(child:IData):Boolean
Remove the specified child object.
Data
 Inherited
removePropertyChangeListener(listener:Function):void
Remove the specified property change listener.
Data
 Inherited
serializeXML(serializer:XMLSerializer, newInstance:IData):void
Serialize this data object into XML.
Data
 Inherited
setClient(clientProp:String, newValue:*):IClient
Set client property for this data.
Data
 Inherited
setPropertyValue(property:String, value:Object):void
Set specified property name value on this data.
Data
 Inherited
toChildren(matchFunction:Function = null):ICollection
Iterate children collection by given callback function.
Data
 Inherited
toString():String
[override]
Data
Protected Methods
 MethodDefined By
 Inherited
deserializeClient(serializer:XMLSerializer, clientXML:XML, clientProp:String):void
Deserialize client property from given XML data.
Data
 Inherited
deserializeProperty(serializer:XMLSerializer, propertyXML:XML, property:String):void
Deserialize specified property from the given XML data contains property value.
Data
 Inherited
onChildAdded(child:IData, index:int):void
Called back when a child is added.
Data
 Inherited
onChildRemoved(child:IData, index:int):void
Called back when a child is removed.
Data
 Inherited
onChildrenCleared(children:Array):void
Called back when all children are cleared from this data.
Data
 Inherited
onClientChanged(styleProp:String, oldValue:*, newValue:*):void
Called when client property is changed.
Data
 Inherited
onParentChanged(oldParent:IData, newParent:IData):void
Called back when data parent changed.
Data
 Inherited
onPropertyChanged(property:String, oldValue:Object, newValue:Object):void
Called back when a property of this data is changed.
Data
 Inherited
serializeClient(serializer:XMLSerializer, clientPrope:String, newInstance:IData):void
Serialize given client property into the specified XML serializer.
Data
 Inherited
serializeProperty(serializer:XMLSerializer, property:String, newInstance:IData):void
Serialize given property into the specified XML serializer.
Data
Property Detail
ackedproperty
acked:Boolean

Get the acked status. True is acknowledged, otherwise false.


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

Get the alarm severity value. The alarm severity represent the severe level of this alarm. All alarm severities are defined in class twaver.AlarmSeverity.


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

Get the alarm cleared status.


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

Get the element ID this alarm accured.


Implementation
    public function get elementID():Object
Constructor Detail
Alarm()Constructor
public function Alarm(alarmID:Object = null, elementID:Object = null, alarmSeverity:AlarmSeverity = null, acked:Boolean = false, cleared:Boolean = false)

Constructor

Parameters
alarmID:Object (default = null) — The identifier of this alarm object. This should be unique value in the alarmBox container. If not specified, TWaver will generate a value internally.
 
elementID:Object (default = null) — The element ID alarm occured. If a non-null value specified, then TWaver will update the alarm state of the element, show the alarm clue of the element on Network.
 
alarmSeverity:AlarmSeverity (default = null) — The alarm severity of this alarm. See all alarm severities provided by TWaver in class twaver.AlarmSeverity
 
acked:Boolean (default = false) — Whether this alarm is acknowledged.
 
cleared:Boolean (default = false) — Whether this alarm is cleared.