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

Field Summary

Fields

Modifier and Type	Field and Description
static String	INVALID_ID_REGEX
static String	PROP_ALIASES
static String	PROP_DEPENDS_PREFIX
static String	PROP_DESCRIPTION
static String	PROP_EDITIONS
static String	PROP_ID
static String	PROP_INSTALL_DATE
static String	PROP_INSTALL_STATE
static String	PROP_REPO_VERSION_MAX
static String	PROP_REPO_VERSION_MIN
static String	PROP_TITLE
static String	PROP_VERSION

Method Summary

Modifier and Type	Method and 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() Deprecated. use getModuleVersionNumber which knows about maven style version numbers
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)

Field Detail

PROP_ID

static final String PROP_ID

See Also:

Constant Field Values

PROP_ALIASES

static final String PROP_ALIASES

See Also:

Constant Field Values

PROP_VERSION

static final String PROP_VERSION

See Also:

Constant Field Values

PROP_TITLE

static final String PROP_TITLE

See Also:

Constant Field Values

PROP_DESCRIPTION

static final String PROP_DESCRIPTION

See Also:

Constant Field Values

PROP_EDITIONS

static final String PROP_EDITIONS

See Also:

Constant Field Values

PROP_REPO_VERSION_MIN

static final String PROP_REPO_VERSION_MIN

See Also:

Constant Field Values

PROP_REPO_VERSION_MAX

static final String PROP_REPO_VERSION_MAX

See Also:

Constant Field Values

PROP_DEPENDS_PREFIX

static final String PROP_DEPENDS_PREFIX

See Also:

Constant Field Values

PROP_INSTALL_DATE

static final String PROP_INSTALL_DATE

See Also:

Constant Field Values

PROP_INSTALL_STATE

static final String PROP_INSTALL_STATE

See Also:

Constant Field Values

INVALID_ID_REGEX

static final String INVALID_ID_REGEX

See Also:

Constant Field Values

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