Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/OutputState.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 de.intevation.artifacts.CallContext; | |
| 4 | |
| 5 import de.intevation.gnv.state.exception.StateException; | |
| 6 | |
| 7 import java.io.OutputStream; | |
| 8 | |
| 9 import java.util.Collection; | |
| 10 | |
| 11 import org.w3c.dom.Document; | |
| 12 | |
| 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 * | |
| 21 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | |
| 22 */ | |
| 23 public interface OutputState | |
| 24 extends State | |
| 25 { | |
| 26 | |
| 27 /** | |
| 28 * Returns the Rendered Result of an State. | |
| 29 * | |
| 30 * @param format | |
| 31 * @param inputData | |
| 32 * @param outputStream | |
| 33 * @param uuid | |
| 34 * @param callContext | |
| 35 * @throws StateException | |
| 36 */ | |
| 37 public void out( | |
| 38 Document format, | |
| 39 Collection<InputData> inputData, | |
| 40 OutputStream outputStream, | |
| 41 String uuid, | |
| 42 CallContext callContext | |
| 43 ) throws StateException; | |
| 44 | |
| 45 /** | |
| 46 * Delivers the provided OutputModes of an State | |
| 47 * | |
| 48 * @return the provided OutputModes of an State | |
| 49 */ | |
| 50 public Collection<OutputMode> getOutputModes(); | |
| 51 } | |
| 52 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |