Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

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

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

CategoryBrowsingHandler get () throws LaserConnectionException

Static Private Attributes

final ThreadLocal categoryBrowsingHandler = new ThreadLocal()

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

CategoryBrowsingHandler cern::laser::client::services::browsing::CategoryBrowsingHandler::get  )  throws LaserConnectionException [inline, 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

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

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

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

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

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

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


Member Data Documentation

final ThreadLocal cern::laser::client::services::browsing::CategoryBrowsingHandler::categoryBrowsingHandler = new ThreadLocal() [static, private]
 


The documentation for this class was generated from the following file:
Generated on Thu Apr 30 03:08:54 2009 for ACS Java API by doxygen 1.3.8