cern::laser::definition::AlarmDefinitionHandler Interface Reference

Inheritance diagram for cern::laser::definition::AlarmDefinitionHandler:

[legend]List of all members.

Public Member Functions
void	createAlarm (AlarmDefinition definition) throws LaserDefinitionException
void	download (Writer xmlDefinitionsWriter) throws LaserDefinitionException
void	removeAlarm (AlarmDefinition definition) throws LaserDefinitionException
void	updateAlarm (AlarmDefinition definition) throws LaserDefinitionException
void	upload (Collection toBeCreated, Collection toBeUpdated, Collection toBeRemoved) throws LaserDefinitionException
void	upload (Reader xmlDefinitionsReader) throws LaserDefinitionException

---

Detailed Description

Provides the service to handle alarm definitions. Alarm definitions are partitioned with respect to alarm sources. Alarm definition handling permissions inherit from the respective source permissions.

See also:

cern.laser.definition.AdminUser

---

Member Function Documentation

void cern::laser::definition::AlarmDefinitionHandler::createAlarm (  AlarmDefinition  definition  )  throws LaserDefinitionException

Create a new alarm definition. Parameters: definition  the alarm 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::AlarmDefinitionHandlerImpl.

void cern::laser::definition::AlarmDefinitionHandler::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::AlarmDefinitionHandlerImpl.

void cern::laser::definition::AlarmDefinitionHandler::removeAlarm (  AlarmDefinition  definition  )  throws LaserDefinitionException

Remove an alarm definition by its identifier. Parameters: definition  the alarm definition Exceptions: LaserDefinitionNotFoundException  if the alarm 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::AlarmDefinitionHandlerImpl.

void cern::laser::definition::AlarmDefinitionHandler::updateAlarm (  AlarmDefinition  definition  )  throws LaserDefinitionException

Update an alarm definition. Parameters: definition  the new alarm definition Exceptions: LaserDefinitionNotFoundException  if the alarm definition was not found 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::AlarmDefinitionHandlerImpl.

void cern::laser::definition::AlarmDefinitionHandler::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::AlarmDefinitionHandlerImpl.

void cern::laser::definition::AlarmDefinitionHandler::upload (  Collection  toBeCreated, Collection  toBeUpdated, Collection  toBeRemoved )  throws LaserDefinitionException

Execute a bulk update within one single transaction. Parameters: toBeCreated  the definitions to create toBeUpdated  the definitions to update 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::AlarmDefinitionHandlerImpl.

---

The documentation for this interface was generated from the following file:

• AlarmDefinitionHandler.java

---