diff 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
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/Product.java	Wed Mar 31 09:30:34 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/fis/product/Product.java	Wed Mar 31 10:52:34 2010 +0000
@@ -7,14 +7,34 @@
 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 :
\ No newline at end of file

http://dive4elements.wald.intevation.org