Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

cern::laser::definition::SourceDefinitionHandler Interface Reference

Inheritance diagram for cern::laser::definition::SourceDefinitionHandler:

Inheritance graph
[legend]
List of all members.

Public Member Functions

void createSource (SourceDefinition definition) throws LaserDefinitionException
void download (Writer xmlDefinitionsWriter) throws LaserDefinitionException
void removeSource (SourceDefinition definition) throws LaserDefinitionException
void updateSource (SourceDefinition 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 source definitions. A user can be responsible for one ore more sources and a source can be administered by one ore more user. Only the source administrators can update/remove its definition and create/update/remove alarm definitons for that source.
See also:
cern.laser.definition.AdminUser


Member Function Documentation

void cern::laser::definition::SourceDefinitionHandler::createSource SourceDefinition  definition  )  throws LaserDefinitionException
 

Create a new source definition.

Parameters:
definition the source 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::SourceDefinitionHandlerImpl.

void cern::laser::definition::SourceDefinitionHandler::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::SourceDefinitionHandlerImpl.

void cern::laser::definition::SourceDefinitionHandler::removeSource SourceDefinition  definition  )  throws LaserDefinitionException
 

Remove a source definition by its identifier.

Parameters:
definition the source identifier
Exceptions:
LaserDefinitionNotFoundException if the source 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::SourceDefinitionHandlerImpl.

void cern::laser::definition::SourceDefinitionHandler::updateSource SourceDefinition  definition  )  throws LaserDefinitionException
 

Update a source definition.

Parameters:
definition the new source definition
Exceptions:
LaserDefinitionNotFoundException if the source 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::SourceDefinitionHandlerImpl.

void cern::laser::definition::SourceDefinitionHandler::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::SourceDefinitionHandlerImpl.

void cern::laser::definition::SourceDefinitionHandler::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::SourceDefinitionHandlerImpl.


The documentation for this interface was generated from the following file:
Generated on Thu Apr 30 03:09:04 2009 for ACS Java API by doxygen 1.3.8