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;
bjoern@3713: 
bjoern@3713: import java.io.Serializable;
bjoern@3713: import java.util.List;
bjoern@3713: 
bjoern@3713: /**
bjoern@3713:  * @author <a href="mailto:bjoern.ricks@intevation.de">Björn Ricks</a>
bjoern@3713:  */
bjoern@3713: 
bjoern@3713: public interface RiverInfo extends Serializable {
bjoern@3713: 
bjoern@3713:     boolean isKmUp();
bjoern@3713: 
bjoern@3713:     /**
bjoern@3713:      * Start KM of the river
bjoern@3713:      */
bjoern@3713:     Double getKmStart();
bjoern@3713: 
bjoern@3713:     /**
bjoern@3713:      * End KM of the river
bjoern@3713:      */
bjoern@3713:     Double getKmEnd();
bjoern@3713: 
bjoern@3713:     /**
bjoern@3713:      * Returns the name of the river
bjoern@3713:      */
bjoern@3713:     String getName();
bjoern@3713: 
bjoern@3713:     /**
bjoern@3713:      * Returns the name of the WST unit
bjoern@3713:      */
bjoern@3713:     String getWstUnit();
bjoern@3713: 
bjoern@3713:     /**
bjoern@3713:      * Return all gauge info of the river
bjoern@3713:      */
bjoern@3713:     List<GaugeInfo> getGauges();
bjoern@3713: 
bjoern@3713:     /**
bjoern@3713:      * Returns the min q value of the river
bjoern@3713:      */
bjoern@3713:     Double getMinQ();
bjoern@3713: 
bjoern@3713:     /**
bjoern@3713:      * Returns the max q value of the river
bjoern@3713:      */
bjoern@3713:     Double getMaxQ();
bjoern@3838: 
bjoern@3838:     /**
bjoern@3847:      * Returns the official number of the river
bjoern@3838:      */
bjoern@3847:     Long getOfficialNumber();
bjoern@4249: 
bjoern@4249:     /**
bjoern@4249:      * Returns the MeasurementStations on this river or null if they aren't
bjoern@4249:      * available.
bjoern@4249:      */
bjoern@4249:     List<MeasurementStation> getMeasurementStations();
bjoern@3713: }
bjoern@3713: 
bjoern@3713: