view gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/Product.java @ 1115:f953c9a559d8

Added license file and license headers. gnv-artifacts/trunk@1260 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Tue, 02 Nov 2010 17:46:55 +0000
parents 05bf8534a35a
children
line wrap: on
line source
/*
 * Copyright (c) 2010 by Intevation GmbH
 *
 * This program is free software under the LGPL (>=v2.1)
 * Read the file LGPL.txt coming with the software for details
 * or visit http://www.gnu.org/licenses/ if it does not exist.
 */

package de.intevation.gnv.artifacts.fis.product;

import de.intevation.gnv.state.InputData;

import java.io.Serializable;

import java.util.Collection;

/**
 * This is the interface description of <code>Product</code>. Currently, there
 * are three methods defined:<br>
 * <ol>
 *  <li>getName(): retrieves the name of the <code>Product</code></li>
 *  <li>getParameter(): retrieves a collection of required parameters.</li>
 *  <li>getArtifactFactory(): retrieves the factory used to create this artifact.
 *  </li>
 * </ol>
 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
 */
public interface Product extends Serializable {

    /**
     *
     * @return The name of this product.
     */
    public String getName();

    /**
     *
     * @return All required parameters for parameterization.
     */
    public Collection<InputData> getParameter();

    /**
     *
     * @return The artifact factory used to create the current artifact.
     */
    public String getArtifactFactory();
}
// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org