diff artifacts/src/main/java/de/intevation/artifacts/ServiceFactory.java @ 78:55eefe63a777

Repaired the javadoc stuff for almost all artifact interfaces. artifacts/trunk@760 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Thu, 11 Mar 2010 10:53:59 +0000
parents 48d1a9a082c2
children 933bbc9fc11f
line wrap: on
line diff
--- a/artifacts/src/main/java/de/intevation/artifacts/ServiceFactory.java	Sun Feb 21 23:05:32 2010 +0000
+++ b/artifacts/src/main/java/de/intevation/artifacts/ServiceFactory.java	Thu Mar 11 10:53:59 2010 +0000
@@ -4,18 +4,43 @@
 
 import org.w3c.dom.Document;
 import org.w3c.dom.Node;
+
 /**
+ * A factory which an XML in/XML out service which reachable through the
+ * artifact database.
  * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a>
  */
 public interface ServiceFactory
 extends          Serializable
 {
+    /**
+     * The name of the service which is created by this factory.
+     * @return The name of the created service.
+     */
     String getName();
 
+    /**
+     * The description of the service which is created by this factory.
+     * @return The description.
+     */
     String getDescription();
 
+    /**
+     * Creates the service. This is done at startup time of the
+     * artifact database system.
+     * @param globalContext The global context of the artifact database.
+     * @return The created service.
+     */
     Service createService(Object globalContext);
 
+    /**
+     * Configures this factory. This is called before
+     * #createService(Object).
+     * @param config The global configuration document of the artifact
+     * database system.
+     * @param factoryNode The node inside the configuration document which
+     * corresponds to this factory.
+     */
     void setup(Document config, Node factoryNode);
 }
 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org