cern.laser.client.services.browsing

Class AlarmBrowsingHandler

java.lang.Object

cern.laser.client.services.browsing.AlarmBrowsingHandler

Direct Known Subclasses:

AlarmBrowsingHandlerImpl

public abstract class AlarmBrowsingHandler
extends java.lang.Object

Provides the service to handle alarm definitions browsing.

See Also:

CategoryBrowsingHandler, AlarmReductionHandler, AlarmSelectionHandler

Constructor Summary

Constructors

Constructor and Description
AlarmBrowsingHandler()

Method Summary

Modifier and Type	Method and Description
static AlarmBrowsingHandler	get(org.omg.CORBA.ORB orb, AcsLogger logger) Factory method.
abstract Alarm	getAlarmById(java.lang.String alarmId) Get an alarm.
abstract Alarm	getAlarmByTriplet(java.lang.String faultFamily, java.lang.String faultMember, java.lang.Integer faultCode) Get an alarm.
abstract Alarm	getAlarmByTriplet(Triplet triplet) Get an alarm.
abstract java.util.Collection	getAlarmsByCategory(Category category) Get the alarms attached to the category.
abstract java.util.Collection	getAlarmsByCategory(java.lang.Integer categoryId) Get the alarms attached to the category.
abstract java.util.Collection	getAlarmsByPriority(java.lang.Integer priority) Get the alarms attached to the priority.
abstract java.util.Collection	getAlarmsByResponsiblePerson(java.lang.Integer responsibleId) Get the alarms attached to the responsible person.
abstract java.util.Collection	getAlarmsByResponsiblePerson(ResponsiblePerson responsible) Get the alarms attached to the responsible person.
abstract java.util.Collection	getAlarmsBySource(Source source) Get the alarms attached to the source.
abstract java.util.Collection	getAlarmsBySource(java.lang.String sourceId) Get the alarms attached to the source.
abstract java.util.Collection	getResponsiblePersons() Get the defined responsible persons.
abstract java.util.Collection	getSources() Get the defined alarm sources.

Methods inherited from class java.lang.Object

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

Constructor Detail

AlarmBrowsingHandler

public AlarmBrowsingHandler()

Method Detail

get

public static AlarmBrowsingHandler get(org.omg.CORBA.ORB orb,
                                       AcsLogger logger)
                                throws LaserConnectionException

Factory method.

Returns:

an instance of the implementation class

Throws:

LaserException - if the request can not be served

LaserConnectionException

getAlarmById

public abstract Alarm getAlarmById(java.lang.String alarmId)
                            throws LaserException

Get an alarm.

Parameters:

alarmId - the alarm identifier

Returns:

the AlarmImpl instance, null if the alarm does not exist

Throws:

LaserException - if the request can not be served

getAlarmByTriplet

public abstract Alarm getAlarmByTriplet(Triplet triplet)
                                 throws LaserException

Get an alarm.

Parameters:

triplet - the alarm public identifier

Returns:

the AlarmImpl instance, null if the alarm does not exist

Throws:

LaserException - if the request can not be served

getAlarmByTriplet

public abstract Alarm getAlarmByTriplet(java.lang.String faultFamily,
                                        java.lang.String faultMember,
                                        java.lang.Integer faultCode)
                                 throws LaserException

Get an alarm.

Parameters:

faultFamily - the fault family

faultMember - the fault member

faultCode - the fault code

Returns:

the AlarmImpl instance, null if the alarm does not exist

Throws:

LaserException - if the request can not be served

getAlarmsByCategory

public abstract java.util.Collection getAlarmsByCategory(java.lang.Integer categoryId)
                                                  throws LaserException

Get the alarms attached to the category.

Parameters:

categoryId - the category identifier

Returns:

the alarms attached to the category, an empty collection if none

Throws:

LaserException - if the request can not be served

getAlarmsByCategory

public abstract java.util.Collection getAlarmsByCategory(Category category)
                                                  throws LaserException

Get the alarms attached to the category.

Parameters:

category - the category

Returns:

the alarms attached to the category, an empty collection if none

Throws:

LaserException - if the request can not be served

getAlarmsBySource

public abstract java.util.Collection getAlarmsBySource(java.lang.String sourceId)
                                                throws LaserException

Get the alarms attached to the source.

Parameters:

sourceId - the source identifier

Returns:

the alarms attached to the source, an empty collection if none

Throws:

LaserException - if the request can not be served

getAlarmsBySource

public abstract java.util.Collection getAlarmsBySource(Source source)
                                                throws LaserException

Get the alarms attached to the source.

Parameters:

source - the source

Returns:

the alarms attached to the source, an empty collection if none

Throws:

LaserException - if the request can not be served

getAlarmsByResponsiblePerson

public abstract java.util.Collection getAlarmsByResponsiblePerson(java.lang.Integer responsibleId)
                                                           throws LaserException

Get the alarms attached to the responsible person.

Parameters:

responsibleId - the responsible person identifier

Returns:

the alarms attacched to the responsible person, an empty collection if none

Throws:

LaserException - if the request can not be served

getAlarmsByResponsiblePerson

public abstract java.util.Collection getAlarmsByResponsiblePerson(ResponsiblePerson responsible)
                                                           throws LaserException

Get the alarms attached to the responsible person.

Parameters:

responsible - the responsible person

Returns:

the alarms attacched to the responsible person, an empty collection if none

Throws:

LaserException - if the request can not be served

getAlarmsByPriority

public abstract java.util.Collection getAlarmsByPriority(java.lang.Integer priority)
                                                  throws LaserException

Get the alarms attached to the priority.

Parameters:

priority - the priority (1..4)

Returns:

the alarms attached to the priority, an empty collection if none

Throws:

LaserException - if the request can not be served

getSources

public abstract java.util.Collection getSources()
                                         throws LaserException

Get the defined alarm sources.

Returns:

the defined alarm sources

Throws:

LaserException - if the request can not be served

getResponsiblePersons

public abstract java.util.Collection getResponsiblePersons()
                                                    throws LaserException

Get the defined responsible persons.

Returns:

the defined responsible persons

Throws:

LaserException - if the request can not be served

LaserConnectionException