cern.laser.console

Interface User

All Known Implementing Classes:

UserImpl

public interface User

Alarm console user.

Author:

F.Calderini

See Also:

Configuration

Method Summary

Modifier and Type	Method and Description
Configuration	createConfiguration(Configuration configuration) Create a new alarm console configuration for the user using a given configuration.
Configuration	createConfiguration(java.lang.String name) Create a new alarm console configuration for the user.
Configuration	getConfiguration(java.lang.String name) Accessor method.
java.util.Collection	getConfigurations() Accessor method.
Configuration	getDefaultConfiguration() Get the user's default configuration.
java.lang.String	getDefaultPrinter()
java.lang.String	getName() Accessor method.
java.lang.String	getPassword() Accessor method.
boolean	isDefaultConfiguration(java.lang.String name) Check the user default configuration.
void	removeConfiguration(java.lang.String name) Remove a configuration for the user.
void	setDefaultConfiguration(java.lang.String name) Set the user's default configuration.
void	setDefaultPrinter(java.lang.String newDefaultPrinter)
void	setPassword(java.lang.String newPassword) Accessor method.

Method Detail

getName

java.lang.String getName()
                  throws LaserConsoleException

Accessor method.

Returns:

the user name.

Throws:

LaserConsoleException - if the request could not be served.

getPassword

java.lang.String getPassword()
                      throws LaserConsoleException

Accessor method.

Returns:

the user password.

Throws:

LaserConsoleException - if the request could not be served.

setPassword

void setPassword(java.lang.String newPassword)
          throws LaserConsoleException

Accessor method.

Throws:

LaserConsoleException - if the request could not be served.

getDefaultPrinter

java.lang.String getDefaultPrinter()
                            throws LaserConsoleException

Throws:

LaserConsoleException

setDefaultPrinter

void setDefaultPrinter(java.lang.String newDefaultPrinter)
                throws LaserConsoleException

Throws:

LaserConsoleException

getConfigurations

java.util.Collection getConfigurations()
                                throws LaserConsoleException,
                                       LaserConnectionException

Accessor method.

Returns:

the user console configurations.

Throws:

LaserConsoleException - if the request could not be served.

LaserConnectionException - if the console cannot connect to the BL

getConfiguration

Configuration getConfiguration(java.lang.String name)
                        throws LaserConsoleException,
                               LaserConnectionException

Accessor method.

Parameters:

name - the name of the configuration.

Returns:

the user console configuration.

Throws:

LaserConnectionException - if the console cannot connect to the BL

LaserConfigurationNotFoundException - if the configuration does not exist.

LaserConsoleException

createConfiguration

Configuration createConfiguration(java.lang.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.

Throws:

LaserConsoleException - if the request could not be served.

LaserConfigurationDuplicationException - if the configuration already exists.

createConfiguration

Configuration 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.

Throws:

LaserConsoleException - if the request could not be served.

LaserConfigurationDuplicationException - if the configuration already exists.

removeConfiguration

void removeConfiguration(java.lang.String name)
                  throws LaserConsoleException

Remove a configuration for the user.

Parameters:

name - the name of the configuration to remove.

Throws:

LaserConsoleException - if the request could not be served.

LaserConfigurationNotFoundException - if the configuration does not exist.

getDefaultConfiguration

Configuration getDefaultConfiguration()
                               throws LaserConsoleException,
                                      LaserConnectionException

Get the user's default configuration.

Returns:

the user console default configuration, null if not set.

Throws:

LaserConsoleException - if the request could not be served.

LaserConnectionException - if the console cannot connect to the BL

setDefaultConfiguration

void setDefaultConfiguration(java.lang.String name)
                      throws LaserConsoleException

Set the user's default configuration.

Parameters:

name - the user's console new default configuration name.

Throws:

LaserConsoleException - if the request could not be served.

LaserConfigurationNotFoundException - if the configuration does not exist.

isDefaultConfiguration

boolean isDefaultConfiguration(java.lang.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

Throws:

LaserConsoleException - if the request could not be served.