Mercurial > dive4elements > river
comparison gwt-client/src/main/java/org/dive4elements/river/client/shared/model/Data.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/Data.java@821a02bbfb4e |
| children | 172338b1407f |
comparison
equal
deleted
inserted
replaced
| 5837:d9901a08d0a6 | 5838:5aa05a7a34b7 |
|---|---|
| 1 package org.dive4elements.river.client.shared.model; | |
| 2 | |
| 3 import java.io.Serializable; | |
| 4 | |
| 5 | |
| 6 /** | |
| 7 * A Data object represents the necessary data of a single state of the | |
| 8 * artifact. It might provide several DataItems or just a single DataItem. The | |
| 9 * <code>type</code> makes it possible to validate the input in the client. | |
| 10 * | |
| 11 * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a> | |
| 12 */ | |
| 13 public interface Data extends Serializable { | |
| 14 | |
| 15 /** | |
| 16 * Returns the label of the item. | |
| 17 * | |
| 18 * @return the label. | |
| 19 */ | |
| 20 public String getLabel(); | |
| 21 | |
| 22 | |
| 23 /** | |
| 24 * Returns the description of the item. | |
| 25 * | |
| 26 * @return the description. | |
| 27 */ | |
| 28 public String getDescription(); | |
| 29 | |
| 30 | |
| 31 /** | |
| 32 * Returns the type of the item. | |
| 33 * | |
| 34 * @return the type. | |
| 35 */ | |
| 36 public String getType(); | |
| 37 | |
| 38 | |
| 39 /** | |
| 40 * Returns the DataItems provided by this Data object. | |
| 41 * | |
| 42 * @return the DataItems. | |
| 43 */ | |
| 44 public DataItem[] getItems(); | |
| 45 | |
| 46 | |
| 47 /** | |
| 48 * Returns the default value of this data object. | |
| 49 * | |
| 50 * @return the default value. | |
| 51 */ | |
| 52 public DataItem getDefault(); | |
| 53 | |
| 54 | |
| 55 /** | |
| 56 * Returns the values as colon separated string. | |
| 57 * | |
| 58 * @return colon separated string. | |
| 59 */ | |
| 60 public String getStringValue(); | |
| 61 } | |
| 62 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |