org.alfresco.service.cmr.module

Interface ModuleDependency

All Superinterfaces:

Serializable

All Known Implementing Classes:

ModuleDetailsImpl.ModuleDependencyImpl

@AlfrescoPublicApi
public interface ModuleDependency
extends Serializable

An ensapsulated module dependency. Since module dependencies may be range based and even unbounded, it is not possible to describe a dependency using a list of module version numbers. This class answers the

Author:

Derek Hulley

Method Summary

Modifier and Type	Method and Description
String	getDependencyId() Get the ID of the module that this dependency describes.
String	getVersionString()
boolean	isValidDependency(ModuleDetails moduleDetails) Check if a module satisfies the dependency requirements.

Method Detail

getDependencyId

String getDependencyId()

Get the ID of the module that this dependency describes. The dependency may be upon specific versions or a range of versions. Nevertheless, the module given by the returned ID will be required in one version or another.

Returns:

Returns the ID of the module that this depends on

getVersionString

String getVersionString()

Returns:

Returns a string representation of the versions supported

isValidDependency

boolean isValidDependency(ModuleDetails moduleDetails)

Check if a module satisfies the dependency requirements.

Parameters:

moduleDetails - the module details of the dependency. This must be the details of the module with the correct ID. This may be null in which case false will always be returned.

Returns:

Returns true if the module satisfies the dependency requirements.