Defines baja.AlarmSpace.
new (require("baja/alarm/AlarmSpace"))()
Represents a alarm:AlarmSpace
in BajaScript.
Extends:
Methods
-
ackAlarms( [params] [, obj])
-
Acknowledge a group of alarms by id and/or source
Parameters:
Name Type Argument Description params
Object <optional>
Properties
Name Type Argument Description ids
Array.<String> <optional>
Array of encoded baja:Uuid strings representing alarm ids
srcs
Array.<String> <optional>
Array of encoded baja.Ord strings representing sources
obj
Object <optional>
The object literal.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) Called once mapping
has been created.fail
function <optional>
(Deprecated: use Promise) Called if the
mapping cannot be created.Returns:
Promise resolved when alarms have been acknowledged
- Type
- Promise
-
addNote(alarm, note, obj)
-
Add a note to an alarm record
Parameters:
Name Type Description alarm
The alarm record to which to add the note
note
obj
Returns:
- Type
- Promise
-
addNoteToAlarms( [params] [, obj])
-
Add notes to a number of alarms by id and/or source.
Parameters:
Name Type Argument Description params
Object <optional>
Properties
Name Type Argument Description ids
Array.<String> <optional>
Array of encoded baja:Uuid strings representing alarm ids
srcs
Array.<String> <optional>
Array of encoded baja.Ord strings representing sources
obj
Object <optional>
The object literal.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) Called once the request has completed.
fail
function <optional>
(Deprecated: use Promise) Called if the request fails.
Returns:
Promise resolved once the call is complete.
- Type
- Promise
-
clearAllRecords( [obj])
-
Clear all the records from the alarm database.
Parameters:
Name Type Argument Description obj
Object <optional>
The object literal.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) Called once the
records have been successfully cleared.fail
function <optional>
(Deprecated: use Promise) Called if the
alarm devices fails to resolve.batch
baja.comm.Batch <optional>
if defined, any network calls will be
batched into this object.Returns:
A promise that's resolved once all of the records have
been cleared.- Type
- Promise
-
clearOldRecords( [beforeTime] [, obj])
-
Clear all records with a timestamp before the specified time.
Also update the totalAlarmCount, unackedAlarmCount, openAlarmCount,
and inAlarmCount properties all BAlarmClasses.Parameters:
Name Type Argument Description beforeTime
baja.AbsTime <optional>
The earliest time to keep in the result.
Records before this time will be removed.obj
Object <optional>
The object literal.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) Called once the
records have been successfully cleared.fail
function <optional>
(Deprecated: use Promise) Called if the alarm
devices fails to resolve.batch
baja.comm.Batch <optional>
if defined, any network calls will be
batched into this object.Returns:
A promise that's resolved once all of the records have
been cleared.- Type
- Promise
-
clearRecords(uuids [, obj])
-
Clear the record with the given uuid.
Also update the totalAlarmCount, unackedAlarmCount, openAlarmCount,
and inAlarmCount properties all BAlarmClasses.Parameters:
Name Type Argument Description uuids
Array An array of encoded uuids to remove from the database
obj
Object <optional>
The object literal.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) Called once the
records have been successfully cleared.fail
function <optional>
(Deprecated: use Promise) Called if the alarm
devices fails to resolve.batch
baja.comm.Batch <optional>
if defined, any network calls will be
batched into this object.Returns:
A promise that's resolved once all of the records have
been cleared.- Type
- Promise
-
equals(obj)
-
Indicates whether some other object is equal to this one.
Parameters:
Name Type Description obj
Object the reference object with which to compare.
- Inherited From:
Returns:
true if this object is the same as the obj argument; false otherwise.
- Type
- Boolean
-
equivalent(obj)
-
Equivalence test.
equivalent()
is used to compare if two Objects have equivalent
state, but might not want to return true for equals since it
it has implied semantics for many operations. The default
implementation returns the result of baja.Object#equals.Parameters:
Name Type Description obj
- Inherited From:
Returns:
- Type
- Boolean
-
forceClear( [params] [, obj])
-
Force alarms clear by id and/or source.
Parameters:
Name Type Argument Description params
Object <optional>
Properties
Name Type Argument Description ids
Array.<String> <optional>
Array of encoded baja:Uuid strings representing alarm ids
srcs
Array.<String> <optional>
Array of encoded baja.Ord strings representing sources
obj
Object <optional>
The object literal.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) Called once the request has completed.
fail
function <optional>
(Deprecated: use Promise) Called if the request fails.
Returns:
Promise resolved once the call is complete.
- Type
- Promise
-
getAgents( [is], batch)
-
Returns a promise that resolves to the agent list for this Object.
Parameters:
Name Type Argument Description is
Array.<String> <optional>
An optional array of filters to add to the
agent query.batch
baja.comm.Batch An optional object used to batch network
calls together.- Inherited From:
- See:
Returns:
A promise that will resolve with the Agent Info.
- Type
- Promise
-
getAlarmFields( [obj])
-
Returns an array of the declared fields in an alarm record
Parameters:
Name Type Argument Description obj
Object <optional>
The object literal.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) Called once mapping
has been created.fail
function <optional>
(Deprecated: use Promise) Called if the
mapping cannot be created.batch
baja.comm.Batch <optional>
if defined, any network calls will be
batched into this objectReturns:
Promise resolved with Array of Strings representing field names
- Type
- Promise.<Array.<String>>
-
getDisplayNamesMap( [obj])
-
Returns an object map of alarm class names -> alarm class display names
Parameters:
Name Type Argument Description obj
Object <optional>
The object literal.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) Called once mapping
has been created.fail
function <optional>
(Deprecated: use Promise) Called if the
mapping cannot be created.batch
baja.comm.Batch <optional>
if defined, any network calls will be
batched into this objectReturns:
Promise resolved with map object
- Type
- Promise.<Object>
-
getIcon()
-
Return the Object's Icon.
- Inherited From:
Returns:
- Type
- baja.Icon
-
getNavChildren(obj)
-
Access the Nav Children.
Parameters:
Name Type Description obj
Object the Object Literal for the method's arguments.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) called when we have
the Nav Children. An array of Nav Children is passed as an argument into
this function.fail
function <optional>
(Deprecated: use Promise) called if the
function fails to complete.- Inherited From:
Returns:
a promise that will be resolved
once the nav children have been retrieved.- Type
- Promise.<Array.<baja.NavNode>>
Example
container.getNavChildren() .then(function (kids) { baja.outln('retrieved nav children: ' + kids.join()); }) .catch(function (err) { baja.error('failed to retrieve nav children: ' + err); });
-
getNavDescription()
-
Return the Nav Description.
- Inherited From:
Returns:
- Type
- String
-
getNavDisplayName()
-
Return the Nav Display Name.
- Inherited From:
Returns:
- Type
- String
-
getNavIcon()
-
Return the Nav Icon for this node.
- Inherited From:
Returns:
- Type
- baja.Icon
-
getNavName()
-
Return the Nav Name.
- Inherited From:
Returns:
- Type
- String
-
getNavOrd()
-
Return the Nav ORD.
- Inherited From:
Returns:
- Type
- baja.Ord
-
getNavParent()
-
Return the Nav Parent (or null if there's no parent).
- Inherited From:
Returns:
- Type
- baja.NavContainer
-
getNavTypeSpec()
-
Return the type spec of object this nav node navigates too.
- Inherited From:
Returns:
The nav type spec.
- Type
- String
-
getNotes( [params] [, obj])
-
Returns notes for an alarm record.
Parameters:
Name Type Argument Description params
Object <optional>
Properties
Name Type Argument Description uuid
Array.<String> <optional>
Encoded baja:Uuid string representing an alarm id
obj
Object <optional>
The object literal.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) Called once mapping
has been created.fail
function <optional>
(Deprecated: use Promise) Called if the
mapping cannot be created.batch
baja.comm.Batch <optional>
if defined, any network calls will be
batched into this objectReturns:
Promise resolved with a notes string
- Type
- Promise.<String>
-
getSingleSourceSummary(params [, obj])
-
Query summary alarms for a single source.
Parameters:
Name Type Argument Description params
Object Properties
Name Type Argument Description offset
Number The query offset for the cursor. This is the index of where the cursor starts.
limit
Number The limit to the number of records downloaded.
source
The alarm source.
ord
The ORD for the recipient to query alarms from.
filterSet
<optional>
An optional filter set.
timeRange
<optional>
An optional time range filter.
column
String <optional>
An optional column name to sort by. This can be an alarm record property name
or prefixed with 'alarmData.' if sorting via an alarm data facets column. If not specified, the alarm data
will be sorted by timestamp.sortDesc
Boolean <optional>
An optional flag used to indicate whether to sort by descending or ascending order.
If not specified, the data will sort by descending order.obj
Object <optional>
The object literal.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) Called once the request has completed.
fail
function <optional>
(Deprecated: use Promise) Called if the request fails.
Returns:
Promise resolved once the call is complete.
- Type
- Promise
-
getType()
-
Get the type of this instance.
- Inherited From:
Returns:
- Type
- Type
-
queryAlarmDatabase( [timeRange] [, obj])
-
Query the alarm database for the given time range
Parameters:
Name Type Argument Description timeRange
baja.AbsTime <optional>
The time range to query
obj
Object <optional>
The object literal.
Properties
Name Type Argument Description ok
function <optional>
(Deprecated: use Promise) Called once the
records have been successfully cleared.fail
function <optional>
(Deprecated: use Promise) Called if the alarm
devices fails to resolve.batch
baja.comm.Batch <optional>
if defined, any network calls will be
batched into this object.Returns:
A promise that's resolved once all of the records have
been retrieved- Type
- Promise
-
toString( [cx])
-
Returns the String representation of this Object.
When implementing
toString()
on one of your own Objects, it should
adhere to the following contract.- When called with no arguments, it must return a string directly.
- It can also be called with an object literal. In this case, it may
return a Promise to be resolved with a string, or it may return a string
directly as normal. This case is sort of analogous tojavax.baja.sys.Localizable#toString(Context)
.
Therefore, when calling
toString()
on an Object of unknown Type using an
object literal as an argument, it's important to wrap the call inPromise.resolve()
.Parameters:
Name Type Argument Description cx
Object <optional>
optional context information to be used when
formatting the string- Inherited From:
Returns:
a string (if no context passed), or
either a string or a Promise (if context passed).Examples
When no context is passed, toString() must always return a string directly.
var bool = comp.get('boolean'); baja.outln(bool.toString()); // 'false'
When a context is passed, some Objects may return a Promise.
var bool = comp.get('boolean'); bool.toString({ trueText: 'Yes', falseText: 'No' }) .then(function (str) { baja.outln(str); // 'No' });
If you don't know the type of the Object, use Promise.resolve() for safety.
var displayFacets = comp.get('displayFacets'), value = comp.get('value'); Promise.resolve(value.toString(displayFacets.toObject())) .then(function (str) { baja.outln(str); // formatted according to displayFacets });
-
valueOf()
-
Return the inner value of the object.
By default the object's instance is returned.
- Inherited From:
Returns:
the inner value of the object or just the object's instance.
- Type
- *