Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/OutputState.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 | feae2f9d6c6f |
comparison
equal
deleted
inserted
replaced
| 795:cdade5005cba | 796:a5526908f92f |
|---|---|
| 9 import java.util.Collection; | 9 import java.util.Collection; |
| 10 | 10 |
| 11 import org.w3c.dom.Document; | 11 import org.w3c.dom.Document; |
| 12 | 12 |
| 13 /** | 13 /** |
| 14 * This is the interface description of an output state. Currently, there are | |
| 15 * two methods defined:<br> | |
| 16 * <ol> | |
| 17 * <li>out(): To start an output of the current state.</li> | |
| 18 * <li>getOutputModes(): To retrieve a list of possible output modes.</li> | |
| 19 * </ol> | |
| 20 * | |
| 14 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | 21 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
| 15 * | |
| 16 */ | 22 */ |
| 17 public interface OutputState | 23 public interface OutputState |
| 18 extends State | 24 extends State |
| 19 { | 25 { |
| 20 | 26 |
| 21 /** | 27 /** |
| 22 * Returns the Rendered Result of an State. | 28 * Returns the Rendered Result of an State. |
| 23 * | 29 * |
| 24 * @param outputMode | 30 * @param format |
| 25 * The Mode that should be produces (Chart, Map, ...) | 31 * @param inputData |
| 26 * @return The Bytecode of the Result | 32 * @param outputStream |
| 33 * @param uuid | |
| 34 * @param callContext | |
| 27 * @throws StateException | 35 * @throws StateException |
| 28 */ | 36 */ |
| 29 public void out( | 37 public void out( |
| 30 Document format, | 38 Document format, |
| 31 Collection<InputData> inputData, | 39 Collection<InputData> inputData, |
| 39 * | 47 * |
| 40 * @return the provided OutputModes of an State | 48 * @return the provided OutputModes of an State |
| 41 */ | 49 */ |
| 42 public Collection<OutputMode> getOutputModes(); | 50 public Collection<OutputMode> getOutputModes(); |
| 43 } | 51 } |
| 52 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |