Package lumis.portal.deployment

Interface IModule

  • All Superinterfaces:
    java.io.Serializable
    All Known Implementing Classes:
    Module
    @StableMinor(version="16.0",
             sinceVersion="7.1")
public interface IModule
extends java.io.Serializable
    A module that is deployed in the LumisXP.
    Since:
    5.0.0
    Version:
    $Revision: 25808 $ $Date: 2023-07-04 15:20:55 -0300 (Tue, 04 Jul 2023) $

    • Method Detail

      • getId

        java.lang.String getId()
        Returns the module identifier.
        Returns:
        the module identifier.
        Since:
        5.0.0

      • getDisplayName

        java.lang.String getDisplayName()
        Returns the module display name.
        Returns:
        the module display name.
        Since:
        5.0.0

      • getDescription

        java.lang.String getDescription()
        Returns the module description.
        Returns:
        the module description.
        Since:
        5.0.0

      • getSourceDir

        java.lang.String getSourceDir()
        Returns the source directory of the module
        Returns:
        the module source directory
        Since:
        8.0.0

      • getDeploymentDateTime

        java.util.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
java.lang.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

        java.lang.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

        java.lang.String getChecksum()
        Returns the hexadecimal string MD5 checksum of this module.
        If this module is an editable module (i.e. getSourceDir() is not null), the checksum will always be null.
        Returns:
        the hexadecimal string MD5 checksum of this module or null if this is an editable module (i.e. getSourceDir() is not null).
        Since:
        7.1.0

      • getVersion

        IVersion getVersion()
        Returns the module version.
        Returns:
        the module version.
        Since:
        7.1.0

      • getComponents

        java.util.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

      • getScope

        ModuleScope getScope()
        Returns the scope of this module.
        Returns:
        the scope of this module.
        Since:
        10.2.0