Mercurial > dive4elements > gnv-client
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 1027:fca4b5eb8d2f | 1119:7c4f81f74c47 |
|---|---|
| 1 /* | |
| 2 * Copyright (c) 2010 by Intevation GmbH | |
| 3 * | |
| 4 * This program is free software under the LGPL (>=v2.1) | |
| 5 * Read the file LGPL.txt coming with the software for details | |
| 6 * or visit http://www.gnu.org/licenses/ if it does not exist. | |
| 7 */ | |
| 8 | |
| 9 package de.intevation.gnv.state; | |
| 10 | |
| 11 import java.io.Serializable; | |
| 12 | |
| 13 /** | |
| 14 * This interface defines some basic methods to retrieve information about the | |
| 15 * type of an user input. | |
| 16 * | |
| 17 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | |
| 18 * | |
| 19 */ | |
| 20 public interface InputValue extends Serializable { | |
| 21 | |
| 22 /** | |
| 23 * Retrieve the name of the inserted data. | |
| 24 * | |
| 25 * @return the input data name. | |
| 26 */ | |
| 27 public String getName(); | |
| 28 | |
| 29 /** | |
| 30 * Retrieve the type of the input. | |
| 31 * | |
| 32 * @return the input data type. | |
| 33 */ | |
| 34 public String getType(); | |
| 35 | |
| 36 /** | |
| 37 * Retrieve the default value used when no input is done. | |
| 38 * | |
| 39 * @return the input data default value. | |
| 40 */ | |
| 41 public String getDefaultValue(); | |
| 42 | |
| 43 /** | |
| 44 * Retrieve information about mutliselect fields. | |
| 45 * | |
| 46 * @return true, if the input data is a multiselect, otherwise false. | |
| 47 */ | |
| 48 public boolean isMultiselect(); | |
| 49 | |
| 50 /** | |
| 51 * Retrieve information about the occurance of this input in an sql | |
| 52 * statement. | |
| 53 * | |
| 54 * @return the number of times, this data is used in a sql query. | |
| 55 */ | |
| 56 public int usedInQueries(); | |
| 57 } | |
| 58 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |