Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
org.alfresco.service.cmr.module
Interface ModuleDetails
All Superinterfaces:
Serializable
@org.alfresco.api.AlfrescoPublicApi
public interface ModuleDetails
extends Serializable
Module details, contains the details of an installed alfresco module.
Since:
2.0
Author:
Roy Wetherall
Field Summary
String
 INVALID_ID_REGEX
String
 PROP_ALIASES
String
 PROP_DEPENDS_PREFIX
String
 PROP_DESCRIPTION
String
 PROP_EDITIONS
String
 PROP_ID
String
 PROP_INSTALL_DATE
String
 PROP_INSTALL_STATE
String
 PROP_REPO_VERSION_MAX
String
 PROP_REPO_VERSION_MIN
String
 PROP_TITLE
String
 PROP_VERSION
Method Summary
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
org.alfresco.repo.module.ModuleVersionNumber
 getModuleVersionNumber()
          Get the version number of the module
Properties
 getProperties()
          Get all defined properties.
VersionNumber
 getRepoVersionMax()
VersionNumber
 getRepoVersionMin()
String
 getTitle()
          Get the title of the module
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(VersionNumber repoVersionMax)
void
 setRepoVersionMin(VersionNumber repoVersionMin)
Field Detail
INVALID_ID_REGEX
public static final String INVALID_ID_REGEX
See Also:
Constant Field Values
PROP_ALIASES
public static final String PROP_ALIASES
See Also:
Constant Field Values
PROP_DEPENDS_PREFIX
public static final String PROP_DEPENDS_PREFIX
See Also:
Constant Field Values
PROP_DESCRIPTION
public static final String PROP_DESCRIPTION
See Also:
Constant Field Values
PROP_EDITIONS
public static final String PROP_EDITIONS
See Also:
Constant Field Values
PROP_ID
public static final String PROP_ID
See Also:
Constant Field Values
PROP_INSTALL_DATE
public static final String PROP_INSTALL_DATE
See Also:
Constant Field Values
PROP_INSTALL_STATE
public static final String PROP_INSTALL_STATE
See Also:
Constant Field Values
PROP_REPO_VERSION_MAX
public static final String PROP_REPO_VERSION_MAX
See Also:
Constant Field Values
PROP_REPO_VERSION_MIN
public static final String PROP_REPO_VERSION_MIN
See Also:
Constant Field Values
PROP_TITLE
public static final String PROP_TITLE
See Also:
Constant Field Values
PROP_VERSION
public static final String PROP_VERSION
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
org.alfresco.repo.module.ModuleVersionNumber getModuleVersionNumber()
Get the version number of the module
Returns:
module version number
getVersion
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
VersionNumber getRepoVersionMin()
Returns:
Returns the minimum version of the repository in which the module may be active
setRepoVersionMin
void setRepoVersionMin(VersionNumber repoVersionMin)
Parameters:
repoVersionMin - the minimum version of the repository in which the module may be acitve
getRepoVersionMax
VersionNumber getRepoVersionMax()
Returns:
Returns the maximum version of the repository in which the module may be active
setRepoVersionMax
void setRepoVersionMax(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
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2005–2018 Alfresco Software. All rights reserved.
Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.