Mercurial > dive4elements > gnv-client
changeset 957:33fb5bf4e62c
Add more Javadoc
gnv/trunk@1101 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Tim Englich <tim.englich@intevation.de> |
---|---|
date | Tue, 18 May 2010 09:26:11 +0000 |
parents | b8776cd58977 |
children | d5d4dbda17cc |
files | gnv/ChangeLog gnv/src/main/java/de/intevation/gnv/artifactdatabase/client/ArtifactDatabaseClient.java |
diffstat | 2 files changed, 27 insertions(+), 11 deletions(-) [+] |
line wrap: on
line diff
--- a/gnv/ChangeLog Tue May 18 09:21:00 2010 +0000 +++ b/gnv/ChangeLog Tue May 18 09:26:11 2010 +0000 @@ -1,3 +1,8 @@ +2010-05-18 Tim Englich <tim.englich@intevation.de> + + * src/main/java/de/intevation/gnv/artifactdatabase/client/ArtifactDatabaseClient.java (doAdvance): + Added more Javadoc. + 2010-05-18 Tim Englich <tim.englich@intevation.de> * src/main/java/de/intevation/gnv/artifactdatabase/package.html:
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/client/ArtifactDatabaseClient.java Tue May 18 09:21:00 2010 +0000 +++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/client/ArtifactDatabaseClient.java Tue May 18 09:26:11 2010 +0000 @@ -1,24 +1,21 @@ package de.intevation.gnv.artifactdatabase.client; +import java.io.IOException; +import java.io.OutputStream; +import java.util.Collection; +import java.util.Locale; + +import org.w3c.dom.Document; + import de.intevation.gnv.artifactdatabase.client.exception.ArtifactDatabaseClientException; import de.intevation.gnv.artifactdatabase.client.exception.ArtifactDatabaseInputException; - import de.intevation.gnv.artifactdatabase.objects.ArtifactDescription; import de.intevation.gnv.artifactdatabase.objects.ArtifactFactory; import de.intevation.gnv.artifactdatabase.objects.ArtifactObject; import de.intevation.gnv.artifactdatabase.objects.ArtifactStatisticsSet; import de.intevation.gnv.artifactdatabase.objects.InputParameter; - import de.intevation.gnv.artifactdatabase.objects.map.MapService; -import java.io.IOException; -import java.io.OutputStream; - -import java.util.Collection; -import java.util.Locale; - -import org.w3c.dom.Document; - /** * This interface describes basic methods for the communication between artifact * server and this client. @@ -91,11 +88,25 @@ Collection<InputParameter> inputParameter) throws ArtifactDatabaseClientException, ArtifactDatabaseInputException; + /** + * Calls the advancecommand for the given Artifact at the Artifactdatabase. + * Stepping to the given target using the given Artifactfactory + * @param factory the Factory which provide the information about which + * Artifactdatabase has to be called. + * @param artifact the Artifact which should be moved to the next state. + * @param target the Id of the next State which should the artifact should + * be moved to. + * @throws IOException + * @throws ArtifactDatabaseClientException + * @throws ArtifactDatabaseInputException + */ public void doAdvance( ArtifactObject factory, ArtifactObject artifact, String target) - throws IOException, ArtifactDatabaseClientException, ArtifactDatabaseInputException; + throws IOException, + ArtifactDatabaseClientException, + ArtifactDatabaseInputException; /** * @param artifactFactory