lumis.portal.deployment
Interface IModule

@StableMinor(version="6.2",
             sinceVersion="6.0")
public interface IModule

A module that is deployed in the Lumis Portal.

Since:

5.0.0

Method Summary

Date	getDeploymentDateTime() Returns the date-time of the deployment of this module.
String	getDescription() Returns the module description.
String	getDisplayName() Returns the module display name.
String	getErrorMessage() Returns a message of all errors occurred during deployment process.
String	getId() Returns the module identifier.
int	getNumErrors() Returns the amount of errors in the last operation over the module (start, stop).
ModuleState	getState() Returns the current state of the module.
ModuleType	getType() Returns the type of the module.
boolean	isEnabled() Returns if the module is enabled.

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

boolean isEnabled()

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

getState

ModuleState getState()

Returns the current state of the module.

Returns:

the current state of the module.

Since:

5.0.0

getErrorMessage

String getErrorMessage()

Returns a message of all errors occurred during deployment process.

Returns:

a string.

Since:

6.0.0

getNumErrors

int getNumErrors()

Returns the amount of errors in the last operation over the module (start, stop).

Returns:

the amount of errors.

Since:

6.0.0