Package lumis.portal.deployment

Class Module

  • All Implemented Interfaces:
    java.io.Serializable, IModule
    public class Module
extends java.lang.Object
implements IModule, java.io.Serializable
    A deployment module entity class.
    Since:
    5.0.0
    Version:
    $Revision$ $Date$
    See Also:
    Serialized Form

    • Method Detail

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • getId

        public java.lang.String getId()
        Description copied from interface: IModule
        Returns the module identifier.
        Specified by:
        getId in interface IModule
        Returns:
        the module identifier.

      • getDisplayName

        public java.lang.String getDisplayName()
        Description copied from interface: IModule
        Returns the module display name.
        Specified by:
        getDisplayName in interface IModule
        Returns:
        the module display name.

      • getDescription

        public java.lang.String getDescription()
        Description copied from interface: IModule
        Returns the module description.
        Specified by:
        getDescription in interface IModule
        Returns:
        the module description.

      • getDeploymentDateTime

        public java.util.Date getDeploymentDateTime()
        Description copied from interface: IModule
        Returns the date-time of the deployment of this module.
        Specified by:
        getDeploymentDateTime in interface IModule
        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.
        Specified by:
        isEnabled in interface IModule
        Returns:
        true if the module is enabled, false if it is disabled.

      • getType

        public ModuleType getType()
        Description copied from interface: IModule
        Returns the type of the module.
        Specified by:
        getType in interface IModule
        Returns:
        the type of the module.

      • getChecksum

        public java.lang.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 not null), the checksum will always be null.
        Specified by:
        getChecksum in interface IModule
        Returns:
        the hexadecimal string MD5 checksum of this module or null if this is an editable module (i.e. IModule.getSourceDir() is not null).

      • 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 interface IModule
        Returns:
        the amount of errors.

      • getDeployMessage

        public java.lang.String getDeployMessage()
        Description copied from interface: IModule
        Returns a message of all errors and warnings occurred during deployment process.
        Specified by:
        getDeployMessage in interface IModule
        Returns:
        a string.

      • getStatus

        public ModuleStatus getStatus()
        Description copied from interface: IModule
        Returns the module status.
        Specified by:
        getStatus in 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 interface IModule
        Returns:
        the amount of warnings.

      • getVersion

        public IVersion getVersion()
        Description copied from interface: IModule
        Returns the module version.
        Specified by:
        getVersion in interface IModule
        Returns:
        the module version.

      • getErrorMessage

        @Deprecated
public java.lang.String getErrorMessage()
        Deprecated.
        Description copied from interface: IModule
        Returns a message of all errors occurred during deployment process.
        Specified by:
        getErrorMessage in interface IModule
        Returns:
        a string.

      • getScope

        public ModuleScope getScope()
        Description copied from interface: IModule
        Returns the scope of this module.
        Specified by:
        getScope in interface IModule
        Returns:
        the scope of this module.

      • getComponents

        public java.util.List<IComponent> getComponents()
        Description copied from interface: IModule
        Returns an unmodifiable list of components that belongs the module.
        Specified by:
        getComponents in interface IModule
        Returns:
        an unmodifiable list of components that belongs the module.

      • getSourceDir

        public java.lang.String getSourceDir()
        Description copied from interface: IModule
        Returns the source directory of the module
        Specified by:
        getSourceDir in interface IModule
        Returns:
        the module source directory