Public Member Functions

cern.laser.definition.ReductionMaskDefinitionHandler Interface Reference

Inheritance diagram for cern.laser.definition.ReductionMaskDefinitionHandler:
cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl

List of all members.

Public Member Functions

void setMultiplicityThreshold (MultiplicityThreshold threshold) throws LaserDefinitionException
void addMaintenanceMask (AlarmDefinition alarm, MaintenanceMask maintenance) throws LaserDefinitionException
void addModeMask (AlarmDefinition alarm, ModeMask mode) throws LaserDefinitionException
void createMultiplicityLink (ReductionLink link) throws LaserDefinitionException
void createNodeLink (ReductionLink link) throws LaserDefinitionException
void download (Writer xmlDefinitionsWriter) throws LaserDefinitionException
void removeMaintenanceMask (AlarmDefinition alarm, MaintenanceMask maintenance) throws LaserDefinitionException
void removeModeMask (AlarmDefinition alarm, ModeMask mode) throws LaserDefinitionException
void removeMultiplicityLink (ReductionLink link) throws LaserDefinitionException
void removeNodeLink (ReductionLink link) throws LaserDefinitionException
void uploadNode (Collection toBeCreated, Collection toBeRemoved) throws LaserDefinitionException
void uploadMultiplicity (Collection toBeCreated, Collection toBeRemoved, Collection thresholds) throws LaserDefinitionException
void uploadMaintenance (Collection toBeCreated, Collection toBeRemoved) throws LaserDefinitionException
void uploadMode (Collection toBeCreated, Collection toBeRemoved) throws LaserDefinitionException
void uploadReduction (Reader xmlDefinitionsReader) throws LaserDefinitionException
void uploadMask (Reader xmlDefinitionsReader) throws LaserDefinitionException

Detailed Description

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:
cern.laser.definition.AdminUser

Member Function Documentation

void cern.laser.definition.ReductionMaskDefinitionHandler.addMaintenanceMask ( AlarmDefinition  alarm,
MaintenanceMask  maintenance 
) throws LaserDefinitionException

Add a new maintenance mask definition.

Parameters:
alarm the alarm
maintenance the maintenance mask
Exceptions:
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

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.addModeMask ( AlarmDefinition  alarm,
ModeMask  mode 
) throws LaserDefinitionException

Add a new mode mask definition.

Parameters:
alarm the alarm
mode the mode mask
Exceptions:
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

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.createMultiplicityLink ( ReductionLink  link  )  throws LaserDefinitionException

Create a new multiplicity reduction link definition.

Parameters:
link the reduction link definition
Exceptions:
LaserDefinitionNotValidException if the definition failed validation
LaserDefinitionNotAllowedException if the user is not allowed
LaserDefinitionException if the request can not be served

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.createNodeLink ( ReductionLink  link  )  throws LaserDefinitionException

Create a new node reduction link definition.

Parameters:
link the reduction link definition
Exceptions:
LaserDefinitionNotValidException if the definition failed validation
LaserDefinitionNotAllowedException if the user is not allowed
LaserDefinitionException if the request can not be served

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.download ( Writer  xmlDefinitionsWriter  )  throws LaserDefinitionException

Dump the user definitions in XML format.

Parameters:
xmlDefinitionsWriter the XML definitions writer
Exceptions:
LaserDefinitionXMLException if the XML marshalling failed
LaserDefinitionException if the request can not be served

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.removeMaintenanceMask ( AlarmDefinition  alarm,
MaintenanceMask  maintenance 
) throws LaserDefinitionException

Remove a maintenance mask definition.

Parameters:
alarm the alarm
maintenance the maintenance mask
Exceptions:
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

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.removeModeMask ( AlarmDefinition  alarm,
ModeMask  mode 
) throws LaserDefinitionException

Remove a mode mask definition.

Parameters:
alarm the alarm
mode the mode mask
Exceptions:
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

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.removeMultiplicityLink ( ReductionLink  link  )  throws LaserDefinitionException

Remove a multiplicity link definition.

Parameters:
link the reduction link definition
Exceptions:
LaserDefinitionNotValidException if the definition failed validation
LaserDefinitionNotAllowedException if the user is not allowed
LaserDefinitionException if the request can not be served

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.removeNodeLink ( ReductionLink  link  )  throws LaserDefinitionException

Remove a node reduction link definition.

Parameters:
link the reduction link definition
Exceptions:
LaserDefinitionNotValidException if the definition failed validation
LaserDefinitionNotAllowedException if the user is not allowed
LaserDefinitionException if the request can not be served

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.setMultiplicityThreshold ( MultiplicityThreshold  threshold  )  throws LaserDefinitionException

Set a multiplicity node threshold.

Parameters:
threshold the multiplicity threshold
Exceptions:
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

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.uploadMaintenance ( Collection  toBeCreated,
Collection  toBeRemoved 
) throws LaserDefinitionException

Execute a bulk update within one single transaction.

Parameters:
toBeCreated the definitions to create
toBeRemoved the definitions to remove
Exceptions:
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

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.uploadMask ( Reader  xmlDefinitionsReader  )  throws LaserDefinitionException

Execute a bulk update within one single transaction.

Parameters:
xmlDefinitionsReader the XML definitions reader
Exceptions:
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

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.uploadMode ( Collection  toBeCreated,
Collection  toBeRemoved 
) throws LaserDefinitionException

Execute a bulk update within one single transaction.

Parameters:
toBeCreated the definitions to create
toBeRemoved the definitions to remove
Exceptions:
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

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.uploadMultiplicity ( Collection  toBeCreated,
Collection  toBeRemoved,
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
Exceptions:
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

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.uploadNode ( Collection  toBeCreated,
Collection  toBeRemoved 
) throws LaserDefinitionException

Execute a bulk update within one single transaction.

Parameters:
toBeCreated the definitions to create
toBeRemoved the definitions to remove
Exceptions:
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

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.

void cern.laser.definition.ReductionMaskDefinitionHandler.uploadReduction ( Reader  xmlDefinitionsReader  )  throws LaserDefinitionException

Execute a bulk update within one single transaction.

Parameters:
xmlDefinitionsReader the XML definitions reader
Exceptions:
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

Implemented in cern.laser.definition.impl.ReductionMaskDefinitionHandlerImpl.


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