lumis.portal.deployment

Interface IModule

All Superinterfaces:

Serializable

All Known Implementing Classes:

Module

@StableMinor(version="7.1",
             sinceVersion="7.1")
public interface IModule
extends Serializable

A module that is deployed in the Lumis Portal.

Since:

5.0.0

Version:

$Revision: 16039 $ $Date: 2013-11-21 21:33:39 -0200 (Thu, 21 Nov 2013) $

Method Summary

Methods

Modifier and Type	Method and Description
String	getChecksum() Returns the hexadecimal string MD5 checksum of this module.
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. since 7.1 replaced by getDeployMessage().
String	getId() Returns the module identifier.
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.
ModuleStatus	getStatus() Returns the module status.
ModuleType	getType() Returns the type of the module.
IVersion	getVersion() Returns the module version.
boolean	isEnabled() Deprecated. since 7.1 always return true for backward compatibility only.

Method Detail

getId

String getId()

Returns the module identifier.

Returns:

the module identifier.

Since:

5.0.0

getDisplayName

String getDisplayName()

Returns the module display name.

Returns:

the module display name.

Since:

5.0.0

getDescription

String getDescription()

Returns the module description.

Returns:

the module description.

Since:

5.0.0

getDeploymentDateTime

Date getDeploymentDateTime()

Returns the date-time of the deployment of this module.

Returns:

the date-time of the deployment of this module.

Since:

5.0.0

isEnabled

@Deprecated
boolean isEnabled()

Deprecated. since 7.1 always return true for backward compatibility only.

Returns if the module is enabled. Disabled modules are not available, just as if not installed.

Returns:

true if the module is enabled, false if it is disabled.

Since:

5.0.0

getType

ModuleType getType()

Returns the type of the module.

Returns:

the type of the module.

Since:

5.0.0

getStatus

ModuleStatus getStatus()

Returns the module status.

Returns:

the module status.

Since:

7.1.0

getErrorMessage

@Deprecated
String getErrorMessage()

Deprecated. since 7.1 replaced by getDeployMessage().

Returns a message of all errors occurred during deployment process.

Returns:

a string.

Since:

6.0.0

getDeployMessage

String getDeployMessage()

Returns a message of all errors and warnings occurred during deployment process.

Returns:

a string.

Since:

7.1.0

getNumErrors

int getNumErrors()

Returns the amount of errors in the last deployment operation over the module.

Returns:

the amount of errors.

Since:

6.0.0

getNumWarnings

int getNumWarnings()

Returns the amount of warnings in the last deployment operation over the module.

Returns:

the amount of warnings.

Since:

7.1.0

getChecksum

String getChecksum()

Returns the hexadecimal string MD5 checksum of this module.

Returns:

the hexadecimal string MD5 checksum of this module.

Since:

7.1.0

getVersion

IVersion getVersion()

Returns the module version.

Returns:

the module version.

Since:

7.1.0

getComponents

List<IComponent> getComponents()

Returns an unmodifiable list of components that belongs the module.

Returns:

an unmodifiable list of components that belongs the module.

Since:

7.1.0