Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/Product.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 | 05bf8534a35a |
comparison
equal
deleted
inserted
replaced
| 791:23877dd69444 | 792:9b9bf42b7928 |
|---|---|
| 5 import java.io.Serializable; | 5 import java.io.Serializable; |
| 6 | 6 |
| 7 import java.util.Collection; | 7 import java.util.Collection; |
| 8 | 8 |
| 9 /** | 9 /** |
| 10 * This is the interface description of <code>Product</code>. Currently, there | |
| 11 * are three methods defined:<br> | |
| 12 * <ol> | |
| 13 * <li>getName(): retrieves the name of the <code>Product</code></li> | |
| 14 * <li>getParameter(): retrieves a collection of required parameters.</li> | |
| 15 * <li>getArtifactFactory(): retrieves the factory used to create this artifact. | |
| 16 * </li> | |
| 17 * </ol> | |
| 10 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | 18 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
| 11 * | |
| 12 */ | 19 */ |
| 13 public interface Product extends Serializable { | 20 public interface Product extends Serializable { |
| 14 | 21 |
| 22 /** | |
| 23 * | |
| 24 * @return The name of this product. | |
| 25 */ | |
| 15 public String getName(); | 26 public String getName(); |
| 16 | 27 |
| 28 /** | |
| 29 * | |
| 30 * @return All required parameters for parameterization. | |
| 31 */ | |
| 17 public Collection<InputData> getParameter(); | 32 public Collection<InputData> getParameter(); |
| 18 | 33 |
| 34 /** | |
| 35 * | |
| 36 * @return The artifact factory used to create the current artifact. | |
| 37 */ | |
| 19 public String getArtifactFactory(); | 38 public String getArtifactFactory(); |
| 20 } | 39 } |
| 40 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |