Mercurial > dive4elements > gnv-client
diff 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 |
line wrap: on
line diff
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/OutputParameter.java Mon Apr 12 10:56:55 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/OutputParameter.java Mon Apr 12 16:45:16 2010 +0000 @@ -3,17 +3,39 @@ import java.io.Serializable; /** + * An <code>OutputParameter</code> describes the input for an export mode and + * stores the value inserted by the user. + * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> - * */ public interface OutputParameter extends Serializable{ + /** + * Retrieves the name of the parameter. + * + * @return the name. + */ String getName(); + /** + * Retrieves the value of this parameters. + * + * @return the value. + */ String getValue(); + /** + * Retrieves the description of this parameter. + * + * @return the description. + */ String getDescription(); + /** + * Retrieves the type of this parameter (e.g. String, Integer, Double, Date). + * + * @return the type. + */ String getType(); - } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file