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

cern::laser::definition::CategoryDefinitionHandler Interface Reference

Inheritance diagram for cern::laser::definition::CategoryDefinitionHandler:

Inheritance graph
[legend]
List of all members.

Public Member Functions

void createCategory (CategoryDefinition definition) throws LaserDefinitionException
void download (Writer xmlDefinitionsWriter) throws LaserDefinitionException
void removeCategory (CategoryDefinition definition) throws LaserDefinitionException
void updateCategory (CategoryDefinition 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 category definitions. Category definitions are organized in trees with a common root. A user can be responsible for one ore more subtrees and a subtree can be administered by one ore more user.
See also:
cern.laser.definition.AdminUser


Member Function Documentation

void cern::laser::definition::CategoryDefinitionHandler::createCategory CategoryDefinition  definition  )  throws LaserDefinitionException
 

Create a new category definition.

Parameters:
definition the category 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::CategoryDefinitionHandlerImpl.

void cern::laser::definition::CategoryDefinitionHandler::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::CategoryDefinitionHandlerImpl.

void cern::laser::definition::CategoryDefinitionHandler::removeCategory CategoryDefinition  definition  )  throws LaserDefinitionException
 

Remove an category definition by its identifier.

Parameters:
definition the category definition
Exceptions:
LaserDefinitionNotFoundException if the category 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::CategoryDefinitionHandlerImpl.

void cern::laser::definition::CategoryDefinitionHandler::updateCategory CategoryDefinition  definition  )  throws LaserDefinitionException
 

Update a category definition.

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

void cern::laser::definition::CategoryDefinitionHandler::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::CategoryDefinitionHandlerImpl.

void cern::laser::definition::CategoryDefinitionHandler::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::CategoryDefinitionHandlerImpl.


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