SaaS CMS has officially launched! Learn more now.

Class ModuleManager

Inheritance
System.Object
ModuleManager
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Mediachase.BusinessFoundation.Data.Modules
Assembly: Mediachase.BusinessFoundation.Data.dll
Version: 11.8.3
Syntax
public static class ModuleManager

Properties

Modules

Declaration
public static ModuleManifestCollection Modules { get; set; }
Property Value
Type Description
ModuleManifestCollection

Methods

Activate(MetaClass, ModuleManifest)

Activates the specified manifest.

Declaration
public static void Activate(MetaClass metaClass, ModuleManifest manifest)
Parameters
Type Name Description
MetaClass metaClass

The meta class.

ModuleManifest manifest

The manifest.

Activate(String, String)

Activates the specified meta class name.

Declaration
public static void Activate(string metaClassName, string moduleName)
Parameters
Type Name Description
System.String metaClassName

Name of the meta class.

System.String moduleName

Name of the module.

Deactivate(MetaClass, ModuleManifest)

Deactivates the specified manifest.

Declaration
public static void Deactivate(MetaClass metaClass, ModuleManifest manifest)
Parameters
Type Name Description
MetaClass metaClass

The meta class.

ModuleManifest manifest

The manifest.

Deactivate(String, String)

Deactivates the specified module name.

Declaration
public static void Deactivate(string metaClassName, string moduleName)
Parameters
Type Name Description
System.String metaClassName

Name of the meta class.

System.String moduleName

Name of the module.

GetActiveModules(MetaClass)

Gets the active modules.

Declaration
public static ModuleManifest[] GetActiveModules(MetaClass metaClass)
Parameters
Type Name Description
MetaClass metaClass

The meta class.

Returns
Type Description
ModuleManifest[]

GetAvailableModules()

Declaration
public static ModuleManifest[] GetAvailableModules()
Returns
Type Description
ModuleManifest[]

GetInstalledModules()

Gets the istalled modules.

Declaration
public static ModuleManifest[] GetInstalledModules()
Returns
Type Description
ModuleManifest[]

GetModuleConfigurator(ModuleManifest)

Gets the module configurator.

Declaration
public static IModuleConfigurator GetModuleConfigurator(ModuleManifest manifest)
Parameters
Type Name Description
ModuleManifest manifest

The manifest.

Returns
Type Description
IModuleConfigurator

GetModuleDataStorage(ModuleManifest)

Gets the module data storage.

Declaration
public static ModuleDataStorage GetModuleDataStorage(ModuleManifest module)
Parameters
Type Name Description
ModuleManifest module

The module.

Returns
Type Description
ModuleDataStorage

GetModuleDataStorage(ModuleManifest, MetaClass)

Gets the module data storage.

Declaration
public static ModuleDataStorage GetModuleDataStorage(ModuleManifest module, MetaClass metaClass)
Parameters
Type Name Description
ModuleManifest module

The module.

MetaClass metaClass

The meta class.

Returns
Type Description
ModuleDataStorage

GetModuleDataStorage(String)

Gets the module data storage.

Declaration
public static ModuleDataStorage GetModuleDataStorage(string moduleName)
Parameters
Type Name Description
System.String moduleName

Name of the module.

Returns
Type Description
ModuleDataStorage

GetModuleDataStorage(String, String)

Gets the module data storage.

Declaration
public static ModuleDataStorage GetModuleDataStorage(string moduleName, string metaClass)
Parameters
Type Name Description
System.String moduleName

Name of the module.

System.String metaClass

The meta class.

Returns
Type Description
ModuleDataStorage

GetModuleManifest(String)

Gets the module manifest.

Declaration
public static ModuleManifest GetModuleManifest(string moduleName)
Parameters
Type Name Description
System.String moduleName

Name of the module.

Returns
Type Description
ModuleManifest

InitializeActiveModules()

Initializes the active modules.

Declaration
public static void InitializeActiveModules()

Install(ModuleManifest)

Declaration
public static void Install(ModuleManifest manifest)
Parameters
Type Name Description
ModuleManifest manifest

Install(ModuleManifest, AttributeCollection)

Installs the specified manifest.

Declaration
public static void Install(ModuleManifest manifest, AttributeCollection attributes)
Parameters
Type Name Description
ModuleManifest manifest

The manifest.

AttributeCollection attributes

The attributes.

IsModuleActivated(MetaClass, ModuleManifest)

Determines whether [is module activated] [the specified manifest].

Declaration
public static bool IsModuleActivated(MetaClass metaClass, ModuleManifest manifest)
Parameters
Type Name Description
MetaClass metaClass

The meta class.

ModuleManifest manifest

The manifest.

Returns
Type Description
System.Boolean

true if [is module activated] [the specified manifest]; otherwise, false.

IsModuleActivated(String, String)

Determines whether [is module activated] [the specified meta class].

Declaration
public static bool IsModuleActivated(string metaClass, string moduleName)
Parameters
Type Name Description
System.String metaClass

The meta class.

System.String moduleName

Name of the module.

Returns
Type Description
System.Boolean

true if [is module activated] [the specified meta class]; otherwise, false.

IsModuleInstalled(ModuleManifest)

Determines whether [is module installed] [the specified manifest].

Declaration
public static bool IsModuleInstalled(ModuleManifest manifest)
Parameters
Type Name Description
ModuleManifest manifest

The manifest.

Returns
Type Description
System.Boolean

true if [is module installed] [the specified manifest]; otherwise, false.

IsModuleInstalled(String)

Gets the istalled modules.

Declaration
public static bool IsModuleInstalled(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
System.Boolean

Uninstall(ModuleManifest)

Uninstalls the specified manifest.

Declaration
public static void Uninstall(ModuleManifest manifest)
Parameters
Type Name Description
ModuleManifest manifest

The manifest.