Public Member Functions

cern.laser.console.User Interface Reference

Inheritance diagram for cern.laser.console.User:
cern.laser.console.impl.UserImpl

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

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

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.

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().

String cern.laser.console.User.getDefaultPrinter (  )  throws LaserConsoleException
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.

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.

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.

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.

void cern.laser.console.User.setDefaultPrinter ( String  newDefaultPrinter  )  throws LaserConsoleException
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.


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