Public Member Functions | Static Public Member Functions

cern.laser.client.services.browsing.CategoryBrowsingHandler Class Reference

Inheritance diagram for cern.laser.client.services.browsing.CategoryBrowsingHandler:
cern.laser.client.impl.services.browsing.CategoryBrowsingHandlerImpl

List of all members.

Public Member Functions

abstract Category getCategoryByPath (String path) throws LaserException
abstract Category getCategoryTreeRoot () throws LaserException
abstract Collection getChildren (Category node) throws LaserException
abstract Collection getChildren (Integer nodeId) throws LaserException
abstract Category getParent (Category node) throws LaserException
abstract Category getParent (Integer nodeId) throws LaserException
abstract Collection getCategories () throws LaserException

Static Public Member Functions

static CategoryBrowsingHandler get (ORB orb, AcsLogger logger) throws LaserConnectionException

Detailed Description

Provides the service to handle alarm category hierarchy browsing.

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

Member Function Documentation

static CategoryBrowsingHandler cern.laser.client.services.browsing.CategoryBrowsingHandler.get ( ORB  orb,
AcsLogger  logger 
) throws LaserConnectionException [static]

Factory method.

Returns:
an instance of the implementation class
Exceptions:
LaserException if the request can not be served
abstract Collection cern.laser.client.services.browsing.CategoryBrowsingHandler.getCategories (  )  throws LaserException [pure virtual]

Get all the defined categories.

Exceptions:
LaserException if the request can not be served
Returns:
the defined category collection

Implemented in cern.laser.client.impl.services.browsing.CategoryBrowsingHandlerImpl.

abstract Category cern.laser.client.services.browsing.CategoryBrowsingHandler.getCategoryByPath ( String  path  )  throws LaserException [pure virtual]

Get the category.

Parameters:
path the category path in the form name.name....name
Exceptions:
LaserException if the request can not be served
Returns:
the category object, null if the category does not exist

Implemented in cern.laser.client.impl.services.browsing.CategoryBrowsingHandlerImpl.

abstract Category cern.laser.client.services.browsing.CategoryBrowsingHandler.getCategoryTreeRoot (  )  throws LaserException [pure virtual]

Get the category tree root.

Exceptions:
LaserException if the request can not be served
Returns:
the category tree root object

Implemented in cern.laser.client.impl.services.browsing.CategoryBrowsingHandlerImpl.

abstract Collection cern.laser.client.services.browsing.CategoryBrowsingHandler.getChildren ( Integer  nodeId  )  throws LaserException [pure virtual]

Get the category children.

Parameters:
nodeId the category parent identifier
Exceptions:
LaserException if the request can not be served
Returns:
the category children collection

Implemented in cern.laser.client.impl.services.browsing.CategoryBrowsingHandlerImpl.

abstract Collection cern.laser.client.services.browsing.CategoryBrowsingHandler.getChildren ( Category  node  )  throws LaserException [pure virtual]

Get the category children.

Parameters:
node the category parent
Exceptions:
LaserException if the request can not be served
Returns:
the category children collection

Implemented in cern.laser.client.impl.services.browsing.CategoryBrowsingHandlerImpl.

abstract Category cern.laser.client.services.browsing.CategoryBrowsingHandler.getParent ( Category  node  )  throws LaserException [pure virtual]

Get the category parent.

Parameters:
node the category
Exceptions:
LaserException if the request can not be served
Returns:
the parent category, null if the category is the root category

Implemented in cern.laser.client.impl.services.browsing.CategoryBrowsingHandlerImpl.

abstract Category cern.laser.client.services.browsing.CategoryBrowsingHandler.getParent ( Integer  nodeId  )  throws LaserException [pure virtual]

Get the category parent.

Parameters:
nodeId the category identifier
Exceptions:
LaserException if the request can not be served
Returns:
the parent category, null if the category is the root category

Implemented in cern.laser.client.impl.services.browsing.CategoryBrowsingHandlerImpl.


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