view gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/FIS.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.services.requestobjects;

import java.util.Collection;

/**
 * This is the interface description for a fis. Currently, there are three
 * methods defined which need to be implemented by concrete classes:<br>
 * <ol>
 *  <li>getID(): Returns the id of this fis.</li>
 *  <li>getParameter(): Returns a collection of parameter.</li>
 *  <li>addParameter(Collection<Parameter>): Adds a parameter collection to this
 * fis.</li>
 * </ol>
 *
 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
 *
 */
public interface FIS {

    /**
     * Returns the id of this FIS
     * @return the id of this fis.
     */
    String getID();

    /**
     * Returns a collection of Parameters which belongs to the FIS.
     * @return a collection of parameters.
     */
    Collection<Parameter> getParameter();

    /**
     * Add a collection of parameters to this fis.
     *
     * @param parameter Some parameters.
     */
    void addParameter(Collection<Parameter> parameter);

}
// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org