Mercurial > dive4elements > gnv-client
comparison 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 |
comparison
equal
deleted
inserted
replaced
795:cdade5005cba | 796:a5526908f92f |
---|---|
1 package de.intevation.gnv.state; | 1 package de.intevation.gnv.state; |
2 | 2 |
3 import java.io.Serializable; | 3 import java.io.Serializable; |
4 | 4 |
5 /** | 5 /** |
6 * This interface defines some basic methods to retrieve information about the | |
7 * type of an user input. | |
8 * | |
6 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | 9 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
7 * | 10 * |
8 */ | 11 */ |
9 public interface InputValue extends Serializable { | 12 public interface InputValue extends Serializable { |
10 | 13 |
14 /** | |
15 * Retrieve the name of the inserted data. | |
16 * | |
17 * @return the input data name. | |
18 */ | |
11 public String getName(); | 19 public String getName(); |
12 | 20 |
21 /** | |
22 * Retrieve the type of the input. | |
23 * | |
24 * @return the input data type. | |
25 */ | |
13 public String getType(); | 26 public String getType(); |
14 | 27 |
28 /** | |
29 * Retrieve the default value used when no input is done. | |
30 * | |
31 * @return the input data default value. | |
32 */ | |
15 public String getDefaultValue(); | 33 public String getDefaultValue(); |
16 | 34 |
35 /** | |
36 * Retrieve information about mutliselect fields. | |
37 * | |
38 * @return true, if the input data is a multiselect, otherwise false. | |
39 */ | |
17 public boolean isMultiselect(); | 40 public boolean isMultiselect(); |
18 | 41 |
42 /** | |
43 * Retrieve information about the occurance of this input in an sql | |
44 * statement. | |
45 * | |
46 * @return the number of times, this data is used in a sql query. | |
47 */ | |
19 public int usedInQueries(); | 48 public int usedInQueries(); |
20 | |
21 } | 49 } |
50 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |