cern.laser.console

Interface Configuration

All Known Implementing Classes:

ConfigurationImpl

public interface Configuration

The alarm console overall configuration. It defines the dynamic behaviour of an alarm console display, as well as the alarm category and filtering selection.

Author:

F.Calderini

See Also:

Selection, Behaviour

Method Summary

Modifier and Type	Method and Description
Behaviour	createBehaviour() Factory method.
CommentedAlarmMap	getAcknowledged() Get the acknowledged alarms.
java.lang.Boolean	getActiveListFont()
CommentedAlarmMap	getAutoHighlighted() Get the permanently highlighted alarms.
CommentedAlarmMap	getAutoKlaxoned() Get the permanently klaxoned alarms.
Behaviour	getBehaviour() Get the alarm console behaviour.
CommentedAlarmMap	getHighlighted() Get the highlighted alarms.
CommentedAlarmMap	getInhibited() Get the inhibited alarms.
CommentedAlarmMap	getMasked() Get the masked alarms.
java.lang.String	getName() Get the configuration name.
CommentedAlarmMap	getNewIndicator() Get the new alarms.
Selection	getSelection() Get the alarm selection.
boolean	isDefault() Check if the configuration is a default configuration.
void	setAcknowledged(CommentedAlarmMap newAcknowledged) Set the acknowledged alarms.
void	setActiveListFont(java.lang.Boolean isActiveListFont)
void	setAutoHighlighted(CommentedAlarmMap newAutoHighlighted) Set the permanently highlighted alarms.
void	setAutoKlaxoned(CommentedAlarmMap newAutoKlaxoned) Set the permanently klaxoned alarms.
void	setBehaviour(Behaviour newBehaviour) Set the alarm console behaviour.
void	setHighlighted(CommentedAlarmMap newHighlighted) Set the highlighted alarms.
void	setInhibited(CommentedAlarmMap newInhibited) Set the inhibited alarms.
void	setMasked(CommentedAlarmMap newMasked) Set the masked alarms.
void	setName(java.lang.String newName) Set the configuration name.
void	setNewIndicator(CommentedAlarmMap newNewIndicator) Set the new alarms.
void	setSelection(Selection newSelection) Set the alarm selection.

Method Detail

getName

java.lang.String getName()
                  throws LaserConsoleException

Get the configuration name.

Returns:

the configuration name.

Throws:

LaserConsoleException - if the request could not be served.

setName

void setName(java.lang.String newName)
      throws LaserConsoleException

Set the configuration name.

Parameters:

newName - the configuration name.

Throws:

LaserConsoleException - if the request could not be served.

isDefault

boolean isDefault()
           throws LaserConsoleException

Check if the configuration is a default configuration.

Returns:

true if it is a user's default configuration.

Throws:

LaserConsoleException - if the request could not be served.

getSelection

Selection getSelection()
                throws LaserConsoleException

Get the alarm selection.

Returns:

the alarm selection.

Throws:

LaserConsoleException - if the request could not be served.

setSelection

void setSelection(Selection newSelection)
           throws LaserConsoleException

Set the alarm selection.

Parameters:

newSelection - the alarm selection.

Throws:

LaserConsoleException - if the request could not be served.

createBehaviour

Behaviour createBehaviour()

Factory method.

Returns:

a new alarm console behaviour instance.

getBehaviour

Behaviour getBehaviour()
                throws LaserConsoleException

Get the alarm console behaviour.

Returns:

the alarm console behaviour.

Throws:

LaserConsoleException - if the request could not be served.

setBehaviour

void setBehaviour(Behaviour newBehaviour)
           throws LaserConsoleException

Set the alarm console behaviour.

Parameters:

newBehaviour - the alarm console behaviour.

Throws:

LaserConsoleException - if the request could not be served.

getMasked

CommentedAlarmMap getMasked()
                     throws LaserConsoleException

Get the masked alarms.

Returns:

the masked alarms.

Throws:

LaserConsoleException - if the request could not be served.

setMasked

void setMasked(CommentedAlarmMap newMasked)
        throws LaserConsoleException

Set the masked alarms.

Parameters:

newMasked - the masked alarms.

Throws:

LaserConsoleException - if the request could not be served.

getInhibited

CommentedAlarmMap getInhibited()
                        throws LaserConsoleException

Get the inhibited alarms.

Returns:

the inhibited alarms.

Throws:

LaserConsoleException - if the request could not be served.

setInhibited

void setInhibited(CommentedAlarmMap newInhibited)
           throws LaserConsoleException

Set the inhibited alarms.

Parameters:

newInhibited - the inhibited alarms.

Throws:

LaserConsoleException - if the request could not be served.

getHighlighted

CommentedAlarmMap getHighlighted()
                          throws LaserConsoleException

Get the highlighted alarms.

Returns:

the highlighted alarms.

Throws:

LaserConsoleException - if the request could not be served.

setHighlighted

void setHighlighted(CommentedAlarmMap newHighlighted)
             throws LaserConsoleException

Set the highlighted alarms.

Parameters:

newHighlighted - the highlighted alarms.

Throws:

LaserConsoleException - if the request could not be served.

getAutoHighlighted

CommentedAlarmMap getAutoHighlighted()
                              throws LaserConsoleException

Get the permanently highlighted alarms.

Returns:

the permanently highlighted alarms.

Throws:

LaserConsoleException - if the request could not be served.

setAutoHighlighted

void setAutoHighlighted(CommentedAlarmMap newAutoHighlighted)
                 throws LaserConsoleException

Set the permanently highlighted alarms.

Parameters:

newAutoHighlighted - the permanently highlighted alarms.

Throws:

LaserConsoleException - if the request could not be served.

getAutoKlaxoned

CommentedAlarmMap getAutoKlaxoned()
                           throws LaserConsoleException

Get the permanently klaxoned alarms.

Returns:

the permanently klaxoned alarms.

Throws:

LaserConsoleException - if the request could not be served.

setAutoKlaxoned

void setAutoKlaxoned(CommentedAlarmMap newAutoKlaxoned)
              throws LaserConsoleException

Set the permanently klaxoned alarms.

Parameters:

newAutoKlaxoned - the permanently klaxoned alarms.

Throws:

LaserConsoleException - if the request could not be served.

getAcknowledged

CommentedAlarmMap getAcknowledged()
                           throws LaserConsoleException

Get the acknowledged alarms.

Returns:

the acknowledged alarms.

Throws:

LaserConsoleException - if the request could not be served.

setAcknowledged

void setAcknowledged(CommentedAlarmMap newAcknowledged)
              throws LaserConsoleException

Set the acknowledged alarms.

Parameters:

newAcknowledged - the acknowledged alarms.

Throws:

LaserConsoleException - if the request could not be served.

getNewIndicator

CommentedAlarmMap getNewIndicator()
                           throws LaserConsoleException

Get the new alarms.

Returns:

the new alarms.

Throws:

LaserConsoleException - if the request could not be served.

setNewIndicator

void setNewIndicator(CommentedAlarmMap newNewIndicator)
              throws LaserConsoleException

Set the new alarms.

Parameters:

newAcknowledged - the new alarms.

Throws:

LaserConsoleException - if the request could not be served.

getActiveListFont

java.lang.Boolean getActiveListFont()
                             throws LaserConsoleException

Throws:

LaserConsoleException

setActiveListFont

void setActiveListFont(java.lang.Boolean isActiveListFont)
                throws LaserConsoleException

Throws:

LaserConsoleException