--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/client/ArtifactDatabaseClient.java	Mon Apr 12 10:56:55 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/client/ArtifactDatabaseClient.java	Mon Apr 12 16:45:16 2010 +0000
@@ -20,6 +20,9 @@
 import org.w3c.dom.Document;
 
 /**
+ * This interface describes basic methods for the communication between artifact
+ * server and this client.
+ * 
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
  */
@@ -33,25 +36,36 @@
      * Return the Artifactfactories which can be resolved.
      *
      * @return the Artifactfactories which can be resolved.
-     * @throws ArtifactDatabaseClientException
+     * @throws ArtifactDatabaseClientException if a general error occured in the
+     * artifact server.
+     * @throws ArtifactDatabaseInputException if the input data was valid.
      */
     public Collection<ArtifactObject> getArtifactFactories()
     throws ArtifactDatabaseClientException, ArtifactDatabaseInputException;
 
     /**
-     *
+     * Call the create operation of the artifact server and returns a new
+     * artifact with the information returned by the artifact server.
+     * 
      * @param artifactFactory
      * @return the new Artifact
-     * @throws ArtifactDatabaseClientException
+     * @throws ArtifactDatabaseClientException if a general error occured in the
+     * artifact server.
+     * @throws ArtifactDatabaseInputException if the input data was valid.
      */
     public ArtifactObject createNewArtifact(ArtifactObject artifactFactory)
     throws ArtifactDatabaseClientException, ArtifactDatabaseInputException;
 
     /**
+     * Call the describe operation of the artifact server.
      *
+     * @param artifactFactory
      * @param currentArtifact
+     * @param includeUI 
      * @return the Current Artifact
-     * @throws ArtifactDatabaseClientException
+     * @throws ArtifactDatabaseClientException if a general error occured in the
+     * artifact server.
+     * @throws ArtifactDatabaseInputException if the input data was valid.
      */
     public ArtifactDescription getCurrentStepDescription(
         ArtifactObject artifactFactory,
@@ -65,8 +79,10 @@
      * @param currentArtifact
      * @param target
      * @param inputParameter
-     * @return
-     * @throws ArtifactDatabaseClientException
+     * @return the artifact description.
+     * @throws ArtifactDatabaseClientException if a general error occured in the
+     * artifact server.
+     * @throws ArtifactDatabaseInputException if the input data was valid.
      */
     public ArtifactDescription doNextStep(
         ArtifactObject artifactFactory,
@@ -85,8 +101,9 @@
      * @param artifactFactory
      * @param currentArtifact
      * @param inputParameter
-     * @return
-     * @throws ArtifactDatabaseClientException
+     * @throws ArtifactDatabaseClientException if a general error occured in the
+     * artifact server.
+     * @throws ArtifactDatabaseInputException if the input data was valid.
      */
     public void doFeed(ArtifactObject artifactFactory,
         ArtifactObject currentArtifact,
@@ -94,12 +111,15 @@
     throws ArtifactDatabaseClientException, ArtifactDatabaseInputException;
 
     /**
+     * Call the out operation of the artifact server.
      *
      * @param artifactFactory
      * @param currentArtifact
      * @param stream
      * @param targetName
+     * @param exportMode
      * @param mimeType
+     * @param inputParameter 
      * @throws ArtifactDatabaseClientException
      */
     public void doOutput(
@@ -113,6 +133,14 @@
     throws ArtifactDatabaseClientException;
 
 
+    /**
+     * Write the current artifact to an xml file.
+     * 
+     * @param artifactFactory
+     * @param currentArtifact
+     * @param out
+     * @throws ArtifactDatabaseClientException
+     */
     public void doExport(
         ArtifactObject artifactFactory,
         ArtifactObject currentArtifact,
@@ -120,15 +148,31 @@
     throws ArtifactDatabaseClientException;
 
 
+    /**
+     * Import an artifact from xml file.
+     * 
+     * @param factory
+     * @param document
+     * @return a status message. If the import was successful, it contains
+     * information about the imported artifact, otherwise a failure is
+     * contained.
+     * @throws ArtifactDatabaseClientException
+     * @throws IOException
+     */
     public Document doImport(
         ArtifactFactory factory,
         Document        document)
     throws ArtifactDatabaseClientException, IOException;
 
     /**
+     * Publish shapefiles of an artifact as WMS layer.
+     * 
      * @param factory
      * @param artifact
+     * @param inputParameter 
      * @return URL to wms service as string
+     * @throws ArtifactDatabaseClientException
+     * @throws ArtifactDatabaseInputException 
      */
     public Document publishWMS(
         ArtifactObject             factory,
@@ -138,18 +182,35 @@
 
 
     /**
+     * Start statistics calculation.
+     * 
      * @param artifactFactory
      * @param currentArtifact
-     * @return
+     * @return the calculated statistic.
      * @throws ArtifactDatabaseClientException
      */
     public Collection<ArtifactStatisticsSet> calculateStatistics(
-                                                                  ArtifactObject artifactFactory,
-                                                                  ArtifactObject currentArtifact)
-                                                                                                 throws ArtifactDatabaseClientException;
+        ArtifactObject artifactFactory,
+        ArtifactObject currentArtifact)
+    throws ArtifactDatabaseClientException;
 
+    /**
+     * Set the current locale.
+     * @param locale
+     */
     public void setLocale(Locale locale);
 
+    /**
+     * Returns some meta information about the currently selected
+     * ArtifactFactory.
+     *
+     * @param mapServices
+     * @param geometry
+     * @param srs
+     * @return the information.
+     * @throws ArtifactDatabaseClientException
+     * @throws ArtifactDatabaseInputException
+     */
     public Collection<ArtifactObject> getArtifactFactoryMetaInformation(
         Collection<MapService> mapServices,
         String                 geometry,
@@ -157,3 +218,4 @@
     throws ArtifactDatabaseClientException, ArtifactDatabaseInputException;
 
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :
\ No newline at end of file