Mercurial > dive4elements > gnv-client
diff 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 |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/OutputState.java Wed Mar 31 13:48:07 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/OutputState.java Thu Apr 01 09:15:36 2010 +0000 @@ -11,8 +11,14 @@ import org.w3c.dom.Document; /** + * This is the interface description of an output state. Currently, there are + * two methods defined:<br> + * <ol> + * <li>out(): To start an output of the current state.</li> + * <li>getOutputModes(): To retrieve a list of possible output modes.</li> + * </ol> + * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> - * */ public interface OutputState extends State @@ -21,9 +27,11 @@ /** * Returns the Rendered Result of an State. * - * @param outputMode - * The Mode that should be produces (Chart, Map, ...) - * @return The Bytecode of the Result + * @param format + * @param inputData + * @param outputStream + * @param uuid + * @param callContext * @throws StateException */ public void out( @@ -41,3 +49,4 @@ */ public Collection<OutputMode> getOutputModes(); } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file