Mercurial > dive4elements > gnv-client
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 791:23877dd69444 | 792:9b9bf42b7928 |
|---|---|
| 1 package de.intevation.gnv.artifacts.services.requestobjects; | 1 package de.intevation.gnv.artifacts.services.requestobjects; |
| 2 | 2 |
| 3 import java.util.Collection; | 3 import java.util.Collection; |
| 4 | 4 |
| 5 /** | 5 /** |
| 6 * This is the interface description for a fis. Currently, there are three | |
| 7 * methods defined which need to be implemented by concrete classes:<br> | |
| 8 * <ol> | |
| 9 * <li>getID(): Returns the id of this fis.</li> | |
| 10 * <li>getParameter(): Returns a collection of parameter.</li> | |
| 11 * <li>addParameter(Collection<Parameter>): Adds a parameter collection to this | |
| 12 * fis.</li> | |
| 13 * </ol> | |
| 14 * | |
| 6 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | 15 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
| 7 * | 16 * |
| 8 */ | 17 */ |
| 9 public interface FIS { | 18 public interface FIS { |
| 10 | 19 |
| 20 /** | |
| 21 * | |
| 22 * @return the id of this fis. | |
| 23 */ | |
| 11 String getID(); | 24 String getID(); |
| 25 | |
| 26 /** | |
| 27 * | |
| 28 * @return a collection of parameters. | |
| 29 */ | |
| 12 Collection<Parameter> getParameter(); | 30 Collection<Parameter> getParameter(); |
| 31 | |
| 32 /** | |
| 33 * Add a collection of parameters to this fis. | |
| 34 * | |
| 35 * @param parameter Some parameters. | |
| 36 */ | |
| 13 void addParameter(Collection<Parameter> parameter); | 37 void addParameter(Collection<Parameter> parameter); |
| 14 | 38 |
| 15 } | 39 } |
| 40 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |