Paul Holmes-Higgin cefda8c965 Updated header to LGPL
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@18931 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2010-03-01 22:48:39 +00:00

58 lines
2.3 KiB
Java

/*
* Copyright (C) 2005-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.service.cmr.module;
import java.io.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
*/
public interface ModuleDependency extends Serializable
{
/**
* 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.
*
* @return Returns the ID of the module that this depends on
*/
public String getDependencyId();
/**
* @return Returns a string representation of the versions supported
*/
public String getVersionString();
/**
* Check if a module satisfies the dependency requirements.
*
* @param moduleDetails the module details of the dependency. This must be
* the details of the module with the correct
* {@link #getDependencyId() ID}. This may be <tt>null</tt>
* in which case <tt>false</tt> will always be returned.
* @return Returns true if the module satisfies the dependency
* requirements.
*/
public boolean isValidDependency(ModuleDetails moduleDetails);
}