cern.laser.definition

Interface CategoryDefinitionHandler

All Known Implementing Classes:

CategoryDefinitionHandlerImpl

public interface CategoryDefinitionHandler

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:

AdminUser

Method Summary

Modifier and Type	Method and Description
void	createCategory(CategoryDefinition definition) Create a new category definition.
void	download(java.io.Writer xmlDefinitionsWriter) Dump the user definitions in XML format.
void	removeCategory(CategoryDefinition definition) Remove an category definition by its identifier.
void	updateCategory(CategoryDefinition definition) Update a category definition.
void	upload(java.util.Collection toBeCreated, java.util.Collection toBeUpdated, 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

createCategory

void createCategory(CategoryDefinition definition)
             throws LaserDefinitionException

Create a new category definition.

Parameters:

definition - the category definition

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

removeCategory

void removeCategory(CategoryDefinition definition)
             throws LaserDefinitionException

Remove an category definition by its identifier.

Parameters:

definition - the category definition

Throws:

LaserDefinitionNotFoundException - if the category definition was not found

LaserDefinitionNotAllowedException - if the user is not allowed

LaserDefinitionException - if the request can not be served

updateCategory

void updateCategory(CategoryDefinition definition)
             throws LaserDefinitionException

Update a category definition.

Parameters:

definition - the new category definition

Throws:

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

upload

void upload(java.util.Collection toBeCreated,
            java.util.Collection toBeUpdated,
            java.util.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

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