cern.laser.definition

Interface ReductionMaskDefinitionHandler

All Known Implementing Classes:

ReductionMaskDefinitionHandlerImpl

public interface ReductionMaskDefinitionHandler

Provides the service to handle alarm reduction/mask definitions. Reduction relationships are not partitioned with respect to the administrative users. For mask definitions, the relative alarm permissions apply. The only constraint that applies to reduction links definition is that all the involved alarms have to be linked to the same set of categories.

See Also:

AdminUser

Method Summary

Modifier and Type	Method and Description
void	addMaintenanceMask(AlarmDefinition alarm, MaintenanceMask maintenance) Add a new maintenance mask definition.
void	addModeMask(AlarmDefinition alarm, ModeMask mode) Add a new mode mask definition.
void	createMultiplicityLink(ReductionLink link) Create a new multiplicity reduction link definition.
void	createNodeLink(ReductionLink link) Create a new node reduction link definition.
void	download(java.io.Writer xmlDefinitionsWriter) Dump the user definitions in XML format.
void	removeMaintenanceMask(AlarmDefinition alarm, MaintenanceMask maintenance) Remove a maintenance mask definition.
void	removeModeMask(AlarmDefinition alarm, ModeMask mode) Remove a mode mask definition.
void	removeMultiplicityLink(ReductionLink link) Remove a multiplicity link definition.
void	removeNodeLink(ReductionLink link) Remove a node reduction link definition.
void	setMultiplicityThreshold(MultiplicityThreshold threshold) Set a multiplicity node threshold.
void	uploadMaintenance(java.util.Collection toBeCreated, java.util.Collection toBeRemoved) Execute a bulk update within one single transaction.
void	uploadMask(java.io.Reader xmlDefinitionsReader) Execute a bulk update within one single transaction.
void	uploadMode(java.util.Collection toBeCreated, java.util.Collection toBeRemoved) Execute a bulk update within one single transaction.
void	uploadMultiplicity(java.util.Collection toBeCreated, java.util.Collection toBeRemoved, java.util.Collection thresholds) Execute a bulk update within one single transaction.
void	uploadNode(java.util.Collection toBeCreated, java.util.Collection toBeRemoved) Execute a bulk update within one single transaction.
void	uploadReduction(java.io.Reader xmlDefinitionsReader) Execute a bulk update within one single transaction.

Method Detail

setMultiplicityThreshold

void setMultiplicityThreshold(MultiplicityThreshold threshold)
                       throws LaserDefinitionException

Set a multiplicity node threshold.

Parameters:

threshold - the multiplicity threshold

Throws:

LaserDefinitionNotValidException - if the threshold failed validation

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionNotFoundException - if the alarm definition is not found

LaserDefinitionException - if the request can not be served

addMaintenanceMask

void addMaintenanceMask(AlarmDefinition alarm,
                        MaintenanceMask maintenance)
                 throws LaserDefinitionException

Add a new maintenance mask definition.

Parameters:

alarm - the alarm

maintenance - the maintenance mask

Throws:

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionNotFoundException - if the alarm definition is not found

LaserDefinitionException - if the request can not be served

addModeMask

void addModeMask(AlarmDefinition alarm,
                 ModeMask mode)
          throws LaserDefinitionException

Add a new mode mask definition.

Parameters:

alarm - the alarm

mode - the mode mask

Throws:

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionNotFoundException - if the alarm definition is not found

LaserDefinitionException - if the request can not be served

createMultiplicityLink

void createMultiplicityLink(ReductionLink link)
                     throws LaserDefinitionException

Create a new multiplicity reduction link definition.

Parameters:

link - the reduction link definition

Throws:

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionException - if the request can not be served

createNodeLink

void createNodeLink(ReductionLink link)
             throws LaserDefinitionException

Create a new node reduction link definition.

Parameters:

link - the reduction link definition

Throws:

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionException - if the request can not be served

download

void download(java.io.Writer xmlDefinitionsWriter)
       throws LaserDefinitionException

Dump the user definitions in XML format.

Parameters:

xmlDefinitionsWriter - the XML definitions writer

Throws:

LaserDefinitionXMLException - if the XML marshalling failed

LaserDefinitionException - if the request can not be served

removeMaintenanceMask

void removeMaintenanceMask(AlarmDefinition alarm,
                           MaintenanceMask maintenance)
                    throws LaserDefinitionException

Remove a maintenance mask definition.

Parameters:

alarm - the alarm

maintenance - the maintenance mask

Throws:

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionNotFoundException - if the alarm definition is not found

LaserDefinitionException - if the request can not be served

removeModeMask

void removeModeMask(AlarmDefinition alarm,
                    ModeMask mode)
             throws LaserDefinitionException

Remove a mode mask definition.

Parameters:

alarm - the alarm

mode - the mode mask

Throws:

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionNotFoundException - if the alarm definition is not found

LaserDefinitionException - if the request can not be served

removeMultiplicityLink

void removeMultiplicityLink(ReductionLink link)
                     throws LaserDefinitionException

Remove a multiplicity link definition.

Parameters:

link - the reduction link definition

Throws:

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionException - if the request can not be served

removeNodeLink

void removeNodeLink(ReductionLink link)
             throws LaserDefinitionException

Remove a node reduction link definition.

Parameters:

link - the reduction link definition

Throws:

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionException - if the request can not be served

uploadNode

void uploadNode(java.util.Collection toBeCreated,
                java.util.Collection toBeRemoved)
         throws LaserDefinitionException

Execute a bulk update within one single transaction.

Parameters:

toBeCreated - the definitions to create

toBeRemoved - the definitions to remove

Throws:

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotFoundException - if the definition was not found

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionException - if the request can not be served

uploadMultiplicity

void uploadMultiplicity(java.util.Collection toBeCreated,
                        java.util.Collection toBeRemoved,
                        java.util.Collection thresholds)
                 throws LaserDefinitionException

Execute a bulk update within one single transaction.

Parameters:

toBeCreated - the definitions to create

toBeRemoved - the definitions to remove

thresholds - the multiplicity thresholds

Throws:

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotFoundException - if the definition was not found

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionException - if the request can not be served

uploadMaintenance

void uploadMaintenance(java.util.Collection toBeCreated,
                       java.util.Collection toBeRemoved)
                throws LaserDefinitionException

Execute a bulk update within one single transaction.

Parameters:

toBeCreated - the definitions to create

toBeRemoved - the definitions to remove

Throws:

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotFoundException - if the definition was not found

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionException - if the request can not be served

uploadMode

void uploadMode(java.util.Collection toBeCreated,
                java.util.Collection toBeRemoved)
         throws LaserDefinitionException

Execute a bulk update within one single transaction.

Parameters:

toBeCreated - the definitions to create

toBeRemoved - the definitions to remove

Throws:

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotFoundException - if the definition was not found

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionException - if the request can not be served

uploadReduction

void uploadReduction(java.io.Reader xmlDefinitionsReader)
              throws LaserDefinitionException

Execute a bulk update within one single transaction.

Parameters:

xmlDefinitionsReader - the XML definitions reader

Throws:

LaserDefinitionXMLException - if the XML unmarshalling failed

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotFoundException - if the definition was not found

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionException - if the request can not be served

uploadMask

void uploadMask(java.io.Reader xmlDefinitionsReader)
         throws LaserDefinitionException

Execute a bulk update within one single transaction.

Parameters:

xmlDefinitionsReader - the XML definitions reader

Throws:

LaserDefinitionXMLException - if the XML unmarshalling failed

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotFoundException - if the definition was not found

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionException - if the request can not be served