org.alfresco.service.cmr.module

Interface ModuleService

All Known Implementing Classes:

ModuleServiceImpl

public interface ModuleService

A service to control and provide information about the currently-installed modules.

Since:

2.0

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List	getAllModules() Gets a list of all the modules currently installed.
ModuleDetails	getModule(java.lang.String moduleId) Gets the module details for a given module id.
void	registerComponent(ModuleComponent component) Register a component of a module for execution.
void	startModules() Start all the modules.

Method Detail

getModule

ModuleDetails getModule(java.lang.String moduleId)

Gets the module details for a given module id. If the module does not exist or is not installed then null is returned.

Parameters:

moduleId - a module id

Returns:

the module details

getAllModules

java.util.List getAllModules()

Gets a list of all the modules currently installed.

Returns:

module details of the currently installed modules.

registerComponent

void registerComponent(ModuleComponent component)

Register a component of a module for execution.

Parameters:

component - the module component.

startModules

void startModules()

Start all the modules. For transaction purposes, each module should be regarded as a self-contained unit and started in its own transaction. Where inter-module dependencies exist, these will be pulled into the transaction.