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

Inheritance diagram for cern::laser::client::services::browsing::CategoryBrowsingHandler:

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 () throws LaserConnectionException
Static Private Attributes
static 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

static 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

Reimplemented in cern::laser::guiplatform::category::helpers::CategoryHandler.

References categoryBrowsingHandler.

Referenced by cern::laser::guiplatform::category::CategoryBrowsingHandlerFactory::getHandler(), and cern::laser::definition::impl::CategoryDefinitionHandlerImplTest::setUp().

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, and cern::laser::guiplatform::category::helpers::CategoryHandler.

Referenced by cern::laser::client::TestCategoryBrowsing::TestCategoryBrowsing(), cern::laser::test::TestConfiguration::TestConfiguration(), cern::laser::console::TestConfiguration::TestConfiguration(), cern::laser::test::TestSelection::TestSelection(), cern::laser::test::TstCategoryBrowsing::TstCategoryBrowsing(), and cern::laser::test::TstConfiguration2::TstConfiguration2().

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, and cern::laser::guiplatform::category::helpers::CategoryHandler.

Referenced by cern::laser::client::TestSearch::TestSearch(), cern::laser::client::TestSelection::TestSelection(), and cern::laser::definition::impl::CategoryDefinitionHandlerImplTest::testUploadReader().

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, and cern::laser::guiplatform::category::helpers::CategoryHandler.

Referenced by cern::laser::guiplatform::windows::category::ChooseCategoryPanel::createCategoryTree(), cern::laser::test::TestCategoryBrowsing::TestCategoryBrowsing(), cern::laser::client::TestCategoryBrowsing::TestCategoryBrowsing(), and cern::laser::test::TstCategoryBrowsing::TstCategoryBrowsing().

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, and cern::laser::guiplatform::category::helpers::CategoryHandler.

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, and cern::laser::guiplatform::category::helpers::CategoryHandler.

Referenced by cern::laser::test::TestCategoryBrowsing::TestCategoryBrowsing(), cern::laser::client::TestCategoryBrowsing::TestCategoryBrowsing(), and cern::laser::test::TstCategoryBrowsing::TstCategoryBrowsing().

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, and cern::laser::guiplatform::category::helpers::CategoryHandler.

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