Public Member Functions | Static Public Member Functions

cern.laser.client.services.selection.AlarmSelectionHandler Class Reference

Inheritance diagram for cern.laser.client.services.selection.AlarmSelectionHandler:
cern.laser.client.impl.services.selection.AlarmSelectionHandlerImpl

List of all members.

Public Member Functions

abstract Selection createSelection ()
abstract Map select (Selection selection, AlarmSelectionListener listener) throws LaserException, LaserTimeOutException
abstract void resetSelection () throws LaserException
abstract void close () throws LaserException
abstract void search (Selection selection, int nbOfRows, AlarmSearchListener searchListener) throws LaserException, LaserTimeOutException

Static Public Member Functions

static AlarmSelectionHandler get (ORB orb, AcsLogger logger) throws LaserConnectionException, LaserException

Detailed Description

Provides the services to define and perform an alarm selection.

Author:
F.Calderini
See also:
cern.laser.client.services.browsing.AlarmBrowsingHandler
cern.laser.client.services.browsing.CategoryBrowsingHandler
cern.laser.client.services.reduction.AlarmReductionHandler

Member Function Documentation

abstract void cern.laser.client.services.selection.AlarmSelectionHandler.close (  )  throws LaserException [pure virtual]

Close and deallocate resources.

Exceptions:
LaserException if the system is unable to close properly

Implemented in cern.laser.client.impl.services.selection.AlarmSelectionHandlerImpl.

Referenced by alma.alarmsystem.clients.CategoryClient.close().

abstract Selection cern.laser.client.services.selection.AlarmSelectionHandler.createSelection (  )  [pure virtual]

Creates a new selection

Returns:
the selection instance

Implemented in cern.laser.client.impl.services.selection.AlarmSelectionHandlerImpl.

static AlarmSelectionHandler cern.laser.client.services.selection.AlarmSelectionHandler.get ( ORB  orb,
AcsLogger  logger 
) throws LaserConnectionException, LaserException [static]

Factory method.

Returns:
an instance of the implementation class
Exceptions:
LaserException if the request can not be served

Referenced by alma.alarmsystem.clients.CategoryClient.connect().

abstract void cern.laser.client.services.selection.AlarmSelectionHandler.resetSelection (  )  throws LaserException [pure virtual]

Reset the selection.

Exceptions:
LaserException if the system is unable to reset the selection

Implemented in cern.laser.client.impl.services.selection.AlarmSelectionHandlerImpl.

abstract void cern.laser.client.services.selection.AlarmSelectionHandler.search ( Selection  selection,
int  nbOfRows,
AlarmSearchListener  searchListener 
) throws LaserException, LaserTimeOutException [pure virtual]

Starts the asynchronous alarm search. The found alarms will be asynchronously received.

Parameters:
selection the alarm selection instance
nbOfRows the number of rows to return
searchListener the search listener instance
Exceptions:
LaserConnectionException if the client cannot connect to the BL
LaserTimeOutException if the selection times out
LaserException if the system is unable to perform the selection

Implemented in cern.laser.client.impl.services.selection.AlarmSelectionHandlerImpl.

abstract Map cern.laser.client.services.selection.AlarmSelectionHandler.select ( Selection  selection,
AlarmSelectionListener  listener 
) throws LaserException, LaserTimeOutException [pure virtual]

Starts the asynchronous alarm selection. The selected alarms which are currently active will be asynchronously received as well as any change that may occur to their status.

Parameters:
selection the alarm selection instance
listener the selection listener instance
Returns:
the selected alarms currently active
Exceptions:
LaserConnectionException if the client cannot connect to the BL
LaserTimeOutException if the selection times out
LaserException if the system is unable to perform the selection

Implemented in cern.laser.client.impl.services.selection.AlarmSelectionHandlerImpl.

Referenced by alma.alarmsystem.clients.CategoryClient.connect().


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Enumerations Properties