alma.acsplugins.alarmsystem.gui.specialalarm

Class SpecialAlarm

java.lang.Object

alma.acsplugins.alarmsystem.gui.specialalarm.SpecialAlarm

All Implemented Interfaces:

Alarm

public class SpecialAlarm
extends java.lang.Object
implements Alarm

An implementation of the Alarm to allow sending alarms to the panel through the addSpecialAlarm() method.

Since:

ACS 8.1.0

Author:

acaproni

Constructor Summary

Constructors

Constructor and Description
SpecialAlarm(java.lang.String family, java.lang.String component, int code, boolean active, java.lang.String action, java.lang.String description, java.lang.String cause, java.lang.String consequences, int priority, java.lang.String url, java.lang.String email, java.util.Properties props) Build a SpecialAlarm filling the fields as requested by the alarm panel and alarm system conventions.

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.
void	setStatus(boolean active) Set the status active/inactive of the alarm
void	setUserProperties(java.util.Properties newPros) Set the user properties of the alarm

Methods inherited from class java.lang.Object

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

Constructor Detail

SpecialAlarm

public SpecialAlarm(java.lang.String family,
                    java.lang.String component,
                    int code,
                    boolean active,
                    java.lang.String action,
                    java.lang.String description,
                    java.lang.String cause,
                    java.lang.String consequences,
                    int priority,
                    java.lang.String url,
                    java.lang.String email,
                    java.util.Properties props)
             throws java.net.MalformedURLException

Build a SpecialAlarm filling the fields as requested by the alarm panel and alarm system conventions.

Refers to the properties of this class for a full description of the parameters.

Parameters:

family - Fault family: can't be null nor empty.

component - Fault member (or component): can't be null nor empty.

code - Fault code

active - true if the alarm is active

action - Can't be null nor empty.

description - Can't be null nor empty.

cause -

consequences -

priority - Belongs to [0..3]. 0 is the highest priority.

url - Can be null or empty

email -

Properties - props

Throws:

java.net.MalformedURLException - If the passed url is malformed. This exception is not thrown when url is null or empty.

Method Detail

getAction

public java.lang.String getAction()

Description copied from interface: Alarm

Accessor method.

Specified by:

getAction in interface Alarm

Returns:

the alarm action to be taken

See Also:

Alarm.getAction()

getAlarmId

public java.lang.String getAlarmId()

Description copied from interface: Alarm

Accessor method.

Specified by:

getAlarmId in interface Alarm

Returns:

the alarm unique identifier

See Also:

Alarm.getAlarmId()

getCategories

public java.util.Collection getCategories()

Description copied from interface: Alarm

Accessor method.

Specified by:

getCategories in interface Alarm

Returns:

the alarm attached categories

See Also:

Alarm.getCategories()

getCause

public java.lang.String getCause()

Description copied from interface: Alarm

Accessor method.

Specified by:

getCause in interface Alarm

Returns:

the alarm cause

See Also:

Alarm.getCause()

getConsequence

public java.lang.String getConsequence()

Description copied from interface: Alarm

Accessor method.

Specified by:

getConsequence in interface Alarm

Returns:

the alarm consequence

See Also:

Alarm.getConsequence()

getHelpURL

public java.net.URL getHelpURL()

Description copied from interface: Alarm

Accessor method.

Specified by:

getHelpURL in interface Alarm

Returns:

the alarm URL, null if not available

See Also:

Alarm.getHelpURL()

getIdentifier

public java.lang.String getIdentifier()

Description copied from interface: Alarm

Accessor method.

Specified by:

getIdentifier in interface Alarm

Returns:

the alarm system identifier

See Also:

Alarm.getIdentifier()

getLocation

public Location getLocation()

Description copied from interface: Alarm

Accessor method.

Specified by:

getLocation in interface Alarm

Returns:

the alarm location

See Also:

Alarm.getLocation()

getPiquetEmail

public java.lang.String getPiquetEmail()

Description copied from interface: Alarm

Accessor method.

Specified by:

getPiquetEmail in interface Alarm

Returns:

the alarm piquet email, null if not available

See Also:

Alarm.getPiquetEmail()

getPiquetGSM

public java.lang.String getPiquetGSM()

Description copied from interface: Alarm

Accessor method.

Specified by:

getPiquetGSM in interface Alarm

Returns:

the alarm piquet GSM, null if not available

See Also:

Alarm.getPiquetGSM()

getPriority

public java.lang.Integer getPriority()

Description copied from interface: Alarm

Accessor method.

Specified by:

getPriority in interface Alarm

Returns:

the alarm priority (1..4)

See Also:

Alarm.getPriority()

getProblemDescription

public java.lang.String getProblemDescription()

Description copied from interface: Alarm

Accessor method.

Specified by:

getProblemDescription in interface Alarm

Returns:

the problem description

See Also:

Alarm.getProblemDescription()

getResponsiblePerson

public ResponsiblePerson getResponsiblePerson()

Description copied from interface: Alarm

Accessor method.

Specified by:

getResponsiblePerson in interface Alarm

Returns:

the alarm responsible

See Also:

Alarm.getResponsiblePerson()

getSource

public Source getSource()

Description copied from interface: Alarm

Accessor method.

Specified by:

getSource in interface Alarm

Returns:

the alarm source

See Also:

Alarm.getSource()

getStatus

public Status getStatus()

Description copied from interface: Alarm

Accessor method.

Specified by:

getStatus in interface Alarm

Returns:

the alarm dynamic information

See Also:

Alarm.getStatus()

setStatus

public void setStatus(boolean active)

Set the status active/inactive of the alarm

setUserProperties

public void setUserProperties(java.util.Properties newPros)

Set the user properties of the alarm

Parameters:

newPros - The new properties

getSystemName

public java.lang.String getSystemName()

Description copied from interface: Alarm

Accessor method.

Specified by:

getSystemName in interface Alarm

Returns:

the alarm system name

See Also:

Alarm.getSystemName()

getTriplet

public Triplet getTriplet()

Description copied from interface: Alarm

Accessor method.

Specified by:

getTriplet in interface Alarm

Returns:

the alarm unique triplet identifier

See Also:

Alarm.getTriplet()

isInstant

public boolean isInstant()

Description copied from interface: Alarm

Accessor method.

Specified by:

isInstant in interface Alarm

Returns:

true, iff it is an instant alarm

See Also:

Alarm.isInstant()

isMultiplicityChild

public boolean isMultiplicityChild()

Description copied from interface: Alarm

Accessor method.

Specified by:

isMultiplicityChild in interface Alarm

Returns:

true iff it is a multiplicity child

See Also:

Alarm.isMultiplicityChild()

isMultiplicityParent

public boolean isMultiplicityParent()

Description copied from interface: Alarm

Accessor method.

Specified by:

isMultiplicityParent in interface Alarm

Returns:

true iff it is a multiplicity parent

See Also:

Alarm.isMultiplicityParent()

isNodeChild

public boolean isNodeChild()

Description copied from interface: Alarm

Accessor method.

Specified by:

isNodeChild in interface Alarm

Returns:

true iff it is a node child

See Also:

Alarm.isNodeChild()

isNodeParent

public boolean isNodeParent()

Description copied from interface: Alarm

Accessor method.

Specified by:

isNodeParent in interface Alarm

Returns:

true iff it is a node parent

See Also:

Alarm.isNodeParent()

clone

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

Description copied from interface: Alarm

Cloning method. The cloned object is a deep copy.

Specified by:

clone in interface Alarm

Overrides:

clone in class java.lang.Object

Returns:

a deep copy of the object

Throws:

java.lang.CloneNotSupportedException - if clone failed