Public Member Functions

cern.laser.definition.CategoryLinkDefinitionHandler Interface Reference

Inheritance diagram for cern.laser.definition.CategoryLinkDefinitionHandler:
cern.laser.definition.impl.CategoryLinkDefinitionHandlerImpl

List of all members.

Public Member Functions

void createCategoryLink (CategoryLink link) throws LaserDefinitionException
void download (Writer xmlDefinitionsWriter) throws LaserDefinitionException
void removeCategoryLink (CategoryLink link) throws LaserDefinitionException
void upload (Collection toBeCreated, Collection toBeRemoved) throws LaserDefinitionException
void upload (Reader xmlDefinitionsReader) throws LaserDefinitionException

Detailed Description

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

Member Function Documentation

void cern.laser.definition.CategoryLinkDefinitionHandler.createCategoryLink ( CategoryLink  link  )  throws LaserDefinitionException

Create a new alarm-category link.

Parameters:
link the alarm-category link
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.CategoryLinkDefinitionHandlerImpl.

void cern.laser.definition.CategoryLinkDefinitionHandler.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.CategoryLinkDefinitionHandlerImpl.

void cern.laser.definition.CategoryLinkDefinitionHandler.removeCategoryLink ( CategoryLink  link  )  throws LaserDefinitionException

Remove an alarm-category link.

Parameters:
link the alarm-category link
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.CategoryLinkDefinitionHandlerImpl.

void cern.laser.definition.CategoryLinkDefinitionHandler.upload ( 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.CategoryLinkDefinitionHandlerImpl.

void cern.laser.definition.CategoryLinkDefinitionHandler.upload ( 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.CategoryLinkDefinitionHandlerImpl.


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