teichmann@5861: /* Copyright (C) 2011, 2012, 2013 by Bundesanstalt für Gewässerkunde
teichmann@5861:  * Software engineering by Intevation GmbH
teichmann@5861:  *
teichmann@5861:  * This file is Free Software under the GNU AGPL (>=v3) 
teichmann@5861:  * and comes with ABSOLUTELY NO WARRANTY! Check out the
teichmann@5861:  * documentation coming with Dive4Elements River for details. 
teichmann@5861:  */
teichmann@5861: 
teichmann@5835: package org.dive4elements.river.client.shared.model;
ingo@8: 
ingo@12: import java.io.Serializable;
ingo@12: 
ingo@8: 
ingo@8: /**
ingo@8:  * A Data object represents the necessary data of a single state of the
ingo@8:  * artifact. It might provide several DataItems or just a single DataItem. The
ingo@8:  * <code>type</code> makes it possible to validate the input in the client.
ingo@8:  *
ingo@8:  * @author <a href="mailto:ingo.weinzierl@intevation.de">Ingo Weinzierl</a>
ingo@8:  */
ingo@12: public interface Data extends Serializable {
ingo@8: 
ingo@8:     /**
ingo@8:      * Returns the label of the item.
ingo@8:      *
ingo@8:      * @return the label.
ingo@8:      */
ingo@8:     public String getLabel();
ingo@8: 
ingo@8: 
ingo@8:     /**
ingo@8:      * Returns the description of the item.
ingo@8:      *
ingo@8:      * @return the description.
ingo@8:      */
ingo@8:     public String getDescription();
ingo@8: 
ingo@8: 
ingo@8:     /**
ingo@8:      * Returns the type of the item.
ingo@8:      *
ingo@8:      * @return the type.
ingo@8:      */
ingo@8:     public String getType();
ingo@8: 
ingo@8: 
ingo@8:     /**
ingo@8:      * Returns the DataItems provided by this Data object.
ingo@8:      *
ingo@8:      * @return the DataItems.
ingo@8:      */
ingo@8:     public DataItem[] getItems();
ingo@514: 
ingo@514: 
ingo@514:     /**
ingo@514:      * Returns the default value of this data object.
ingo@514:      *
ingo@514:      * @return the default value.
ingo@514:      */
ingo@514:     public DataItem getDefault();
raimund@2535: 
raimund@2535: 
raimund@2535:     /**
raimund@2535:      * Returns the values as colon separated string.
raimund@2535:      *
raimund@2535:      * @return colon separated string.
raimund@2535:      */
raimund@2535:     public String getStringValue();
ingo@8: }
ingo@8: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :