cern.laser.definition

Interface CategoryLinkDefinitionHandler

All Known Implementing Classes:

CategoryLinkDefinitionHandlerImpl

public interface CategoryLinkDefinitionHandler

Provides the service to handle the alarms by category grouping. Alarm category grouping can be performed from any admin user on any alarm and on any category. The only constraint is that a category has to be linked to all of the alarms involved in a reduction grouping.

See Also:

AdminUser

Method Summary

Modifier and Type	Method and Description
void	createCategoryLink(CategoryLink link) Create a new alarm-category link.
void	download(java.io.Writer xmlDefinitionsWriter) Dump the user definitions in XML format.
void	removeCategoryLink(CategoryLink link) Remove an alarm-category link.
void	upload(java.util.Collection toBeCreated, java.util.Collection toBeRemoved) Execute a bulk update within one single transaction.
void	upload(java.io.Reader xmlDefinitionsReader) Execute a bulk update within one single transaction.

Method Detail

createCategoryLink

void createCategoryLink(CategoryLink link)
                 throws LaserDefinitionException

Create a new alarm-category link.

Parameters:

link - the alarm-category link

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

removeCategoryLink

void removeCategoryLink(CategoryLink link)
                 throws LaserDefinitionException

Remove an alarm-category link.

Parameters:

link - the alarm-category link

Throws:

LaserDefinitionNotValidException - if the definition failed validation

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionException - if the request can not be served

upload

void upload(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

upload

void upload(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