alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm Class Reference

Inheritance diagram for alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm:

Collaboration diagram for alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm:

Public Member Functions
	SpecialAlarm (String family, String component, int code, boolean active, String action, String description, String cause, String consequences, int priority, String url, String email, Properties props) throws MalformedURLException
String	getAction ()
String	getAlarmId ()
Collection	getCategories ()
String	getCause ()
String	getConsequence ()
URL	getHelpURL ()
String	getIdentifier ()
Location	getLocation ()
String	getPiquetEmail ()
String	getPiquetGSM ()
Integer	getPriority ()
String	getProblemDescription ()
ResponsiblePerson	getResponsiblePerson ()
Source	getSource ()
Status	getStatus ()
void	setStatus (boolean active)
void	setUserProperties (Properties newPros)
String	getSystemName ()
Triplet	getTriplet ()
boolean	isInstant ()
boolean	isMultiplicityChild ()
boolean	isMultiplicityParent ()
boolean	isNodeChild ()
boolean	isNodeParent ()
Object	clone () throws CloneNotSupportedException
Private Attributes
final PanelTriplet	triplet
final PanelStatus	status
final String	action
final String	description
final String	cause
final String	consequences
final int	priority
final URL	url
final String	email

Detailed Description

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

Author:: acaproni

Since:: ACS 8.1.0

Constructor & Destructor Documentation

alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::SpecialAlarm	(	String	family,
		String	component,
		int	code,
		boolean	active,
		String	action,
		String	description,
		String	cause,
		String	consequences,
		int	priority,
		String	url,
		String	email,
		Properties	props
	)			throws MalformedURLException `[inline]`

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

Exceptions:

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

References action, cause, consequences, description, email, priority, status, triplet, and url.

Member Function Documentation

Object alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::clone ( ) throws CloneNotSupportedException [inline]

Cloning method. The cloned object is a deep copy.

Returns:: a deep copy of the object

Exceptions:

CloneNotSupportedException

if clone failed

Implements cern::laser::client::data::Alarm.

String alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getAction ( ) [inline]

See also:: cern.laser.client.data.Alarm::getAction()

Implements cern::laser::client::data::Alarm.

References action.

String alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getAlarmId ( ) [inline]

See also:: cern.laser.client.data.Alarm::getAlarmId()

Implements cern::laser::client::data::Alarm.

References alma::acsplugins::alarmsystem::gui::specialalarm::PanelTriplet::FC, alma::acsplugins::alarmsystem::gui::specialalarm::PanelTriplet::FF, alma::acsplugins::alarmsystem::gui::specialalarm::PanelTriplet::FM, and triplet.

Collection alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getCategories ( ) [inline]

See also:: cern.laser.client.data.Alarm::getCategories()

Implements cern::laser::client::data::Alarm.

String alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getCause ( ) [inline]

See also:: cern.laser.client.data.Alarm::getCause()

Implements cern::laser::client::data::Alarm.

References cause.

String alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getConsequence ( ) [inline]

See also:: cern.laser.client.data.Alarm::getConsequence()

Implements cern::laser::client::data::Alarm.

References consequences.

URL alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getHelpURL ( ) [inline]

See also:: cern.laser.client.data.Alarm::getHelpURL()

Implements cern::laser::client::data::Alarm.

References url.

String alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getIdentifier ( ) [inline]

See also:: cern.laser.client.data.Alarm::getIdentifier()

Implements cern::laser::client::data::Alarm.

Location alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getLocation ( ) [inline]

See also:: cern.laser.client.data.Alarm::getLocation()

Implements cern::laser::client::data::Alarm.

String alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getPiquetEmail ( ) [inline]

See also:: cern.laser.client.data.Alarm::getPiquetEmail()

Implements cern::laser::client::data::Alarm.

References email.

String alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getPiquetGSM ( ) [inline]

See also:: cern.laser.client.data.Alarm::getPiquetGSM()

Implements cern::laser::client::data::Alarm.

Integer alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getPriority ( ) [inline]

See also:: cern.laser.client.data.Alarm::getPriority()

Implements cern::laser::client::data::Alarm.

References priority.

String alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getProblemDescription ( ) [inline]

See also:: cern.laser.client.data.Alarm::getProblemDescription()

Implements cern::laser::client::data::Alarm.

References description.

ResponsiblePerson alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getResponsiblePerson ( ) [inline]

See also:: cern.laser.client.data.Alarm::getResponsiblePerson()

Implements cern::laser::client::data::Alarm.

Source alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getSource ( ) [inline]

See also:: cern.laser.client.data.Alarm::getSource()

Implements cern::laser::client::data::Alarm.

Status alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getStatus ( ) [inline]

See also:: cern.laser.client.data.Alarm::getStatus()

Implements cern::laser::client::data::Alarm.

References status.

Referenced by alma::acs::alarm::test::panel::SpecialAlarmTest::testSetProperties(), and alma::acs::alarm::test::panel::SpecialAlarmTest::testSetState().

String alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getSystemName ( ) [inline]

See also:: cern.laser.client.data.Alarm::getSystemName()

Implements cern::laser::client::data::Alarm.

Triplet alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::getTriplet ( ) [inline]

See also:: cern.laser.client.data.Alarm::getTriplet()

Implements cern::laser::client::data::Alarm.

References triplet.

boolean alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::isInstant ( ) [inline]

See also:: cern.laser.client.data.Alarm::isInstant()

Implements cern::laser::client::data::Alarm.

boolean alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::isMultiplicityChild ( ) [inline]

See also:: cern.laser.client.data.Alarm::isMultiplicityChild()

Implements cern::laser::client::data::Alarm.

boolean alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::isMultiplicityParent ( ) [inline]

See also:: cern.laser.client.data.Alarm::isMultiplicityParent()

Implements cern::laser::client::data::Alarm.

boolean alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::isNodeChild ( ) [inline]

See also:: cern.laser.client.data.Alarm::isNodeChild()

Implements cern::laser::client::data::Alarm.

boolean alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::isNodeParent ( ) [inline]

See also:: cern.laser.client.data.Alarm::isNodeParent()

Implements cern::laser::client::data::Alarm.

void alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::setStatus ( boolean active ) [inline]

Set the status active/inactive of the alarm

References alma::acsplugins::alarmsystem::gui::specialalarm::PanelStatus::setStatus(), and status.

Referenced by alma::acs::alarm::test::panel::SpecialAlarmTest::testSetState().

void alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::setUserProperties ( Properties newPros ) [inline]

Set the user properties of the alarm

Parameters:

newPros

The new properties

References alma::acsplugins::alarmsystem::gui::specialalarm::PanelStatus::setUserProps(), and status.

Referenced by alma::acs::alarm::test::panel::SpecialAlarmTest::testSetProperties().

Member Data Documentation

final String alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::action [private]

The action to fix the problem

Referenced by getAction(), and SpecialAlarm().

final String alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::cause [private]

The cause that generate the problem

Referenced by getCause(), and SpecialAlarm().

final String alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::consequences [private]

Referenced by getConsequence(), and SpecialAlarm().

final String alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::description [private]

Description of the problem

Referenced by getProblemDescription(), and SpecialAlarm().

final String alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::email [private]

Email address of the responsible for the alarm.

Referenced by getPiquetEmail(), and SpecialAlarm().

final int alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::priority [private]

The priority, or level, of the alarm.

priority is in [0..3] being 0 the highest priority.

Referenced by getPriority(), and SpecialAlarm().

final PanelStatus alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::status [private]

The status of the alarm

Referenced by getStatus(), setStatus(), setUserProperties(), and SpecialAlarm().

final PanelTriplet alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::triplet [private]

The triplet

Referenced by getAlarmId(), getTriplet(), and SpecialAlarm().

final URL alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm::url [private]

The RUL with the detailed documentation of the alarm

Referenced by getHelpURL(), and SpecialAlarm().

The documentation for this class was generated from the following file:

SpecialAlarm.java

alma::acsplugins::alarmsystem::gui::specialalarm::SpecialAlarm Class Reference

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation