Package org.alfresco.service.cmr.module

Interface ModuleDetails

  • All Superinterfaces:
    Serializable
    All Known Implementing Classes:
    ModuleDetailsImpl
    @AlfrescoPublicApi
public interface ModuleDetails
extends Serializable
    Module details, contains the details of an installed alfresco module.
    Since:
    2.0
    Author:
    Roy Wetherall

    • Method Detail

      • getProperties

        Properties getProperties()
        Get all defined properties.
        Returns:
        Returns the properties defined by this set of details

      • getId

        String getId()
        Get the id of the module
        Returns:
        module id

      • getAliases

        List<String> getAliases()
        Returns:
        Returns a list of IDs by which this module may once have been known

      • getModuleVersionNumber

        ModuleVersionNumber getModuleVersionNumber()
        Get the version number of the module
        Returns:
        module version number

      • getVersion

        org.alfresco.util.VersionNumber getVersion()
        Deprecated.
        use getModuleVersionNumber which knows about maven style version numbers
        Get the version number of the module
        Returns:
        module version number

      • getTitle

        String getTitle()
        Get the title of the module
        Returns:
        module title

      • getDescription

        String getDescription()
        Get the description of the module
        Returns:
        module description

      • getRepoVersionMin

        org.alfresco.util.VersionNumber getRepoVersionMin()
        Returns:
        Returns the minimum version of the repository in which the module may be active

      • setRepoVersionMin

        void setRepoVersionMin​(org.alfresco.util.VersionNumber repoVersionMin)
        Parameters:
        repoVersionMin - the minimum version of the repository in which the module may be acitve

      • getRepoVersionMax

        org.alfresco.util.VersionNumber getRepoVersionMax()
        Returns:
        Returns the maximum version of the repository in which the module may be active

      • setRepoVersionMax

        void setRepoVersionMax​(org.alfresco.util.VersionNumber repoVersionMax)
        Parameters:
        repoVersionMax - the maximum version of the repository in which the module may be acitve

      • getDependencies

        List<ModuleDependency> getDependencies()
        Returns:
        Returns a list of module dependencies that must be present for this module

      • getInstallDate

        Date getInstallDate()
        Get the modules install date
        Returns:
        module install date or null if it has not been set

      • setInstallDate

        void setInstallDate​(Date installDate)
        Set the module installation date.
        Parameters:
        installDate - the module install date

      • getInstallState

        ModuleInstallState getInstallState()
        Get the modules install state
        Returns:
        the modules install state

      • setInstallState

        void setInstallState​(ModuleInstallState installState)
        Set the module install state.
        Parameters:
        installState - the module install state

      • getEditions

        List<String> getEditions()
        Returns:
        the editions

      • setEditions

        void setEditions​(List<String> editions)
        Sets the editions of Alfresco the module is valid for
        Parameters:
        editions - comma seperated list of editions. e.g. community,Enterprise