org.alfresco.repo.module
Class ModuleDetailsImpl

java.lang.Object
  extended by org.alfresco.repo.module.ModuleDetailsImpl
All Implemented Interfaces:
java.io.Serializable, ModuleDetails

public class ModuleDetailsImpl
extends java.lang.Object
implements ModuleDetails

See Also:
Serialized Form

Nested Class Summary
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_ID, PROP_INSTALL_DATE, PROP_INSTALL_STATE, PROP_REPO_VERSION_MAX, PROP_REPO_VERSION_MIN, PROP_TITLE, PROP_VERSION
 
Constructor Summary
ModuleDetailsImpl(java.util.Properties properties)
          Creates the instance from a set of properties.
ModuleDetailsImpl(java.lang.String id, org.alfresco.util.VersionNumber versionNumber, java.lang.String title, java.lang.String description)
           
 
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)
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ModuleDetailsImpl

public ModuleDetailsImpl(java.util.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(java.lang.String id,
                         org.alfresco.util.VersionNumber versionNumber,
                         java.lang.String title,
                         java.lang.String description)
Parameters:
id - module id
versionNumber - version number
title - title
description - description
Method Detail

getProperties

public java.util.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 java.lang.String toString()
Overrides:
toString in class java.lang.Object

getId

public java.lang.String getId()
Description copied from interface: ModuleDetails
Get the id of the module

Specified by:
getId in interface ModuleDetails
Returns:
module id

getAliases

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

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

getTitle

public java.lang.String getTitle()
Description copied from interface: ModuleDetails
Get the title of the module

Specified by:
getTitle in interface ModuleDetails
Returns:
module title

getDescription

public java.lang.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 java.util.List getDependencies()
Specified by:
getDependencies in interface ModuleDetails
Returns:
Returns a list of module dependencies that must be present for this module

getInstallDate

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


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