Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/OutputMode.java @ 875:5e9efdda6894
merged gnv-artifacts/1.0
| author | Thomas Arendsen Hein <thomas@intevation.de> |
|---|---|
| date | Fri, 28 Sep 2012 12:13:56 +0200 |
| parents | 05bf8534a35a |
| children | f953c9a559d8 |
comparison
equal
deleted
inserted
replaced
| 722:bb3ffe7d719e | 875:5e9efdda6894 |
|---|---|
| 1 package de.intevation.gnv.state; | |
| 2 | |
| 3 import java.io.Serializable; | |
| 4 | |
| 5 import java.util.Collection; | |
| 6 import java.util.List; | |
| 7 | |
| 8 /** | |
| 9 * This is the interface description of an <code>OutputMode</code>. The | |
| 10 * methods defined here retrieve some basic information for an output. An output | |
| 11 * can be chart, histogram, statistic, csv, odv and so on. | |
| 12 * | |
| 13 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | |
| 14 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> | |
| 15 */ | |
| 16 public interface OutputMode extends Serializable { | |
| 17 | |
| 18 /** | |
| 19 * Retrieve the name of this output mode. | |
| 20 * | |
| 21 * @return the name of this output mode. | |
| 22 */ | |
| 23 public String getName(); | |
| 24 | |
| 25 /** | |
| 26 * Retrieve the description of an output. | |
| 27 * | |
| 28 * @return the description. | |
| 29 */ | |
| 30 public String getDescription(); | |
| 31 | |
| 32 /** | |
| 33 * Retrieve the mimetype used for the output. | |
| 34 * | |
| 35 * @return the mimetype. | |
| 36 */ | |
| 37 public String getMimeType(); | |
| 38 | |
| 39 /** | |
| 40 * Retrieve a list of optional InputValue objects the user is able to | |
| 41 * adjust. | |
| 42 * | |
| 43 * @return optional input parameters. | |
| 44 */ | |
| 45 public Collection<InputValue> getInputParameters(); | |
| 46 | |
| 47 /** | |
| 48 * Retrieve a list of export modes this output can be exported to. | |
| 49 * | |
| 50 * @return some export modes. | |
| 51 */ | |
| 52 public List<ExportMode> getExportModes(); | |
| 53 } | |
| 54 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |