Package lumis.portal.deployment
Class Module
- java.lang.Object
-
- lumis.portal.deployment.Module
-
- All Implemented Interfaces:
Serializable
,IModule
public class Module extends Object implements IModule, Serializable
A deployment module entity class.- Since:
- 5.0.0
- Version:
- $Revision: 23098 $ $Date: 2019-08-29 17:47:04 -0300 (Thu, 29 Aug 2019) $
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description String
getChecksum()
Returns the hexadecimal string MD5 checksum of this module.
If this module is an editable module (i.e.List<IComponent>
getComponents()
Returns an unmodifiable list of components that belongs the module.Date
getDeploymentDateTime()
Returns the date-time of the deployment of this module.String
getDeployMessage()
Returns a message of all errors and warnings occurred during deployment process.String
getDescription()
Returns the module description.String
getDisplayName()
Returns the module display name.String
getErrorMessage()
Deprecated.String
getId()
Returns the module identifier.ModuleObject
getMetadata()
Returns this module metadata.ModuleObject
getMetadataForComparing()
Returns the meta data that should be used for comparing this module (or its inner objects) to other one.int
getNumErrors()
Returns the amount of errors in the last deployment operation over the module.int
getNumWarnings()
Returns the amount of warnings in the last deployment operation over the module.ModuleScope
getScope()
Returns the scope of this module.String
getSourceDir()
Returns the source directory of the moduleModuleStatus
getStatus()
Returns the module status.ModuleType
getType()
Returns the type of the module.IVersion
getVersion()
Returns the module version.int
hashCode()
boolean
isEnabled()
Deprecated.void
setMetadata(ModuleObject moduleMetadata)
Sets the metadata of this module.String
toString()
-
-
-
Method Detail
-
getId
public String getId()
Description copied from interface:IModule
Returns the module identifier.
-
getDisplayName
public String getDisplayName()
Description copied from interface:IModule
Returns the module display name.- Specified by:
getDisplayName
in interfaceIModule
- Returns:
- the module display name.
-
getDescription
public String getDescription()
Description copied from interface:IModule
Returns the module description.- Specified by:
getDescription
in interfaceIModule
- Returns:
- the module description.
-
getDeploymentDateTime
public Date getDeploymentDateTime()
Description copied from interface:IModule
Returns the date-time of the deployment of this module.- Specified by:
getDeploymentDateTime
in interfaceIModule
- Returns:
- the date-time of the deployment of this module.
-
isEnabled
@Deprecated public boolean isEnabled()
Deprecated.Description copied from interface:IModule
Returns if the module is enabled. Disabled modules are not available, just as if not installed.
-
getType
public ModuleType getType()
Description copied from interface:IModule
Returns the type of the module.
-
getChecksum
public String getChecksum()
Description copied from interface:IModule
Returns the hexadecimal string MD5 checksum of this module.
If this module is an editable module (i.e.IModule.getSourceDir()
is notnull
), the checksum will always benull
.- Specified by:
getChecksum
in interfaceIModule
- Returns:
- the hexadecimal string MD5 checksum of this module or
null
if this is an editable module (i.e.IModule.getSourceDir()
is notnull
).
-
getMetadata
public ModuleObject getMetadata()
Returns this module metadata.- Returns:
- this module metadata.
- Since:
- 8.1.0
-
getMetadataForComparing
public ModuleObject getMetadataForComparing() throws PortalException
Returns the meta data that should be used for comparing this module (or its inner objects) to other one.- Returns:
- the meta data that should be used for comparing this module (or its inner objects) to other one.
- Throws:
PortalException
- Since:
- 10.4.0
-
setMetadata
public void setMetadata(ModuleObject moduleMetadata)
Sets the metadata of this module.- Parameters:
moduleMetadata
- the metadata of this module.- Since:
- 8.1.0
-
getNumErrors
public int getNumErrors()
Description copied from interface:IModule
Returns the amount of errors in the last deployment operation over the module.- Specified by:
getNumErrors
in interfaceIModule
- Returns:
- the amount of errors.
-
getDeployMessage
public String getDeployMessage()
Description copied from interface:IModule
Returns a message of all errors and warnings occurred during deployment process.- Specified by:
getDeployMessage
in interfaceIModule
- Returns:
- a string.
-
getStatus
public ModuleStatus getStatus()
Description copied from interface:IModule
Returns the module status.
-
getNumWarnings
public int getNumWarnings()
Description copied from interface:IModule
Returns the amount of warnings in the last deployment operation over the module.- Specified by:
getNumWarnings
in interfaceIModule
- Returns:
- the amount of warnings.
-
getVersion
public IVersion getVersion()
Description copied from interface:IModule
Returns the module version.- Specified by:
getVersion
in interfaceIModule
- Returns:
- the module version.
-
getErrorMessage
@Deprecated public String getErrorMessage()
Deprecated.Description copied from interface:IModule
Returns a message of all errors occurred during deployment process.- Specified by:
getErrorMessage
in interfaceIModule
- Returns:
- a string.
-
getScope
public ModuleScope getScope()
Description copied from interface:IModule
Returns the scope of this module.
-
getComponents
public List<IComponent> getComponents()
Description copied from interface:IModule
Returns an unmodifiable list of components that belongs the module.- Specified by:
getComponents
in interfaceIModule
- Returns:
- an unmodifiable list of components that belongs the module.
-
getSourceDir
public String getSourceDir()
Description copied from interface:IModule
Returns the source directory of the module- Specified by:
getSourceDir
in interfaceIModule
- Returns:
- the module source directory
-
-