Mercurial > dive4elements > gnv-client
annotate gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ParametrizedArtifactObject.java @ 958:d5d4dbda17cc
Add more Javadocs
gnv/trunk@1102 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author | Tim Englich <tim.englich@intevation.de> |
---|---|
date | Tue, 18 May 2010 09:51:41 +0000 |
parents | 89ade245ca7a |
children | 28a0628b11b0 |
rev | line source |
---|---|
558
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
1 package de.intevation.gnv.artifactdatabase.objects; |
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
2 |
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
3 import java.util.Collection; |
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
4 import java.util.Map; |
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
5 |
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
6 /** |
693
d4d1eb56d725
Added more JavaDocs
Tim Englich <tim.englich@intevation.de>
parents:
690
diff
changeset
|
7 * Interface which extends the funtionality of the Interface |
699
af22fa5567a6
Removed trailing whitespace.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
693
diff
changeset
|
8 * <code>ArtifactObject</code> with methods for storing and retrieving |
693
d4d1eb56d725
Added more JavaDocs
Tim Englich <tim.englich@intevation.de>
parents:
690
diff
changeset
|
9 * optional Parameters. |
684
57fa8019fbdc
Bring @author javadoc tags in form '@author <a href="john.doe@example.com">John Doe</a>'
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
683
diff
changeset
|
10 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
558
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
11 */ |
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
12 public interface ParametrizedArtifactObject extends ArtifactObject { |
681
15ac78a91d1b
Removed trailing whitespace.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
558
diff
changeset
|
13 |
558
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
14 /** |
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
15 * Returns the Parameters which could be used to manage (e.g. create) an |
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
16 * ArtifactObject. |
690
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
17 * @return a map storing parameters. |
558
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
18 */ |
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
19 Map<String, Collection<String>> getParameters(); |
681
15ac78a91d1b
Removed trailing whitespace.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
558
diff
changeset
|
20 |
690
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
21 /** |
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
22 * Add a further parameter to the parameter map. |
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
23 * |
693
d4d1eb56d725
Added more JavaDocs
Tim Englich <tim.englich@intevation.de>
parents:
690
diff
changeset
|
24 * @param key the Key of the Parameter (unique) |
d4d1eb56d725
Added more JavaDocs
Tim Englich <tim.englich@intevation.de>
parents:
690
diff
changeset
|
25 * @param values the Values of the Parameter |
690
254f062e334b
Added JavaDoc.
Ingo Weinzierl <ingo.weinzierl@intevation.de>
parents:
684
diff
changeset
|
26 */ |
558
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
27 void addParameters(String key, Collection<String> values); |
8032da9e8b70
Added further business logic for the MapViewer-Interface
Tim Englich <tim.englich@intevation.de>
parents:
diff
changeset
|
28 } |
700
89ade245ca7a
Using unix line endings only.
Sascha L. Teichmann <sascha.teichmann@intevation.de>
parents:
699
diff
changeset
|
29 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |