Mercurial > dive4elements > gnv-client
diff gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/OutputMode.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/OutputMode.java Mon Apr 12 10:56:55 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/OutputMode.java Mon Apr 12 16:45:16 2010 +0000 @@ -5,16 +5,42 @@ import java.util.Collection; /** + * <code>OutputMode</code> objects give information possible types of exports + * for an artifact (e.g. chart, histogram, csv, odv, statistic). + * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> * */ public interface OutputMode extends Serializable{ + /** + * Retrieve the name of an output mode. + * + * @return the name. + */ public String getName(); + /** + * Retrieve the mimetype of an output mode. + * + * @return the mimetype. + */ public String getMimeType(); + /** + * Retrieve the output parameters available to adjust the output. + * + * @return the output parameters. + */ public Collection<OutputParameter> getOutputParameters(); + /** + * Retrieve possible export modes which describe specific output modes + * (e.g. pdf, svg, image). + * + * @param mode The export mode's name. + * @return the export mode. + */ public ExportMode getExportMode(String mode); } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file