ingo@1115: /*
ingo@1115:  * Copyright (c) 2010 by Intevation GmbH
ingo@1115:  *
ingo@1115:  * This program is free software under the LGPL (>=v2.1)
ingo@1115:  * Read the file LGPL.txt coming with the software for details
ingo@1115:  * or visit http://www.gnu.org/licenses/ if it does not exist.
ingo@1115:  */
ingo@1115: 
tim@335: package de.intevation.gnv.state.describedata;
tim@335: 
tim@335: import java.io.Serializable;
tim@335: 
tim@335: /**
ingo@809:  * This interface defines some methods to retrieve a key-value pair, a state
ingo@809:  * this data belongs to and a boolean property, if this data have been selected.
sascha@835:  *
sascha@780:  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
tim@335:  */
tim@335: public interface KeyValueDescibeData extends Serializable {
tim@335: 
ingo@809:     /**
ingo@809:      * Returns the key of this data object.
sascha@835:      *
ingo@809:      * @return the key.
ingo@809:      */
tim@335:     public String getKey();
tim@335: 
ingo@809:     /**
ingo@809:      * Returns the value of this data object.
ingo@809:      *
ingo@809:      * @return the value.
ingo@809:      */
tim@335:     public String getValue();
tim@335: 
ingo@809:     /**
ingo@809:      * Returns the state of this data object.
ingo@809:      *
ingo@809:      * @return the state.
ingo@809:      */
ingo@473:     public String getState();
ingo@473: 
ingo@809:     /**
ingo@809:      * Returns a boolean which defines, if this data pair has been selected or
ingo@809:      * not.
ingo@809:      *
ingo@809:      * @return true, if this pair has been selected - otherwise false.
ingo@809:      */
tim@335:     public boolean isSelected();
tim@335: 
ingo@809:     /**
ingo@809:      * Method to change the selection of this data object.
ingo@809:      *
ingo@809:      * @param selected Set this value to true, if you want to select this data
ingo@809:      * object - set it to false, if you want to unselect it.
ingo@809:      */
tim@335:     public void setSelected(boolean selected);
tim@335: }
sascha@836: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :