Mercurial > dive4elements > gnv-client
diff gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/FIS.java @ 792:9b9bf42b7928
Added and repaired JavaDoc in artifacts package.
gnv-artifacts/trunk@874 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
---|---|
date | Wed, 31 Mar 2010 10:52:34 +0000 |
parents | c4156275c1e1 |
children | 32d01e1ce2df |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/FIS.java Wed Mar 31 09:30:34 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/FIS.java Wed Mar 31 10:52:34 2010 +0000 @@ -3,13 +3,38 @@ 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 { + /** + * + * @return the id of this fis. + */ String getID(); + + /** + * + * @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 : \ No newline at end of file