diff 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
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/OutputState.java	Fri Sep 28 12:14:00 2012 +0200
@@ -0,0 +1,60 @@
+/*
+ * Copyright (c) 2010 by Intevation GmbH
+ *
+ * This program is free software under the LGPL (>=v2.1)
+ * Read the file LGPL.txt coming with the software for details
+ * or visit http://www.gnu.org/licenses/ if it does not exist.
+ */
+
+package de.intevation.gnv.state;
+
+import de.intevation.artifacts.CallContext;
+
+import de.intevation.gnv.state.exception.StateException;
+
+import java.io.OutputStream;
+
+import java.util.Collection;
+
+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
+{
+
+    /**
+     * Returns the Rendered Result of an State.
+     *
+     * @param format
+     * @param inputData
+     * @param outputStream
+     * @param uuid
+     * @param callContext
+     * @throws StateException
+     */
+    public void out(
+        Document              format,
+        Collection<InputData> inputData,
+        OutputStream          outputStream,
+        String                uuid,
+        CallContext           callContext
+    ) throws StateException;
+
+    /**
+     * Delivers the provided OutputModes of an State
+     *
+     * @return the provided OutputModes of an State
+     */
+    public Collection<OutputMode> getOutputModes();
+}
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org