Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.alfresco.service.cmr.module
Interface ModuleService

@org.alfresco.api.AlfrescoPublicApi
public interface ModuleService
A service to control and provide information about the currently-installed modules.
Since:
2.0
Author:
Roy Wetherall, Derek Hulley

Method Summary
getAllModules()
          Gets a list of all the modules currently installed.
getMissingModules()
          Gets a list of the modules missing from the system.
getModule(String moduleId)
          Gets the module details for a given module id.
void
registerComponent(ModuleComponent component)
          Register a component of a module for execution.
void
shutdownModules()
void
startModules()
          Start all the modules.
Method Detail
getModule
ModuleDetails getModule(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
List<ModuleDetailsgetAllModules()
Gets a list of all the modules currently installed.
Returns:
module details of the currently installed modules.

getMissingModules
List<ModuleDetailsgetMissingModules()
Gets a list of the modules missing from the system.
Returns:
module details of the modules missing from the system.

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.

shutdownModules
void shutdownModules()

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005–2018 Alfresco Software. All rights reserved.

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.