Package net.anotheria.anodoc.service

Interface IModuleService

All Known Implementing Classes:

ModuleServiceImpl

public interface IModuleService

This interface describes the locally available service for Module management.
It provides functions for configuration of itself and for data access/storage.

Version:

$Id: $Id

Author:

another

Method Summary

Modifier and Type	Method	Description
void	addModuleListener(java.lang.String moduleId, java.lang.String ownerId, IModuleListener aModuleListeners)	Adds listener for module.
void	attachModuleFactory(java.lang.String moduleId, IModuleFactory factory)	Attaches a factory for a given moduleId.
void	attachModuleStorage(java.lang.String moduleId, IModuleStorage storage)	Attaches a storage for a given moduleId.
void	deleteModule(java.lang.String ownerId, java.lang.String moduleId)	Deletes the module identified by the tuple (ownerId | moduleId) from the appropriate storage.
void	deleteModule(java.lang.String ownerId, java.lang.String moduleId, java.lang.String copyId)	Deletes the module identified by the tuple (ownerId | moduleId | copyId) from the appropriate storage.
void	deleteModule(Module module)	Deletes the given module from the appropriate storage.
Module	getModule(java.lang.String ownerId, java.lang.String moduleId)	getModule.
Module	getModule(java.lang.String ownerId, java.lang.String moduleId, boolean create)	getModule.
Module	getModule(java.lang.String ownerId, java.lang.String moduleId, java.lang.String copyId)	Same as return getModule(ownerId, moduleId, copyId, false); in current implementation.
Module	getModule(java.lang.String ownerId, java.lang.String moduleId, java.lang.String copyId, boolean create)	This function retrieves the appropriate Module from the storage and returns it.
void	removeModuleListener(java.lang.String moduleId, java.lang.String ownerId)	Removes listener for module.
void	storeModule(Module module)	Stores the given module in the appropriate storage.

Method Detail

getModule

Module getModule(java.lang.String ownerId,
                 java.lang.String moduleId,
                 java.lang.String copyId,
                 boolean create)
          throws NoStorageForModuleException,
                 NoFactoryForModuleException,
                 NoStoredModuleEntityException,
                 StorageFailureException

This function retrieves the appropriate Module from the storage and returns it. If the create flag is set, and no module instance is available (NoStoredModuleEntityException) a new Module instance will be created by the previously attached Factory and returned.

Parameters:

ownerId - the id of the owner of this module.

moduleId - the id of the module

copyId - the copy id.

create - if true and the module doesn't exists yet, it will be created.

Returns:

retrieved Module

Throws:

NoStorageForModuleException - if any.

NoFactoryForModuleException - if any.

NoStoredModuleEntityException - if any.

StorageFailureException - if any.

getModule

Module getModule(java.lang.String ownerId,
                 java.lang.String moduleId,
                 boolean create)
          throws NoStorageForModuleException,
                 NoFactoryForModuleException,
                 NoStoredModuleEntityException,
                 StorageFailureException

getModule.

Parameters:

ownerId - a String object.

moduleId - a String object.

create - a boolean.

Returns:

a Module object.

Throws:

NoStorageForModuleException - if any.

NoFactoryForModuleException - if any.

NoStoredModuleEntityException - if any.

StorageFailureException - if any.

getModule

Module getModule(java.lang.String ownerId,
                 java.lang.String moduleId)
          throws NoStorageForModuleException,
                 NoFactoryForModuleException,
                 NoStoredModuleEntityException,
                 StorageFailureException

getModule.

Parameters:

ownerId - a String object.

moduleId - a String object.

Returns:

a Module object.

Throws:

NoStorageForModuleException - if any.

NoFactoryForModuleException - if any.

NoStoredModuleEntityException - if any.

StorageFailureException - if any.

getModule

Module getModule(java.lang.String ownerId,
                 java.lang.String moduleId,
                 java.lang.String copyId)
          throws NoStorageForModuleException,
                 NoFactoryForModuleException,
                 NoStoredModuleEntityException,
                 StorageFailureException

Same as return getModule(ownerId, moduleId, copyId, false); in current implementation.

Parameters:

ownerId - a String object.

moduleId - a String object.

copyId - a String object.

Returns:

a Module object.

Throws:

NoStorageForModuleException - if any.

NoFactoryForModuleException - if any.

NoStoredModuleEntityException - if any.

StorageFailureException - if any.

storeModule

void storeModule(Module module)
          throws NoStorageForModuleException,
                 StorageFailureException

Stores the given module in the appropriate storage.

Parameters:

module - the module to store.

Throws:

NoStorageForModuleException - thrown if no storage for this moduleId is attached.

StorageFailureException - thrown if the storage failed.

attachModuleFactory

void attachModuleFactory(java.lang.String moduleId,
                         IModuleFactory factory)

Attaches a factory for a given moduleId.

Parameters:

moduleId - a String object.

factory - a IModuleFactory object.

attachModuleStorage

void attachModuleStorage(java.lang.String moduleId,
                         IModuleStorage storage)

Attaches a storage for a given moduleId.

Parameters:

moduleId - a String object.

storage - a IModuleStorage object.

deleteModule

void deleteModule(Module module)
           throws NoStorageForModuleException,
                  StorageFailureException

Deletes the given module from the appropriate storage.

Parameters:

module - a Module object.

Throws:

NoStorageForModuleException - if any.

StorageFailureException - if any.

deleteModule

void deleteModule(java.lang.String ownerId,
                  java.lang.String moduleId,
                  java.lang.String copyId)
           throws NoStorageForModuleException,
                  StorageFailureException

Deletes the module identified by the tuple (ownerId | moduleId | copyId) from the appropriate storage.

Parameters:

ownerId - a String object.

moduleId - a String object.

copyId - a String object.

Throws:

NoStorageForModuleException - if any.

StorageFailureException - if any.

deleteModule

void deleteModule(java.lang.String ownerId,
                  java.lang.String moduleId)
           throws NoStorageForModuleException,
                  StorageFailureException

Deletes the module identified by the tuple (ownerId | moduleId) from the appropriate storage. The copy id is assumed to be the standart copyId.

Parameters:

ownerId - a String object.

moduleId - a String object.

Throws:

NoStorageForModuleException - if any.

StorageFailureException - if any.

addModuleListener

void addModuleListener(java.lang.String moduleId,
                       java.lang.String ownerId,
                       IModuleListener aModuleListeners)

Adds listener for module.

Parameters:

moduleId - module id of module.

ownerId - owner id of module.

aModuleListeners - listener to add.

removeModuleListener

void removeModuleListener(java.lang.String moduleId,
                          java.lang.String ownerId)

Removes listener for module.

Parameters:

moduleId - id of module.

ownerId - owner id for module.