/* $Id: Specification.java,v 1.2 2005/06/08 21:55:56 m31 Exp $
 *
 * This file is part of the project "Hilbert II" - http://www.qedeq.org
 *
 * Copyright 2000-2005,  Michael Meyling <mime@qedeq.org>.
 *
 * "Hilbert II" is free software; you can redistribute
 * it and/or modify it under the terms of the GNU General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 */

package org.qedeq.kernel.base.module;


/**
 * Describes a specification of a module, that means its name, versions and possible
 * "physical" locations. The combination of {@link #getName()} and
 * {@link #getRuleVersion()} defines the file name of that module.
 *
 * @version $Revision: 1.2 $
 * @author  Michael Meyling
 */
public interface Specification {

    /**
     * Set module name.
     *
     * @param   name    Module name.
     */
    public void setName(String name);

    /**
     * Get module name.
     *
     * @return  Module name.
     */
    public String getName();

    /**
     * Set rule version, that is needed to verify the module.
     *
     * @param   ruleVersion Rule version.
     */
    public void setRuleVersion(String ruleVersion);

    /**
     * Get rule version, that is needed to verify the module.
     *
     * @return  Rule version.
     */
    public String getRuleVersion();

    /**
     * Set list of locations for the module.
     *
     * @param   locations   List of locations for that module.
     */
    public void setLocationList(LocationList locations);

    /**
     * Get list of locations for the module.
     *
     * @return  List of locations for that module.
     */
    public LocationList getLocationList();
}