org.alfresco.service.cmr.module
Interface ModuleDetails

All Superinterfaces:
java.io.Serializable
All Known Implementing Classes:
ModuleDetailsImpl

public interface ModuleDetails
extends java.io.Serializable

Module details, contains the details of an installed alfresco module.

Since:
2.0

Field Summary
static java.lang.String INVALID_ID_REGEX
           
static java.lang.String PROP_ALIASES
           
static java.lang.String PROP_DEPENDS_PREFIX
           
static java.lang.String PROP_DESCRIPTION
           
static java.lang.String PROP_ID
           
static java.lang.String PROP_INSTALL_DATE
           
static java.lang.String PROP_INSTALL_STATE
           
static java.lang.String PROP_REPO_VERSION_MAX
           
static java.lang.String PROP_REPO_VERSION_MIN
           
static java.lang.String PROP_TITLE
           
static java.lang.String PROP_VERSION
           
 
Method Summary
 java.util.List getAliases()
           
 java.util.List getDependencies()
           
 java.lang.String getDescription()
          Get the description of the module
 java.lang.String getId()
          Get the id of the module
 java.util.Date getInstallDate()
          Get the modules install date
 ModuleInstallState getInstallState()
          Get the modules install state
 java.util.Properties getProperties()
          Get all defined properties.
 org.alfresco.util.VersionNumber getRepoVersionMax()
           
 org.alfresco.util.VersionNumber getRepoVersionMin()
           
 java.lang.String getTitle()
          Get the title of the module
 org.alfresco.util.VersionNumber getVersion()
          Get the version number of the module
 void setInstallDate(java.util.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 java.lang.String PROP_ID
See Also:
Constant Field Values

PROP_ALIASES

static final java.lang.String PROP_ALIASES
See Also:
Constant Field Values

PROP_VERSION

static final java.lang.String PROP_VERSION
See Also:
Constant Field Values

PROP_TITLE

static final java.lang.String PROP_TITLE
See Also:
Constant Field Values

PROP_DESCRIPTION

static final java.lang.String PROP_DESCRIPTION
See Also:
Constant Field Values

PROP_REPO_VERSION_MIN

static final java.lang.String PROP_REPO_VERSION_MIN
See Also:
Constant Field Values

PROP_REPO_VERSION_MAX

static final java.lang.String PROP_REPO_VERSION_MAX
See Also:
Constant Field Values

PROP_DEPENDS_PREFIX

static final java.lang.String PROP_DEPENDS_PREFIX
See Also:
Constant Field Values

PROP_INSTALL_DATE

static final java.lang.String PROP_INSTALL_DATE
See Also:
Constant Field Values

PROP_INSTALL_STATE

static final java.lang.String PROP_INSTALL_STATE
See Also:
Constant Field Values

INVALID_ID_REGEX

static final java.lang.String INVALID_ID_REGEX
See Also:
Constant Field Values
Method Detail

getProperties

java.util.Properties getProperties()
Get all defined properties.

Returns:
Returns the properties defined by this set of details

getId

java.lang.String getId()
Get the id of the module

Returns:
module id

getAliases

java.util.List getAliases()
Returns:
Returns a list of IDs by which this module may once have been known

getVersion

org.alfresco.util.VersionNumber getVersion()
Get the version number of the module

Returns:
module version number

getTitle

java.lang.String getTitle()
Get the title of the module

Returns:
module title

getDescription

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

java.util.List getDependencies()
Returns:
Returns a list of module dependencies that must be present for this module

getInstallDate

java.util.Date getInstallDate()
Get the modules install date

Returns:
module install date or null if it has not been set

setInstallDate

void setInstallDate(java.util.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


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.