Module (OpenMRS 2.7.0-SNAPSHOT API)

java.lang.Object
- org.openmrs.module.Module

```
public final class Module
extends Object
```
Generic module class that openmrs manipulates

Version:

1.0

Constructor Summary

Constructors
Constructor and Description
`Module(String name)` Simple constructor
`Module(String name, String moduleId, String packageName, String author, String description, String version)` Main constructor

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addRequiredModule(String requiredModule, String version)`
`void`	`clearStartupError()`
`void`	`disposeAdvicePointsClassInstance()`
`boolean`	`equals(Object obj)`
`String`	`getActivatorName()`
`List<AdvicePoint>`	`getAdvicePoints()`
`String`	`getAuthor()`
`List<String>`	`getAwareOfModules()` This list of strings is just what is included in the config.xml file, the full package names: e.g. org.openmrs.module.formentry, for the modules that this module is aware of.
`String`	`getAwareOfModuleVersion(String awareOfModule)`
`List<ModuleConditionalResource>`	`getConditionalResources()`
`Document`	`getConfig()`
`String`	`getDescription()`
`String`	`getDownloadURL()`
`List<Extension>`	`getExtensions()` Expands (i.e. creates instances of) `Extension`s defined by their class name in `setExtensionNames(Map)`.
`File`	`getFile()`
`List<GlobalProperty>`	`getGlobalProperties()`
`List<String>`	`getMappingFiles()`
`Map<String,Properties>`	`getMessages()` Deprecated. as of 2.0 because messages are automatically loaded from the classpath
`ModuleActivator`	`getModuleActivator()`
`String`	`getModuleId()`
`String`	`getModuleIdAsPath()`
`String`	`getName()`
`String`	`getPackageName()`
`Set<String>`	`getPackagesWithMappedClasses()` Packages to scan for classes with JPA annotated classes.
`List<Privilege>`	`getPrivileges()`
`String`	`getRequireDatabaseVersion()`
`List<String>`	`getRequiredModules()` This list of strings is just what is included in the config.xml file, the full package names: e.g. org.openmrs.module.formentry
`Map<String,String>`	`getRequiredModulesMap()` Get the modules that are required for this module.
`String`	`getRequiredModuleVersion(String moduleName)` Convenience method to get the version of this given module that is required
`String`	`getRequireOpenmrsVersion()`
`Document`	`getSqldiff()`
`List<String>`	`getStartBeforeModules()` Gets names of modules which should start after this
`Map<String,String>`	`getStartBeforeModulesMap()` Gets modules which should start after this
`String`	`getStartupErrorMessage()`
`String`	`getUpdateURL()`
`String`	`getUpdateVersion()`
`String`	`getVersion()`
`int`	`hashCode()`
`Boolean`	`hasStartupError()`
`boolean`	`isCore()`
`boolean`	`isCoreModule()` This is a convenience method to know whether this module is core to OpenMRS.
`boolean`	`isMandatory()` This property is set by the module owner to tell OpenMRS that once it is installed, it must always startup.
`boolean`	`isStarted()`
`void`	`setActivatorName(String activatorName)`
`void`	`setAdvicePoints(List<AdvicePoint> advicePoints)`
`void`	`setAuthor(String author)`
`void`	`setAwareOfModulesMap(Map<String,String> awareOfModulesMap)` Sets the modules that this module is aware of.
`void`	`setConditionalResources(List<ModuleConditionalResource> conditionalResources)`
`void`	`setConfig(Document config)`
`void`	`setDescription(String description)`
`void`	`setDownloadURL(String downloadURL)`
`void`	`setExtensionNames(Map<String,String> map)` A map of pointId to classname.
`void`	`setExtensions(List<Extension> extensions)`
`void`	`setFile(File file)`
`void`	`setGlobalProperties(List<GlobalProperty> globalProperties)`
`void`	`setMandatory(boolean mandatory)`
`void`	`setMappingFiles(List<String> mappingFiles)`
`void`	`setMessages(Map<String,Properties> messages)` Deprecated. as of 2.0 because messages are automatically loaded from the classpath
`void`	`setModuleActivator(ModuleActivator moduleActivator)`
`void`	`setModuleId(String moduleId)`
`void`	`setName(String name)`
`void`	`setPackageName(String packageName)`
`void`	`setPackagesWithMappedClasses(Set<String> packagesToScan)`
`void`	`setPrivileges(List<Privilege> privileges)`
`void`	`setRequireDatabaseVersion(String requireDatabaseVersion)`
`void`	`setRequiredModules(List<String> requiredModules)` This is a convenience method to set all the required modules without any version requirements
`void`	`setRequiredModulesMap(Map<String,String> requiredModulesMap)`
`void`	`setRequireOpenmrsVersion(String requireOpenmrsVersion)`
`void`	`setSqldiff(Document sqldiff)`
`void`	`setStartBeforeModulesMap(Map<String,String> startBeforeModulesMap)` Sets modules that must start after this module
`void`	`setStartupErrorMessage(String e)`
`void`	`setStartupErrorMessage(String exceptionMessage, Throwable t)` Add the given exceptionMessage and throwable as the startup error for this module.
`void`	`setUpdateURL(String updateURL)`
`void`	`setUpdateVersion(String updateVersion)`
`void`	`setVersion(String version)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Module
```
public Module(String name)
```
    Simple constructor
    
    Parameters:
    
    name -
  - Module
```
public Module(String name,
              String moduleId,
              String packageName,
              String author,
              String description,
              String version)
```
    Main constructor
    
    Parameters:
    
    name -
    
    moduleId -
    
    packageName -
    
    author -
    
    description -
    
    version -
- Method Detail
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - getModuleActivator
```
public ModuleActivator getModuleActivator()
```
    Returns:
    
    the moduleActivator
  - setModuleActivator
```
public void setModuleActivator(ModuleActivator moduleActivator)
```
    Parameters:
    
    moduleActivator - the moduleActivator to set
  - getActivatorName
```
public String getActivatorName()
```
    Returns:
    
    the activatorName
  - setActivatorName
```
public void setActivatorName(String activatorName)
```
    Parameters:
    
    activatorName - the activatorName to set
  - getAuthor
```
public String getAuthor()
```
    Returns:
    
    the author
  - setAuthor
```
public void setAuthor(String author)
```
    Parameters:
    
    author - the author to set
  - getDescription
```
public String getDescription()
```
    Returns:
    
    the description
  - setDescription
```
public void setDescription(String description)
```
    Parameters:
    
    description - the description to set
  - getName
```
public String getName()
```
    Returns:
    
    the name
  - setName
```
public void setName(String name)
```
    Parameters:
    
    name - the name to set
  - getRequireDatabaseVersion
```
public String getRequireDatabaseVersion()
```
    Returns:
    
    the requireDatabaseVersion
  - setRequireDatabaseVersion
```
public void setRequireDatabaseVersion(String requireDatabaseVersion)
```
    Parameters:
    
    requireDatabaseVersion - the requireDatabaseVersion to set
  - getRequiredModules
```
public List<String> getRequiredModules()
```
    This list of strings is just what is included in the config.xml file, the full package names: e.g. org.openmrs.module.formentry
    
    Returns:
    
    the list of requiredModules
  - getRequiredModuleVersion
```
public String getRequiredModuleVersion(String moduleName)
```
    Convenience method to get the version of this given module that is required
    
    Returns:
    
    the version of the given required module, or null if there are no version constraints
    
    Since:
    
    1.5 Should return null if no required modules exist Should return null if no required module by given name exists
  - setRequiredModules
```
public void setRequiredModules(List<String> requiredModules)
```
    This is a convenience method to set all the required modules without any version requirements
    
    Parameters:
    
    requiredModules - the requiredModules to set for this module Should set modules when there is a null required modules map
  - addRequiredModule
```
public void addRequiredModule(String requiredModule,
                              String version)
```
    Parameters:
    
    requiredModule - the requiredModule to add for this module
    
    version - version requiredModule Should add module to required modules map
  - setRequiredModulesMap
```
public void setRequiredModulesMap(Map<String,String> requiredModulesMap)
```
    Parameters:
    
    requiredModulesMap - Map<String,String> of the requiredModules to set
    
    Since:
    
    1.5
  - getRequiredModulesMap
```
public Map<String,String> getRequiredModulesMap()
```
    Get the modules that are required for this module. The keys in this map are the module package names. The values in the map are the required version. If no specific version is required, it will be null.
    
    Returns:
    
    a map from required module to the version that is required
  - setStartBeforeModulesMap
```
public void setStartBeforeModulesMap(Map<String,String> startBeforeModulesMap)
```
    Sets modules that must start after this module
    
    Parameters:
    
    startBeforeModulesMap - the startedBefore modules to set
  - getStartBeforeModulesMap
```
public Map<String,String> getStartBeforeModulesMap()
```
    Gets modules which should start after this
    
    Returns:
    
    map where key is module name and value is module version
  - getStartBeforeModules
```
public List<String> getStartBeforeModules()
```
    Gets names of modules which should start after this
    
    Returns:
    
    list of module names or null
    
    Since:
    
    1.11
  - setAwareOfModulesMap
```
public void setAwareOfModulesMap(Map<String,String> awareOfModulesMap)
```
    Sets the modules that this module is aware of.
    
    Parameters:
    
    awareOfModulesMap - Map<String,String> of the awareOfModulesMaps to set
    
    Since:
    
    1.9
  - getAwareOfModules
```
public List<String> getAwareOfModules()
```
    This list of strings is just what is included in the config.xml file, the full package names: e.g. org.openmrs.module.formentry, for the modules that this module is aware of.
    
    Returns:
    
    the list of awareOfModules
    
    Since:
    
    1.9
  - getAwareOfModuleVersion
```
public String getAwareOfModuleVersion(String awareOfModule)
```
  - getRequireOpenmrsVersion
```
public String getRequireOpenmrsVersion()
```
    Returns:
    
    the requireOpenmrsVersion
  - setRequireOpenmrsVersion
```
public void setRequireOpenmrsVersion(String requireOpenmrsVersion)
```
    Parameters:
    
    requireOpenmrsVersion - the requireOpenmrsVersion to set
  - getModuleId
```
public String getModuleId()
```
    Returns:
    
    the module id
  - getModuleIdAsPath
```
public String getModuleIdAsPath()
```
    Returns:
    
    the module id, with all . replaced with /
  - setModuleId
```
public void setModuleId(String moduleId)
```
    Parameters:
    
    moduleId - the module id to set
  - getPackageName
```
public String getPackageName()
```
    Returns:
    
    the packageName
  - setPackageName
```
public void setPackageName(String packageName)
```
    Parameters:
    
    packageName - the packageName to set
  - getVersion
```
public String getVersion()
```
    Returns:
    
    the version
  - setVersion
```
public void setVersion(String version)
```
    Parameters:
    
    version - the version to set
  - getUpdateURL
```
public String getUpdateURL()
```
    Returns:
    
    the updateURL
  - setUpdateURL
```
public void setUpdateURL(String updateURL)
```
    Parameters:
    
    updateURL - the updateURL to set
  - getDownloadURL
```
public String getDownloadURL()
```
    Returns:
    
    the downloadURL
  - setDownloadURL
```
public void setDownloadURL(String downloadURL)
```
    Parameters:
    
    downloadURL - the downloadURL to set
  - getUpdateVersion
```
public String getUpdateVersion()
```
    Returns:
    
    the updateVersion
  - setUpdateVersion
```
public void setUpdateVersion(String updateVersion)
```
    Parameters:
    
    updateVersion - the updateVersion to set
  - getExtensions
```
public List<Extension> getExtensions()
```
    Expands (i.e. creates instances of) Extensions defined by their class name in setExtensionNames(Map).
    
    Returns:
    
    the extensions Should not expand extensionNames if extensionNames is null Should not expand extensionNames if extensionNames is empty Should not expand extensionNames if extensions matches extensionNames Should expand extensionNames if extensions does not match extensionNames
  - setExtensions
```
public void setExtensions(List<Extension> extensions)
```
    Parameters:
    
    extensions - the extensions to set
  - setExtensionNames
```
public void setExtensionNames(Map<String,String> map)
```
    A map of pointId to classname. The classname is expected to be a class that extends the Extension object.
    This map will be expanded into full Extension objects the first time getExtensions() is called.
    The map is a direct representation of extension tags in a module's config.xml. For example
```
 <extension>
     <point>org.openmrs.admin.list</point>
     <class>org.openmrs.module.reporting.web.extension.ManageAdminListExt</class>
 </extension>
 
 
```
    Parameters:
    
    map - from pointid to classname of an extension
    
    See Also:
    
    ModuleFileParser
  - getAdvicePoints
```
public List<AdvicePoint> getAdvicePoints()
```
    Returns:
    
    the advicePoints
  - setAdvicePoints
```
public void setAdvicePoints(List<AdvicePoint> advicePoints)
```
    Parameters:
    
    advicePoints - the advicePoints to set
  - getFile
```
public File getFile()
```
  - setFile
```
public void setFile(File file)
```
  - getMessages
```
@Deprecated
public Map<String,Properties> getMessages()
```
    Deprecated. as of 2.0 because messages are automatically loaded from the classpath
    
    Gets a mapping from locale to properties used by this module. The locales are represented as a string containing language and country codes.
    
    Returns:
    
    mapping from locales to properties
  - setMessages
```
@Deprecated
public void setMessages(Map<String,Properties> messages)
```
    Deprecated. as of 2.0 because messages are automatically loaded from the classpath
    
    Sets the map from locale to properties used by this module.
    
    Parameters:
    
    messages - map of locale to properties for that locale
  - getGlobalProperties
```
public List<GlobalProperty> getGlobalProperties()
```
  - setGlobalProperties
```
public void setGlobalProperties(List<GlobalProperty> globalProperties)
```
  - getPrivileges
```
public List<Privilege> getPrivileges()
```
  - setPrivileges
```
public void setPrivileges(List<Privilege> privileges)
```
  - getConfig
```
public Document getConfig()
```
  - setConfig
```
public void setConfig(Document config)
```
  - getSqldiff
```
public Document getSqldiff()
```
  - setSqldiff
```
public void setSqldiff(Document sqldiff)
```
  - getMappingFiles
```
public List<String> getMappingFiles()
```
  - setMappingFiles
```
public void setMappingFiles(List<String> mappingFiles)
```
  - getPackagesWithMappedClasses
```
public Set<String> getPackagesWithMappedClasses()
```
    Packages to scan for classes with JPA annotated classes.
    
    Returns:
    
    the set of packages to scan
    
    Since:
    
    1.9.2, 1.10
  - setPackagesWithMappedClasses
```
public void setPackagesWithMappedClasses(Set<String> packagesToScan)
```
    Parameters:
    
    packagesToScan -
    
    Since:
    
    1.9.2, 1.10
    
    See Also:
    
    getPackagesWithMappedClasses()
  - isMandatory
```
public boolean isMandatory()
```
    This property is set by the module owner to tell OpenMRS that once it is installed, it must always startup. This is intended for modules with system-critical monitoring or security checks that should always be in place.
    
    Returns:
    
    true if this module has said that it should always start up
  - setMandatory
```
public void setMandatory(boolean mandatory)
```
  - isCoreModule
```
public boolean isCoreModule()
```
    This is a convenience method to know whether this module is core to OpenMRS. A module is 'core' when this module is essentially part of the core code and must exist at all times
    
    Returns:
    
    true if this is an OpenMRS core module
    
    See Also:
    
    ModuleConstants.CORE_MODULES
  - isStarted
```
public boolean isStarted()
```
  - setStartupErrorMessage
```
public void setStartupErrorMessage(String e)
```
    Parameters:
    
    e - string to set as startup error message Should throw exception when message is null
  - setStartupErrorMessage
```
public void setStartupErrorMessage(String exceptionMessage,
                                   Throwable t)
```
    Add the given exceptionMessage and throwable as the startup error for this module. This method loops over the stacktrace and adds the detailed message
    
    Parameters:
    
    exceptionMessage - optional. the default message to show on the first line of the error message
    
    t - throwable stacktrace to include in the error message Should throw exception when throwable is null Should set StartupErrorMessage when exceptionMessage is null Should append throwable's message to exceptionMessage
  - getStartupErrorMessage
```
public String getStartupErrorMessage()
```
  - hasStartupError
```
public Boolean hasStartupError()
```
  - clearStartupError
```
public void clearStartupError()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - disposeAdvicePointsClassInstance
```
public void disposeAdvicePointsClassInstance()
```
  - getConditionalResources
```
public List<ModuleConditionalResource> getConditionalResources()
```
  - setConditionalResources
```
public void setConditionalResources(List<ModuleConditionalResource> conditionalResources)
```
  - isCore
```
public boolean isCore()
```

Class Module

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Module

Module

Method Detail

equals

hashCode

getModuleActivator

setModuleActivator

getActivatorName

setActivatorName

getAuthor

setAuthor

getDescription

setDescription

getName

setName

getRequireDatabaseVersion

setRequireDatabaseVersion

getRequiredModules

getRequiredModuleVersion

setRequiredModules

addRequiredModule

setRequiredModulesMap

getRequiredModulesMap

setStartBeforeModulesMap

getStartBeforeModulesMap

getStartBeforeModules

setAwareOfModulesMap

getAwareOfModules

getAwareOfModuleVersion

getRequireOpenmrsVersion

setRequireOpenmrsVersion

getModuleId

getModuleIdAsPath

setModuleId

getPackageName

setPackageName

getVersion

setVersion

getUpdateURL

setUpdateURL

getDownloadURL

setDownloadURL

getUpdateVersion

setUpdateVersion

getExtensions

setExtensions

setExtensionNames

getAdvicePoints

setAdvicePoints

getFile

setFile

getMessages

setMessages

getGlobalProperties

setGlobalProperties

getPrivileges

setPrivileges

getConfig

setConfig

getSqldiff

setSqldiff

getMappingFiles

setMappingFiles

getPackagesWithMappedClasses

setPackagesWithMappedClasses

isMandatory

setMandatory

isCoreModule

isStarted

setStartupErrorMessage

setStartupErrorMessage

getStartupErrorMessage

hasStartupError

clearStartupError

toString