Mercurial > dive4elements > gnv-client
comparison gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/OutputParameter.java @ 690:254f062e334b
Added JavaDoc.
gnv/trunk@908 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
|---|---|
| date | Mon, 12 Apr 2010 16:45:16 +0000 |
| parents | 57fa8019fbdc |
| children | af22fa5567a6 |
comparison
equal
deleted
inserted
replaced
| 689:8487581dfe3b | 690:254f062e334b |
|---|---|
| 1 package de.intevation.gnv.artifactdatabase.objects; | 1 package de.intevation.gnv.artifactdatabase.objects; |
| 2 | 2 |
| 3 import java.io.Serializable; | 3 import java.io.Serializable; |
| 4 | 4 |
| 5 /** | 5 /** |
| 6 * An <code>OutputParameter</code> describes the input for an export mode and | |
| 7 * stores the value inserted by the user. | |
| 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 * | |
| 8 */ | 10 */ |
| 9 public interface OutputParameter extends Serializable{ | 11 public interface OutputParameter extends Serializable{ |
| 10 | 12 |
| 13 /** | |
| 14 * Retrieves the name of the parameter. | |
| 15 * | |
| 16 * @return the name. | |
| 17 */ | |
| 11 String getName(); | 18 String getName(); |
| 12 | 19 |
| 20 /** | |
| 21 * Retrieves the value of this parameters. | |
| 22 * | |
| 23 * @return the value. | |
| 24 */ | |
| 13 String getValue(); | 25 String getValue(); |
| 14 | 26 |
| 27 /** | |
| 28 * Retrieves the description of this parameter. | |
| 29 * | |
| 30 * @return the description. | |
| 31 */ | |
| 15 String getDescription(); | 32 String getDescription(); |
| 16 | 33 |
| 34 /** | |
| 35 * Retrieves the type of this parameter (e.g. String, Integer, Double, Date). | |
| 36 * | |
| 37 * @return the type. | |
| 38 */ | |
| 17 String getType(); | 39 String getType(); |
| 18 | |
| 19 } | 40 } |
| 41 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |