Mercurial > dive4elements > gnv-client
diff gnv-artifacts/src/main/java/de/intevation/gnv/state/OutputMode.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 | 05bf8534a35a |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/OutputMode.java Wed Mar 31 13:48:07 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/OutputMode.java Thu Apr 01 09:15:36 2010 +0000 @@ -6,18 +6,49 @@ import java.util.List; /** + * This is the interface description of an <code>OutputMode</code>. The + * methods defined here retrieve some basic information for an output. An output + * can be chart, histogram, statistic, csv, odv and so on. + * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> - * + * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> */ public interface OutputMode extends Serializable { + /** + * Retrieve the name of this output mode. + * + * @return the name of this output mode. + */ public String getName(); + /** + * Retrieve the description of an output. + * + * @return the description. + */ public String getDescription(); + /** + * Retrieve the mimetype used for the output. + * + * @return the mimetype. + */ public String getMimeType(); + /** + * Retrieve a list of optional InputValue objects the user is able to + * adjust. + * + * @return optional input parameters. + */ public Collection<InputValue> getInputParameters(); + /** + * Retrieve a list of export modes this output can be exported to. + * + * @return some export modes. + */ public List<ExportMode> getExportModes(); } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file