| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
defaultExpression* P | AlarmExpression[] |
The default setting for each alarm expression, used to populate the
initial client wizard screen.
|
description P | AlarmDescription |
The static descriptive strings used in alarms.
|
Methods
Methods defined in this Managed Object |
---|
AcknowledgeAlarm, AreAlarmActionsEnabled, CreateAlarm, EnableAlarmActions, GetAlarm, GetAlarmState |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
alarm P | ManagedObjectReference
to a Alarm |
The Alarm to acknowledge.
|
entity P | ManagedObjectReference
to a ManagedEntity |
The ManagedEntity for which to acknowledge the Alarm.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
InvalidArgument | Thrown if the tuple doesn't exist. |
InvalidRequest | Thrown if the referenced alarm/entity is null |
ManagedObjectNotFound | Thrown if the referenced alarm/entity is invalid. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
entity P | ManagedObjectReference
to a ManagedEntity |
The managed entity to look up.
|
Return Value
Type | Description |
---|---|
xsd:boolean |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
In addition to the Alarm.Create privilege, may also require the Global.ScriptAction if a RunScriptAction action is specified in the AlarmSpec.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
entity P | ManagedObjectReference
to a ManagedEntity |
The entity with which the alarm is associated.
|
spec | AlarmSpec |
The specification for the new alarm.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference
to a Alarm | A reference to the Alarm object created by the operation. |
Faults
Type | Description |
---|---|
DuplicateName | Thrown if an alarm with the name already exists. |
InvalidArgument | Thrown if the specification is invalid. |
InvalidName | Thrown if the alarm name is empty or too long. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
entity P | ManagedObjectReference
to a ManagedEntity |
The managed entity on which to set a schedule.
|
enabled | xsd:boolean |
true, if alarms are enabled during the schedule.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
entity* | ManagedObjectReference
to a ManagedEntity |
The entity. If not set, alarms are returned for
all visible entities.
|
Return Value
Type | Description |
---|---|
ManagedObjectReference[]
to a Alarm[] | A reference to the Alarm objects returned by the operation. |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the AlarmManager used to make the method call. |
entity P | ManagedObjectReference
to a ManagedEntity |
The entity.
|
Return Value
Type | Description |
---|---|
AlarmState[] | The state of instantiated alarms. |
Faults
Type | Description |
---|---|
InvalidRequest | Thrown if the referenced entity is null. |
ManagedObjectNotFound | Thrown if the referenced entity is invalid. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |