Mercurial > dive4elements > river
comparison flys-client/src/main/java/org/dive4elements/river/client/shared/model/ArtifactDescription.java @ 5834:f507086aa94b
Repaired internal references.
| author | Sascha L. Teichmann <teichmann@intevation.de> |
|---|---|
| date | Thu, 25 Apr 2013 12:31:32 +0200 |
| parents | flys-client/src/main/java/de/intevation/flys/client/shared/model/ArtifactDescription.java@5b8919ef601d |
| children | 821a02bbfb4e |
comparison
equal
deleted
inserted
replaced
| 5833:a2bdc0f524e8 | 5834:f507086aa94b |
|---|---|
| 1 package de.intevation.flys.client.shared.model; | |
| 2 | |
| 3 import java.io.Serializable; | |
| 4 | |
| 5 | |
| 6 /** | |
| 7 * The artifact description describes a state of an artifact. There are | |
| 8 * operations defined that return former inserted data, possible input values | |
| 9 * and output targets that are available in the current state of the artifact. | |
| 10 * | |
| 11 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> | |
| 12 */ | |
| 13 public interface ArtifactDescription extends Serializable { | |
| 14 | |
| 15 /** | |
| 16 * Returns the data that have been inserted in former states of the | |
| 17 * artifact. | |
| 18 * | |
| 19 * @return the old data of former states. | |
| 20 */ | |
| 21 public DataList[] getOldData(); | |
| 22 | |
| 23 | |
| 24 /** | |
| 25 * Returns the data with all its options that might be inserted in the | |
| 26 * current state of the artifact. | |
| 27 * | |
| 28 * @return the current data. | |
| 29 */ | |
| 30 public DataList getCurrentData(); | |
| 31 | |
| 32 | |
| 33 /** | |
| 34 * Returns the current state as string. | |
| 35 * | |
| 36 * @return the current state. | |
| 37 */ | |
| 38 public String getCurrentState(); | |
| 39 | |
| 40 | |
| 41 /** | |
| 42 * Returns the reachable states as string. | |
| 43 * | |
| 44 * @return the reachable states. | |
| 45 */ | |
| 46 public String[] getReachableStates(); | |
| 47 | |
| 48 | |
| 49 /** | |
| 50 * Returns the name of the selected river. | |
| 51 * | |
| 52 * @return the selected river. | |
| 53 */ | |
| 54 public String getRiver(); | |
| 55 | |
| 56 | |
| 57 /** | |
| 58 * Returns the selected min and max kilomter if existing otherwise null. | |
| 59 * | |
| 60 * @return an array of [min-km, max-km] if existing otherwise null. | |
| 61 */ | |
| 62 public double[] getKMRange(); | |
| 63 | |
| 64 | |
| 65 /** | |
| 66 * Returns the selected reference gauge (which needs to be a data named | |
| 67 * 'reference_gauge'. | |
| 68 * | |
| 69 * @return the selected reference gauge (which needs to be a data named | |
| 70 * 'reference_gauge'. | |
| 71 */ | |
| 72 public String getReferenceGauge(); | |
| 73 | |
| 74 | |
| 75 /** | |
| 76 * Returns the string value of a data object with name <i>dataName</i>. | |
| 77 * | |
| 78 * @return the string value of a data object with name <i>dataName</i>. | |
| 79 */ | |
| 80 public String getDataValueAsString(String dataName); | |
| 81 | |
| 82 | |
| 83 /** | |
| 84 * Returns the available output modes. | |
| 85 * | |
| 86 * @return the available output modes. | |
| 87 */ | |
| 88 public OutputMode[] getOutputModes(); | |
| 89 | |
| 90 | |
| 91 /** | |
| 92 * Returns the recommended artifacts suggested by the server. | |
| 93 * | |
| 94 * @return the recommended artifacts. | |
| 95 */ | |
| 96 public Recommendation[] getRecommendations(); | |
| 97 } | |
| 98 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |