Package csw.alarm.api.models

Class AlarmMetadata

java.lang.Object

csw.alarm.api.models.AlarmMetadata

All Implemented Interfaces:

java.io.Serializable, scala.Equals, scala.Product, scala.Serializable

public class AlarmMetadata
extends java.lang.Object
implements scala.Product, scala.Serializable

Represents the metadata of an alarm e.g. name, subsystem it belongs to, supported severities, etc. This information is read from the config file for alarms and stored in alarm store. Metadata is referred while setting the severity to validate the operation. An alarm does not change it's metadata in it's entire life span.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
AlarmMetadata(Subsystem subsystem, java.lang.String component, java.lang.String name, java.lang.String description, java.lang.String location, AlarmType alarmType, scala.collection.immutable.Set<FullAlarmSeverity> supportedSeverities, java.lang.String probableCause, java.lang.String operatorResponse, boolean isAutoAcknowledgeable, boolean isLatchable, ActivationStatus activationStatus)

Method Summary

Modifier and Type	Method	Description
ActivationStatus	activationStatus()
Key.AlarmKey	alarmKey()	Represents a unique alarm in the store
AlarmType	alarmType()
scala.collection.immutable.Set<FullAlarmSeverity>	allSupportedSeverities()	A collection of all severities the alarm can be raised to including Indeterminate and Okay
abstract static boolean	canEqual(java.lang.Object that)
java.lang.String	component()
java.lang.String	description()
abstract static boolean	equals(java.lang.Object that)
boolean	isActive()	Represents whether the alarm is active or not
boolean	isAutoAcknowledgeable()
boolean	isLatchable()
java.lang.String	location()
java.lang.String	name()
java.lang.String	operatorResponse()
java.lang.String	probableCause()
abstract static int	productArity()
abstract static java.lang.Object	productElement(int n)
static scala.collection.Iterator<java.lang.Object>	productIterator()
static java.lang.String	productPrefix()
Subsystem	subsystem()
scala.collection.immutable.Set<FullAlarmSeverity>	supportedSeverities()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface scala.Equals

canEqual, equals

Methods inherited from interface scala.Product

productArity, productElement, productIterator, productPrefix

Constructor Detail

AlarmMetadata

public AlarmMetadata(Subsystem subsystem,
                     java.lang.String component,
                     java.lang.String name,
                     java.lang.String description,
                     java.lang.String location,
                     AlarmType alarmType,
                     scala.collection.immutable.Set<FullAlarmSeverity> supportedSeverities,
                     java.lang.String probableCause,
                     java.lang.String operatorResponse,
                     boolean isAutoAcknowledgeable,
                     boolean isLatchable,
                     ActivationStatus activationStatus)

Method Detail

canEqual

public abstract static boolean canEqual(java.lang.Object that)

equals

public abstract static boolean equals(java.lang.Object that)

productElement

public abstract static java.lang.Object productElement(int n)

productArity

public abstract static int productArity()

productIterator

public static scala.collection.Iterator<java.lang.Object> productIterator()

productPrefix

public static java.lang.String productPrefix()

subsystem

public Subsystem subsystem()

component

public java.lang.String component()

name

public java.lang.String name()

description

public java.lang.String description()

location

public java.lang.String location()

alarmType

public AlarmType alarmType()

supportedSeverities

public scala.collection.immutable.Set<FullAlarmSeverity> supportedSeverities()

probableCause

public java.lang.String probableCause()

operatorResponse

public java.lang.String operatorResponse()

isAutoAcknowledgeable

public boolean isAutoAcknowledgeable()

isLatchable

public boolean isLatchable()

activationStatus

public ActivationStatus activationStatus()

alarmKey

public Key.AlarmKey alarmKey()

Represents a unique alarm in the store

Returns:

an instance of AlarmKey composed of subsystem, component and name of the alarm

isActive

public boolean isActive()

Represents whether the alarm is active or not

Returns:

(undocumented)

allSupportedSeverities

public scala.collection.immutable.Set<FullAlarmSeverity> allSupportedSeverities()

A collection of all severities the alarm can be raised to including Indeterminate and Okay

Returns:

(undocumented)