diff gnv-artifacts/src/main/java/de/intevation/gnv/state/InputValue.java @ 796:a5526908f92f

Added javadoc in state package. gnv-artifacts/trunk@878 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Ingo Weinzierl <ingo.weinzierl@intevation.de>
date Thu, 01 Apr 2010 09:15:36 +0000
parents c4156275c1e1
children feae2f9d6c6f
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/InputValue.java	Wed Mar 31 13:48:07 2010 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/InputValue.java	Thu Apr 01 09:15:36 2010 +0000
@@ -3,19 +3,48 @@
 import java.io.Serializable;
 
 /**
+ * This interface defines some basic methods to retrieve information about the
+ * type of an user input.
+ * 
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  *
  */
 public interface InputValue extends Serializable {
 
+    /**
+     * Retrieve the name of the inserted data.
+     *
+     * @return the input data name.
+     */
     public String getName();
 
+    /**
+     * Retrieve the type of the input.
+     *
+     * @return the input data type.
+     */
     public String getType();
 
+    /**
+     * Retrieve the default value used when no input is done.
+     *
+     * @return the input data default value.
+     */
     public String getDefaultValue();
 
+    /**
+     * Retrieve information about mutliselect fields.
+     *
+     * @return true, if the input data is a multiselect, otherwise false.
+     */
     public boolean isMultiselect();
 
+    /**
+     * Retrieve information about the occurance of this input in an sql
+     * statement.
+     *
+     * @return the number of times, this data is used in a sql query.
+     */
     public int usedInQueries();
-
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org