Mercurial > dive4elements > river
diff gwt-client/src/main/java/org/dive4elements/river/client/shared/model/ArtifactDescription.java @ 5838:5aa05a7a34b7
Rename modules to more fitting names.
author | Sascha L. Teichmann <teichmann@intevation.de> |
---|---|
date | Thu, 25 Apr 2013 15:23:37 +0200 |
parents | flys-client/src/main/java/org/dive4elements/river/client/shared/model/ArtifactDescription.java@821a02bbfb4e |
children | 172338b1407f |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/gwt-client/src/main/java/org/dive4elements/river/client/shared/model/ArtifactDescription.java Thu Apr 25 15:23:37 2013 +0200 @@ -0,0 +1,98 @@ +package org.dive4elements.river.client.shared.model; + +import java.io.Serializable; + + +/** + * The artifact description describes a state of an artifact. There are + * operations defined that return former inserted data, possible input values + * and output targets that are available in the current state of the artifact. + * + * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> + */ +public interface ArtifactDescription extends Serializable { + + /** + * Returns the data that have been inserted in former states of the + * artifact. + * + * @return the old data of former states. + */ + public DataList[] getOldData(); + + + /** + * Returns the data with all its options that might be inserted in the + * current state of the artifact. + * + * @return the current data. + */ + public DataList getCurrentData(); + + + /** + * Returns the current state as string. + * + * @return the current state. + */ + public String getCurrentState(); + + + /** + * Returns the reachable states as string. + * + * @return the reachable states. + */ + public String[] getReachableStates(); + + + /** + * Returns the name of the selected river. + * + * @return the selected river. + */ + public String getRiver(); + + + /** + * Returns the selected min and max kilomter if existing otherwise null. + * + * @return an array of [min-km, max-km] if existing otherwise null. + */ + public double[] getKMRange(); + + + /** + * Returns the selected reference gauge (which needs to be a data named + * 'reference_gauge'. + * + * @return the selected reference gauge (which needs to be a data named + * 'reference_gauge'. + */ + public String getReferenceGauge(); + + + /** + * Returns the string value of a data object with name <i>dataName</i>. + * + * @return the string value of a data object with name <i>dataName</i>. + */ + public String getDataValueAsString(String dataName); + + + /** + * Returns the available output modes. + * + * @return the available output modes. + */ + public OutputMode[] getOutputModes(); + + + /** + * Returns the recommended artifacts suggested by the server. + * + * @return the recommended artifacts. + */ + public Recommendation[] getRecommendations(); +} +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :