diff gnv-artifacts/src/main/java/de/intevation/gnv/state/InputValue.java @ 1119:7c4f81f74c47

merged gnv-artifacts
author Thomas Arendsen Hein <thomas@intevation.de>
date Fri, 28 Sep 2012 12:14:00 +0200
parents f953c9a559d8
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/InputValue.java	Fri Sep 28 12:14:00 2012 +0200
@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) 2010 by Intevation GmbH
+ *
+ * This program is free software under the LGPL (>=v2.1)
+ * Read the file LGPL.txt coming with the software for details
+ * or visit http://www.gnu.org/licenses/ if it does not exist.
+ */
+
+package de.intevation.gnv.state;
+
+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