cern.laser.client.data

Interface Alarm

All Known Implementing Classes:

AlarmImpl, AlarmTableEntry, SpecialAlarm

public interface Alarm

The alarm class. It describes a fault state in terms of its static and dynamic information.

Method Summary

Modifier and Type	Method and Description
java.lang.Object	clone() Cloning method.
java.lang.String	getAction() Accessor method.
java.lang.String	getAlarmId() Accessor method.
java.util.Collection	getCategories() Accessor method.
java.lang.String	getCause() Accessor method.
java.lang.String	getConsequence() Accessor method.
java.net.URL	getHelpURL() Accessor method.
java.lang.String	getIdentifier() Accessor method.
Location	getLocation() Accessor method.
java.lang.String	getPiquetEmail() Accessor method.
java.lang.String	getPiquetGSM() Accessor method.
java.lang.Integer	getPriority() Accessor method.
java.lang.String	getProblemDescription() Accessor method.
ResponsiblePerson	getResponsiblePerson() Accessor method.
Source	getSource() Accessor method.
Status	getStatus() Accessor method.
java.lang.String	getSystemName() Accessor method.
Triplet	getTriplet() Accessor method.
boolean	isInstant() Accessor method.
boolean	isMultiplicityChild() Accessor method.
boolean	isMultiplicityParent() Accessor method.
boolean	isNodeChild() Accessor method.
boolean	isNodeParent() Accessor method.

Method Detail

getAlarmId

java.lang.String getAlarmId()

Accessor method.

Returns:

the alarm unique identifier

getTriplet

Triplet getTriplet()

Accessor method.

Returns:

the alarm unique triplet identifier

getSystemName

java.lang.String getSystemName()

Accessor method.

Returns:

the alarm system name

getIdentifier

java.lang.String getIdentifier()

Accessor method.

Returns:

the alarm system identifier

getProblemDescription

java.lang.String getProblemDescription()

Accessor method.

Returns:

the problem description

getPriority

java.lang.Integer getPriority()

Accessor method.

Returns:

the alarm priority (1..4)

getCause

java.lang.String getCause()

Accessor method.

Returns:

the alarm cause

getAction

java.lang.String getAction()

Accessor method.

Returns:

the alarm action to be taken

getConsequence

java.lang.String getConsequence()

Accessor method.

Returns:

the alarm consequence

getSource

Source getSource()

Accessor method.

Returns:

the alarm source

getHelpURL

java.net.URL getHelpURL()

Accessor method.

Returns:

the alarm URL, null if not available

getPiquetGSM

java.lang.String getPiquetGSM()

Accessor method.

Returns:

the alarm piquet GSM, null if not available

getPiquetEmail

java.lang.String getPiquetEmail()

Accessor method.

Returns:

the alarm piquet email, null if not available

getCategories

java.util.Collection getCategories()

Accessor method.

Returns:

the alarm attached categories

getLocation

Location getLocation()

Accessor method.

Returns:

the alarm location

getResponsiblePerson

ResponsiblePerson getResponsiblePerson()

Accessor method.

Returns:

the alarm responsible

getStatus

Status getStatus()

Accessor method.

Returns:

the alarm dynamic information

isInstant

boolean isInstant()

Accessor method.

Returns:

true, iff it is an instant alarm

isMultiplicityParent

boolean isMultiplicityParent()

Accessor method.

Returns:

true iff it is a multiplicity parent

isNodeParent

boolean isNodeParent()

Accessor method.

Returns:

true iff it is a node parent

isMultiplicityChild

boolean isMultiplicityChild()

Accessor method.

Returns:

true iff it is a multiplicity child

isNodeChild

boolean isNodeChild()

Accessor method.

Returns:

true iff it is a node child

clone

java.lang.Object clone()
                throws java.lang.CloneNotSupportedException

Cloning method. The cloned object is a deep copy.

Returns:

a deep copy of the object

Throws:

java.lang.CloneNotSupportedException - if clone failed