Mercurial > dive4elements > framework
comparison 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 |
comparison
equal
deleted
inserted
replaced
| 77:48d1a9a082c2 | 78:55eefe63a777 |
|---|---|
| 2 | 2 |
| 3 import java.io.Serializable; | 3 import java.io.Serializable; |
| 4 | 4 |
| 5 import org.w3c.dom.Document; | 5 import org.w3c.dom.Document; |
| 6 import org.w3c.dom.Node; | 6 import org.w3c.dom.Node; |
| 7 | |
| 7 /** | 8 /** |
| 9 * A factory which an XML in/XML out service which reachable through the | |
| 10 * artifact database. | |
| 8 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> | 11 * @author <a href="mailto:sascha.teichmann@intevation.de">Sascha L. Teichmann</a> |
| 9 */ | 12 */ |
| 10 public interface ServiceFactory | 13 public interface ServiceFactory |
| 11 extends Serializable | 14 extends Serializable |
| 12 { | 15 { |
| 16 /** | |
| 17 * The name of the service which is created by this factory. | |
| 18 * @return The name of the created service. | |
| 19 */ | |
| 13 String getName(); | 20 String getName(); |
| 14 | 21 |
| 22 /** | |
| 23 * The description of the service which is created by this factory. | |
| 24 * @return The description. | |
| 25 */ | |
| 15 String getDescription(); | 26 String getDescription(); |
| 16 | 27 |
| 28 /** | |
| 29 * Creates the service. This is done at startup time of the | |
| 30 * artifact database system. | |
| 31 * @param globalContext The global context of the artifact database. | |
| 32 * @return The created service. | |
| 33 */ | |
| 17 Service createService(Object globalContext); | 34 Service createService(Object globalContext); |
| 18 | 35 |
| 36 /** | |
| 37 * Configures this factory. This is called before | |
| 38 * #createService(Object). | |
| 39 * @param config The global configuration document of the artifact | |
| 40 * database system. | |
| 41 * @param factoryNode The node inside the configuration document which | |
| 42 * corresponds to this factory. | |
| 43 */ | |
| 19 void setup(Document config, Node factoryNode); | 44 void setup(Document config, Node factoryNode); |
| 20 } | 45 } |
| 21 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : | 46 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |