cern::laser::console::User Interface Reference

Inheritance diagram for cern::laser::console::User:

[legend]

List of all members.

Public Member Functions
String	getName () throws LaserConsoleException
String	getPassword () throws LaserConsoleException
void	setPassword (String newPassword) throws LaserConsoleException
String	getDefaultPrinter () throws LaserConsoleException
void	setDefaultPrinter (String newDefaultPrinter) throws LaserConsoleException
Collection	getConfigurations () throws LaserConsoleException, LaserConnectionException
Configuration	getConfiguration (String name) throws LaserConsoleException, LaserConnectionException
Configuration	createConfiguration (String name) throws LaserConsoleException
Configuration	createConfiguration (Configuration configuration) throws LaserConsoleException
void	removeConfiguration (String name) throws LaserConsoleException
Configuration	getDefaultConfiguration () throws LaserConsoleException, LaserConnectionException
void	setDefaultConfiguration (String name) throws LaserConsoleException
boolean	isDefaultConfiguration (String name) throws LaserConsoleException

---

Detailed Description

Alarm console user.

Author:

F.Calderini

See also:

cern.laser.console.Configuration

---

Member Function Documentation

Configuration cern::laser::console::User::createConfiguration

(

Configuration

configuration

)

throws LaserConsoleException

Create a new alarm console configuration for the user using a given configuration.

Parameters:

configuration

the configuration to be used to create the new one.

Returns:

the configuration that has been created from the given configuration.

Exceptions:

	LaserConsoleException	if the request could not be served.
	LaserConfigurationDuplicationException	if the configuration already exists.

Implemented in cern::laser::console::impl::UserImpl.

Configuration cern::laser::console::User::createConfiguration

(

String

name

)

throws LaserConsoleException

Create a new alarm console configuration for the user.

Parameters:

name

the name of the configuration to create.

Returns:

the configuration that has been created with default values.

Exceptions:

	LaserConsoleException	if the request could not be served.
	LaserConfigurationDuplicationException	if the configuration already exists.

Implemented in cern::laser::console::impl::UserImpl.

Referenced by cern::laser::guiplatform::actions::configuration::ConfigurationSetAsDefaultAction::copyAndSetAsDefaultConfiguration(), cern::laser::guiplatform::windows::configuration::ConsoleConfigurationPanel::createConfiguration(), cern::laser::guiplatform::windows::login::AlarmConsoleLoginWindow::login(), com::cosylab::acs::alarm::AlarmUserTest::notestUserConfiguration(), cern::laser::test::TestConfiguration::TestConfiguration(), cern::laser::console::TestConfiguration::TestConfiguration(), cern::laser::test::TestConfigurationWindow::testConsoleConfigurationWindow(), cern::laser::test::TestSelectionAndConfiguration::TestSelectionAndConfiguration(), and cern::laser::test::TstConfiguration2::TstConfiguration2().

Configuration cern::laser::console::User::getConfiguration

(

String

name

)

throws LaserConsoleException, LaserConnectionException

Accessor method.

Returns:

the user console configuration.

Parameters:

name

the name of the configuration.

Exceptions:

	LaserConnectionException	if the console cannot connect to the BL
	LaserConfigurationNotFoundException	if the configuration does not exist.

Implemented in cern::laser::console::impl::UserImpl.

Referenced by cern::laser::guiplatform::actions::configuration::ConfigurationSetAsDefaultAction::copyAndSetAsDefaultConfiguration(), cern::laser::guiplatform::windows::configuration::ConsoleConfigurationPanel::createConfiguration(), cern::laser::guiplatform::windows::login::AlarmConsoleLoginWindow::login(), com::cosylab::acs::alarm::AlarmUserTest::notestUserConfiguration(), cern::laser::guiplatform::actions::configuration::ConfigurationLoadAction::performAction(), cern::laser::console::TestConfiguration::TestConfiguration(), cern::laser::test::TestConfigurationWindow::testConsoleConfigurationWindow(), cern::laser::test::TestSelectionAndConfiguration::TestSelectionAndConfiguration(), and cern::laser::test::TstConfiguration2::TstConfiguration2().

Collection cern::laser::console::User::getConfigurations

(

)

throws LaserConsoleException, LaserConnectionException

Accessor method.

Returns:

the user console configurations.

Exceptions:

	LaserConsoleException	if the request could not be served.
	LaserConnectionException	if the console cannot connect to the BL

Implemented in cern::laser::console::impl::UserImpl.

Referenced by cern::laser::test::TestConfiguration::TestConfiguration(), cern::laser::console::TestConfiguration::TestConfiguration(), cern::laser::console::TestConfigurationBrowsing::TestConfigurationBrowsing(), cern::laser::test::TstConfiguration2::TstConfiguration2(), and cern::laser::guiplatform::user::UserBean::UserBean().

Configuration cern::laser::console::User::getDefaultConfiguration

(

)

throws LaserConsoleException, LaserConnectionException

Get the user's default configuration.

Returns:

the user console default configuration, null if not set.

Exceptions:

	LaserConsoleException	if the request could not be served.
	LaserConnectionException	if the console cannot connect to the BL

Implemented in cern::laser::console::impl::UserImpl.

Referenced by alma::alarmsystem::clients::CategoryClient::connect(), cern::laser::guiplatform::windows::login::AlarmConsoleLoginWindow::login(), cern::laser::test::TestConfigurationWindow::testConsoleConfigurationWindow(), and cern::laser::test::TestSelectionAndConfiguration::TestSelectionAndConfiguration().

String cern::laser::console::User::getDefaultPrinter

(

)

throws LaserConsoleException

Implemented in cern::laser::console::impl::UserImpl.

Referenced by cern::laser::guiplatform::printing::DefaultPrinterDialog::formWindowOpened(), cern::laser::guiplatform::printing::DefaultPrinterDialog::getDefaultPrinterName(), and cern::laser::test::junit::TestConsoleUser::testGetDefaultPrinter().

String cern::laser::console::User::getName

(

)

throws LaserConsoleException

Accessor method.

Returns:

the user name.

Exceptions:

LaserConsoleException

if the request could not be served.

Implemented in cern::laser::console::impl::UserImpl.

Referenced by cern::laser::guiplatform::util::AppRegister::getRegisteredUserName(), cern::laser::guiplatform::windows::user::UserExplorer::UserNodeManager::initChildrenMap(), cern::laser::guiplatform::windows::configuration::LoadConfigurationPanel::initComponents(), cern::laser::guiplatform::windows::login::AlarmConsoleLoginWindow::login(), com::cosylab::acs::alarm::AlarmUserTest::notestUserHandler(), cern::laser::guiplatform::actions::LogoutAction::performAction(), cern::laser::guiplatform::actions::configuration::ConfigurationSetAsDefaultAction::performAction(), cern::laser::test::TestConfigurationWindow::testConsoleConfigurationWindow(), cern::laser::test::TestSelectionAndConfiguration::TestSelectionAndConfiguration(), and cern::laser::guiplatform::user::UserBean::UserBean().

String cern::laser::console::User::getPassword

(

)

throws LaserConsoleException

Accessor method.

Returns:

the user password.

Exceptions:

LaserConsoleException

if the request could not be served.

Implemented in cern::laser::console::impl::UserImpl.

Referenced by cern::laser::guiplatform::windows::login::AlarmConsoleLoginWindow::login(), and com::cosylab::acs::alarm::AlarmUserTest::notestUserHandler().

boolean cern::laser::console::User::isDefaultConfiguration

(

String

name

)

throws LaserConsoleException

Check the user default configuration.

Parameters:

name

the configuration name.

Returns:

true if the configuration is the user's default, false otherwise

Exceptions:

LaserConsoleException

if the request could not be served.

Implemented in cern::laser::console::impl::UserImpl.

void cern::laser::console::User::removeConfiguration

(

String

name

)

throws LaserConsoleException

Remove a configuration for the user.

Parameters:

name

the name of the configuration to remove.

Exceptions:

	LaserConsoleException	if the request could not be served.
	LaserConfigurationNotFoundException	if the configuration does not exist.

Implemented in cern::laser::console::impl::UserImpl.

Referenced by cern::laser::guiplatform::windows::login::AlarmConsoleLoginWindow::login(), cern::laser::guiplatform::actions::configuration::ConfigurationDeleteAction::performAction(), cern::laser::test::TestConfigurationWindow::testConsoleConfigurationWindow(), and cern::laser::test::TestSelectionAndConfiguration::TestSelectionAndConfiguration().

void cern::laser::console::User::setDefaultConfiguration

(

String

name

)

throws LaserConsoleException

Set the user's default configuration.

Parameters:

name

the user's console new default configuration name.

Exceptions:

	LaserConsoleException	if the request could not be served.
	LaserConfigurationNotFoundException	if the configuration does not exist.

Implemented in cern::laser::console::impl::UserImpl.

Referenced by cern::laser::guiplatform::actions::configuration::ConfigurationSetAsDefaultAction::copyAndSetAsDefaultConfiguration(), cern::laser::guiplatform::windows::configuration::ConsoleConfigurationPanel::createConfiguration(), and cern::laser::guiplatform::actions::configuration::ConfigurationSetAsDefaultAction::performAction().

void cern::laser::console::User::setDefaultPrinter

(

String

newDefaultPrinter

)

throws LaserConsoleException

Implemented in cern::laser::console::impl::UserImpl.

Referenced by cern::laser::guiplatform::printing::DefaultPrinterDialog::saveButtonActionPerformed(), and cern::laser::test::junit::TestConsoleUser::testGetDefaultPrinter().

void cern::laser::console::User::setPassword

(

String

newPassword

)

throws LaserConsoleException

Accessor method.

Returns:

newPassword the user password.

Exceptions:

LaserConsoleException

if the request could not be served.

Implemented in cern::laser::console::impl::UserImpl.

Referenced by com::cosylab::acs::alarm::AlarmUserTest::notestUserHandler().

---

The documentation for this interface was generated from the following file:

• laser-console/src/cern/laser/console/User.java