Uses of Class
org.opencms.module.CmsModule

Packages that use CmsModule

Package	Description
org.opencms.module	OpenCms modules provide a powerful, standardized way to extend the core OpenCms functionality.
org.opencms.ui.apps.dbmanager	Contains classes of the cache admin app.
org.opencms.ui.apps.modules	Contains classes of the module manager app.
org.opencms.ui.apps.modules.edit	Contains classes of the module manager app used to edit modules.
org.opencms.workplace	The base classes for the OpenCms Workplace (standard dialog, tab dialog, report based dialog) and the Workplace configuration classes are located here.

Uses of CmsModule in org.opencms.module

Methods in org.opencms.module that return CmsModule

Modifier and Type	Method	Description
CmsModule	CmsModule.clone()	Clones a CmsModule which is not set to frozen.
CmsModule	CmsModuleImportData.getModule()	Gets the module metadata from the import zip.
CmsModule	CmsModuleManager.getModule(String name)	Returns the module with the given module name, or null if no module with the given name is configured.
CmsModule	CmsModuleXmlHandler.getModule()	Returns the generated module.
CmsModule	CmsReplaceModuleInfo.getModule()	Gets the module.
static CmsModule	CmsModuleImportExportHandler.readModuleFromImport(String importResource)	Reads a module object from an external file source.
static CmsModule	CmsModuleImportExportHandler.readModuleFromManifest(byte[] manifest)	Reads a module object from an external file source.

Methods in org.opencms.module that return types with arguments of type CmsModule

Modifier and Type	Method	Description
List<CmsModule>	CmsModuleManager.getAllInstalledModules()	Returns a list of installed modules.
static Map<CmsModule,String>	CmsModuleManager.getAllModulesFromPath(String rfsAbsPath)	Returns a map of modules found in the given RFS absolute path.

Methods in org.opencms.module with parameters of type CmsModule

Modifier and Type	Method	Description
void	CmsModuleManager.addModule(CmsObject cms, CmsModule module)	Adds a new module to the module manager.
static List<String>	CmsModule.calculateModuleResourceNames(CmsObject cms, CmsModule module)	Calculates the resources belonging to the module, taking excluded resources and readability of resources into account, and returns site paths of the module resources.
static List<CmsResource>	CmsModule.calculateModuleResources(CmsObject cms, CmsModule module)	Calculates and returns the resources belonging to the module, taking excluded resources and readability of resources into account.
static boolean	CmsModuleUpdater.checkCompatibleModuleResources(CmsModule installedModule, CmsModule newModule)	Checks whether the module resources and sites of the two module versions are suitable for updating.
List<CmsModuleDependency>	CmsModuleManager.checkDependencies(CmsModule module, int mode)	Checks if a modules dependencies are fulfilled.
CmsModuleDependency	CmsModule.checkDependency(CmsModule module)	Checks if this module depends on another given module, will return the dependency, or null if no dependency was found.
int	CmsModule.compareTo(CmsModule obj)
protected CmsProject	CmsModuleUpdater.createAndSetModuleImportProject(CmsObject cms, CmsModule module)	Creates the project used to import module resources and sets it on the CmsObject.
protected void	CmsModuleUpdater.deleteConflictingResources(CmsObject cms, CmsModule module, Map<CmsUUID,CmsUUID> conflictingIds)	Deletes and publishes resources with ID conflicts.
static org.dom4j.Element	CmsModuleXmlHandler.generateXml(CmsModule module, CmsModuleXmlHandler.XmlWriteMode writeMode)	Generates a detached XML element for a module.
static CmsModuleImportExportHandler	CmsModuleImportExportHandler.getExportHandler(CmsObject cms, CmsModule module, String handlerDescription)	Gets the module export handler containing all resources used in the module export.
void	A_CmsModuleAction.initialize(CmsObject adminCms, CmsConfigurationManager configurationManager, CmsModule module)
void	I_CmsModuleAction.initialize(CmsObject adminCms, CmsConfigurationManager configurationManager, CmsModule module)	Will be called by the OpenCms system during server startup.
boolean	CmsModule.isIdentical(CmsModule other)	Checks if this module is identical with another module.
void	A_CmsModuleAction.moduleUninstall(CmsModule module)
void	I_CmsModuleAction.moduleUninstall(CmsModule module)	Will be called if a module is uninstalled from an OpenCms system.
void	A_CmsModuleAction.moduleUpdate(CmsModule module)
void	I_CmsModuleAction.moduleUpdate(CmsModule module)	Will be called if the module this action instance belongs to is updated.
protected void	CmsModuleUpdater.runImportScript(CmsObject cms, CmsModule module)	Runs the module import script.
void	CmsModuleImportData.setModule(CmsModule module)	Sets the module metadata.
void	A_CmsModuleAction.shutDown(CmsModule module)
void	I_CmsModuleAction.shutDown(CmsModule module)	Will be called by the OpenCms system during server shutdown.
void	CmsModuleManager.updateModule(CmsObject cms, CmsModule module)	Updates a already configured module with new values.

Constructors in org.opencms.module with parameters of type CmsModule

Modifier	Constructor	Description
	CmsReplaceModuleInfo(CmsModule module, boolean usedUpdater)	Creates a new instance.

Constructor parameters in org.opencms.module with type arguments of type CmsModule

Modifier	Constructor	Description
	CmsModuleManager(List<CmsModule> configuredModules)	Basic constructor.

Uses of CmsModule in org.opencms.ui.apps.dbmanager

Methods in org.opencms.ui.apps.dbmanager that return CmsModule

Modifier and Type	Method	Description
CmsModule	CmsImportFile.getModule()	Gets the module to import.

Uses of CmsModule in org.opencms.ui.apps.modules

Methods in org.opencms.ui.apps.modules that return CmsModule

Modifier and Type	Method	Description
CmsModule	CmsModuleImportFile.getModule()	Gets the module data.
CmsModule	CmsModuleRow.getModule()	Gets the module.

Methods in org.opencms.ui.apps.modules with parameters of type CmsModule

Modifier and Type	Method	Description
static void	CmsModuleApp.editModule(CmsModule module, boolean isNew, String caption, Runnable callback)	Opens the module editor for the given module.
void	CmsModuleInfoDialog.initialize(CmsModule module)	Fills the widget content.

Constructors in org.opencms.ui.apps.modules with parameters of type CmsModule

Modifier	Constructor	Description
	CmsModuleImportThread(CmsObject cms, CmsModule module, String path)	Creates a new instance.
	CmsModuleRow(CmsModule module)	Creates a new instance.

Uses of CmsModule in org.opencms.ui.apps.modules.edit

Constructors in org.opencms.ui.apps.modules.edit with parameters of type CmsModule

Modifier	Constructor	Description
	CmsEditModuleForm(CmsModule module, boolean newModule, Runnable updateCallback)	Creates a new instance.

Uses of CmsModule in org.opencms.workplace

Methods in org.opencms.workplace with parameters of type CmsModule

Modifier and Type	Method	Description
void	CmsWorkplaceManager.addExplorerTypeSettings(CmsModule module)	Adds the list of explorer type settings from the given module.
void	CmsWorkplaceManager.removeExplorerTypeSettings(CmsModule module)	Removes the list of explorer type settings from the given module.