Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/OutputState.java @ 1119:7c4f81f74c47
merged gnv-artifacts
| author | Thomas Arendsen Hein <thomas@intevation.de> |
|---|---|
| date | Fri, 28 Sep 2012 12:14:00 +0200 |
| parents | f953c9a559d8 |
| children |
comparison
equal
deleted
inserted
replaced
| 1027:fca4b5eb8d2f | 1119:7c4f81f74c47 |
|---|---|
| 1 /* | |
| 2 * Copyright (c) 2010 by Intevation GmbH | |
| 3 * | |
| 4 * This program is free software under the LGPL (>=v2.1) | |
| 5 * Read the file LGPL.txt coming with the software for details | |
| 6 * or visit http://www.gnu.org/licenses/ if it does not exist. | |
| 7 */ | |
| 8 | |
| 9 package de.intevation.gnv.state; | |
| 10 | |
| 11 import de.intevation.artifacts.CallContext; | |
| 12 | |
| 13 import de.intevation.gnv.state.exception.StateException; | |
| 14 | |
| 15 import java.io.OutputStream; | |
| 16 | |
| 17 import java.util.Collection; | |
| 18 | |
| 19 import org.w3c.dom.Document; | |
| 20 | |
| 21 /** | |
| 22 * This is the interface description of an output state. Currently, there are | |
| 23 * two methods defined:<br> | |
| 24 * <ol> | |
| 25 * <li>out(): To start an output of the current state.</li> | |
| 26 * <li>getOutputModes(): To retrieve a list of possible output modes.</li> | |
| 27 * </ol> | |
| 28 * | |
| 29 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | |
| 30 */ | |
| 31 public interface OutputState | |
| 32 extends State | |
| 33 { | |
| 34 | |
| 35 /** | |
| 36 * Returns the Rendered Result of an State. | |
| 37 * | |
| 38 * @param format | |
| 39 * @param inputData | |
| 40 * @param outputStream | |
| 41 * @param uuid | |
| 42 * @param callContext | |
| 43 * @throws StateException | |
| 44 */ | |
| 45 public void out( | |
| 46 Document format, | |
| 47 Collection<InputData> inputData, | |
| 48 OutputStream outputStream, | |
| 49 String uuid, | |
| 50 CallContext callContext | |
| 51 ) throws StateException; | |
| 52 | |
| 53 /** | |
| 54 * Delivers the provided OutputModes of an State | |
| 55 * | |
| 56 * @return the provided OutputModes of an State | |
| 57 */ | |
| 58 public Collection<OutputMode> getOutputModes(); | |
| 59 } | |
| 60 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |