Mercurial > dive4elements > gnv-client
diff 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 |
line wrap: on
line diff
--- a/gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/KeyValueDescibeData.java Thu Apr 08 16:35:02 2010 +0000 +++ b/gnv-artifacts/src/main/java/de/intevation/gnv/state/describedata/KeyValueDescibeData.java Fri Apr 09 07:27:38 2010 +0000 @@ -3,19 +3,48 @@ import java.io.Serializable; /** + * This interface defines some methods to retrieve a key-value pair, a state + * this data belongs to and a boolean property, if this data have been selected. + * * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> - * */ public interface KeyValueDescibeData extends Serializable { + /** + * Returns the key of this data object. + * + * @return the key. + */ public String getKey(); + /** + * Returns the value of this data object. + * + * @return the value. + */ public String getValue(); + /** + * Returns the state of this data object. + * + * @return the state. + */ public String getState(); + /** + * Returns a boolean which defines, if this data pair has been selected or + * not. + * + * @return true, if this pair has been selected - otherwise false. + */ public boolean isSelected(); + /** + * Method to change the selection of this data object. + * + * @param selected Set this value to true, if you want to select this data + * object - set it to false, if you want to unselect it. + */ public void setSelected(boolean selected); - } +// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : \ No newline at end of file