Package org.alfresco.repo.module

Class ModuleDetailsImpl

java.lang.Object

org.alfresco.repo.module.ModuleDetailsImpl

All Implemented Interfaces:

Serializable, ModuleDetails

public class ModuleDetailsImpl
extends Object
implements ModuleDetails

Author:

Derek Hulley

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModuleDetailsImpl.ModuleDependencyImpl

Field Summary

Fields inherited from interface org.alfresco.service.cmr.module.ModuleDetails

INVALID_ID_REGEX, PROP_ALIASES, PROP_DEPENDS_PREFIX, PROP_DESCRIPTION, PROP_EDITIONS, PROP_ID, PROP_INSTALL_DATE, PROP_INSTALL_STATE, PROP_REPO_VERSION_MAX, PROP_REPO_VERSION_MIN, PROP_TITLE, PROP_VERSION

Constructor Summary

Constructors

Constructor	Description
ModuleDetailsImpl(String id, ModuleVersionNumber versionNumber, String title, String description)
ModuleDetailsImpl(Properties properties)	Creates the instance from a set of properties.
ModuleDetailsImpl(Properties properties, LogOutput log)	Creates the instance from a set of properties.

Method Summary

Modifier and Type	Method	Description
List<String>	getAliases()
List<ModuleDependency>	getDependencies()
String	getDescription()	Get the description of the module
List<String>	getEditions()
String	getId()	Get the id of the module
Date	getInstallDate()	Get the modules install date
ModuleInstallState	getInstallState()	Get the modules install state
ModuleVersionNumber	getModuleVersionNumber()	Get the version number of the module
Properties	getProperties()	Get all defined properties.
org.alfresco.util.VersionNumber	getRepoVersionMax()
org.alfresco.util.VersionNumber	getRepoVersionMin()
String	getTitle()	Get the title of the module
org.alfresco.util.VersionNumber	getVersion()	Get the version number of the module
void	setEditions(List<String> editions)	Sets the editions of Alfresco the module is valid for
void	setInstallDate(Date installDate)	Set the module installation date.
void	setInstallState(ModuleInstallState installState)	Set the module install state.
void	setRepoVersionMax(org.alfresco.util.VersionNumber repoVersionMax)
void	setRepoVersionMin(org.alfresco.util.VersionNumber repoVersionMin)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ModuleDetailsImpl

public ModuleDetailsImpl(Properties properties)

Creates the instance from a set of properties. All the property values are trimmed and empty string values are removed from the set. In other words, zero length or whitespace strings are not supported.

Parameters:

properties - the set of properties

ModuleDetailsImpl

public ModuleDetailsImpl(Properties properties,
                         LogOutput log)

Creates the instance from a set of properties. All the property values are trimmed and empty string values are removed from the set. In other words, zero length or whitespace strings are not supported.

Parameters:

properties - the set of properties

log - logger

ModuleDetailsImpl

public ModuleDetailsImpl(String id,
                         ModuleVersionNumber versionNumber,
                         String title,
                         String description)

Parameters:

id - module id

versionNumber - version number

title - title

description - description

Method Detail

getProperties

public Properties getProperties()

Description copied from interface: ModuleDetails

Get all defined properties.

Specified by:

getProperties in interface ModuleDetails

Returns:

Returns the properties defined by this set of details

toString

public String toString()

Overrides:

toString in class Object

getId

public String getId()

Description copied from interface: ModuleDetails

Get the id of the module

Specified by:

getId in interface ModuleDetails

Returns:

module id

getAliases

public List<String> getAliases()

Specified by:

getAliases in interface ModuleDetails

Returns:

Returns a list of IDs by which this module may once have been known

getModuleVersionNumber

public ModuleVersionNumber getModuleVersionNumber()

Description copied from interface: ModuleDetails

Get the version number of the module

Specified by:

getModuleVersionNumber in interface ModuleDetails

Returns:

module version number

getTitle

public String getTitle()

Description copied from interface: ModuleDetails

Get the title of the module

Specified by:

getTitle in interface ModuleDetails

Returns:

module title

getDescription

public String getDescription()

Description copied from interface: ModuleDetails

Get the description of the module

Specified by:

getDescription in interface ModuleDetails

Returns:

module description

getRepoVersionMin

public org.alfresco.util.VersionNumber getRepoVersionMin()

Specified by:

getRepoVersionMin in interface ModuleDetails

Returns:

Returns the minimum version of the repository in which the module may be active

setRepoVersionMin

public void setRepoVersionMin(org.alfresco.util.VersionNumber repoVersionMin)

Specified by:

setRepoVersionMin in interface ModuleDetails

Parameters:

repoVersionMin - the minimum version of the repository in which the module may be acitve

getRepoVersionMax

public org.alfresco.util.VersionNumber getRepoVersionMax()

Specified by:

getRepoVersionMax in interface ModuleDetails

Returns:

Returns the maximum version of the repository in which the module may be active

setRepoVersionMax

public void setRepoVersionMax(org.alfresco.util.VersionNumber repoVersionMax)

Specified by:

setRepoVersionMax in interface ModuleDetails

Parameters:

repoVersionMax - the maximum version of the repository in which the module may be acitve

getDependencies

public List<ModuleDependency> getDependencies()

Specified by:

getDependencies in interface ModuleDetails

Returns:

Returns a list of module dependencies that must be present for this module

getInstallDate

public Date getInstallDate()

Description copied from interface: ModuleDetails

Get the modules install date

Specified by:

getInstallDate in interface ModuleDetails

Returns:

module install date or null if it has not been set

setInstallDate

public void setInstallDate(Date installDate)

Description copied from interface: ModuleDetails

Set the module installation date.

Specified by:

setInstallDate in interface ModuleDetails

Parameters:

installDate - the module install date

getInstallState

public ModuleInstallState getInstallState()

Description copied from interface: ModuleDetails

Get the modules install state

Specified by:

getInstallState in interface ModuleDetails

Returns:

the modules install state

setInstallState

public void setInstallState(ModuleInstallState installState)

Description copied from interface: ModuleDetails

Set the module install state.

Specified by:

setInstallState in interface ModuleDetails

Parameters:

installState - the module install state

getEditions

public List<String> getEditions()

Specified by:

getEditions in interface ModuleDetails

Returns:

the editions

setEditions

public void setEditions(List<String> editions)

Description copied from interface: ModuleDetails

Sets the editions of Alfresco the module is valid for

Specified by:

setEditions in interface ModuleDetails

Parameters:

editions - comma seperated list of editions. e.g. community,Enterprise

getVersion

public org.alfresco.util.VersionNumber getVersion()

Description copied from interface: ModuleDetails

Get the version number of the module

Specified by:

getVersion in interface ModuleDetails

Returns:

module version number