Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/KeyValueDescibeData.java @ 809:d05b17a4f3d0
Added javadoc in describedata package.
gnv-artifacts/trunk@891 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
|---|---|
| date | Fri, 09 Apr 2010 07:27:38 +0000 |
| parents | c4156275c1e1 |
| children | 2423cefe7d39 |
comparison
equal
deleted
inserted
replaced
| 808:2e951160c43d | 809:d05b17a4f3d0 |
|---|---|
| 1 package de.intevation.gnv.state.describedata; | 1 package de.intevation.gnv.state.describedata; |
| 2 | 2 |
| 3 import java.io.Serializable; | 3 import java.io.Serializable; |
| 4 | 4 |
| 5 /** | 5 /** |
| 6 * This interface defines some methods to retrieve a key-value pair, a state | |
| 7 * this data belongs to and a boolean property, if this data have been selected. | |
| 8 * | |
| 6 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | 9 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
| 7 * | |
| 8 */ | 10 */ |
| 9 public interface KeyValueDescibeData extends Serializable { | 11 public interface KeyValueDescibeData extends Serializable { |
| 10 | 12 |
| 13 /** | |
| 14 * Returns the key of this data object. | |
| 15 * | |
| 16 * @return the key. | |
| 17 */ | |
| 11 public String getKey(); | 18 public String getKey(); |
| 12 | 19 |
| 20 /** | |
| 21 * Returns the value of this data object. | |
| 22 * | |
| 23 * @return the value. | |
| 24 */ | |
| 13 public String getValue(); | 25 public String getValue(); |
| 14 | 26 |
| 27 /** | |
| 28 * Returns the state of this data object. | |
| 29 * | |
| 30 * @return the state. | |
| 31 */ | |
| 15 public String getState(); | 32 public String getState(); |
| 16 | 33 |
| 34 /** | |
| 35 * Returns a boolean which defines, if this data pair has been selected or | |
| 36 * not. | |
| 37 * | |
| 38 * @return true, if this pair has been selected - otherwise false. | |
| 39 */ | |
| 17 public boolean isSelected(); | 40 public boolean isSelected(); |
| 18 | 41 |
| 42 /** | |
| 43 * Method to change the selection of this data object. | |
| 44 * | |
| 45 * @param selected Set this value to true, if you want to select this data | |
| 46 * object - set it to false, if you want to unselect it. | |
| 47 */ | |
| 19 public void setSelected(boolean selected); | 48 public void setSelected(boolean selected); |
| 20 | |
| 21 } | 49 } |
| 50 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |