    001    //$HeadURL: https://svn.wald.intevation.org/svn/deegree/base/branches/2.4_testing/src/org/deegree/ogcwebservices/wms/configuration/WMSConfigurationType.java $
    002    /*----------------------------------------------------------------------------
    003     This file is part of deegree, http://deegree.org/
    004     Copyright (C) 2001-2009 by:
    005       Department of Geography, University of Bonn
    006     and
    007       lat/lon GmbH
    008
    009     This library is free software; you can redistribute it and/or modify it under
    010     the terms of the GNU Lesser General Public License as published by the Free
    011     Software Foundation; either version 2.1 of the License, or (at your option)
    012     any later version.
    013     This library is distributed in the hope that it will be useful, but WITHOUT
    014     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    015     FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
    016     details.
    017     You should have received a copy of the GNU Lesser General Public License
    018     along with this library; if not, write to the Free Software Foundation, Inc.,
    019     59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
    020
    021     Contact information:
    022
    023     lat/lon GmbH
    024     Aennchenstr. 19, 53177 Bonn
    025     Germany
    026     http://lat-lon.de/
    027
    028     Department of Geography, University of Bonn
    029     Prof. Dr. Klaus Greve
    030     Postfach 1147, 53001 Bonn
    031     Germany
    032     http://www.geographie.uni-bonn.de/deegree/
    033
    034     e-mail: info@deegree.org
    035    ----------------------------------------------------------------------------*/
    036    package org.deegree.ogcwebservices.wms.configuration;
    037
    038    import java.net.URL;
    039    import java.util.List;
    040
    041    import org.deegree.ogcwebservices.wms.capabilities.Layer;
    042    import org.deegree.owscommon_new.OperationsMetadata;
    043    import org.deegree.owscommon_new.ServiceIdentification;
    044
    045    /**
    046     * <code>WMSConfigurationType</code> defines the methods that each WMS configuration object has to
    047     * implement. It is used to unify the implementations for the different versions.
    048     *
    049     * @author <a href="mailto:schmitz@lat-lon.de">Andreas Schmitz</a>
    050     * @author last edited by: $Author: mschneider $
    051     *
    052     * @version 2.0, $Revision: 18195 $, $Date: 2009-06-18 17:55:39 +0200 (Do, 18. Jun 2009) $
    053     *
    054     * @since 2.0
    055     */
    056
    057    public interface WMSConfigurationType {
    058
    059        /**
    060         * @return Returns the deegreeParams.
    061         */
    062        public WMSDeegreeParams getDeegreeParams();
    063
    064        /**
    065         * @param deegreeParams
    066         *            The deegreeParams to set.
    067         */
    068        public void setDeegreeParams( WMSDeegreeParams deegreeParams );
    069
    070        /**
    071         * @return Gets the base URL which is used to resolve file resource (XSL sheets).
    072         */
    073        public URL getBaseURL();
    074
    075        /**
    076         * @return the version
    077         */
    078        public String getVersion();
    079
    080        /**
    081         * @return the <code>ServiceIdentification</code> object
    082         */
    083        public ServiceIdentification getServiceIdentification();
    084
    085        /**
    086         * @return the updateSequence.
    087         */
    088        public String getUpdateSequence();
    089
    090        /**
    091         *
    092         * @return the root layer provided by a WMS
    093         */
    094        public Layer getLayer();
    095
    096        /**
    097         *
    098         * @param name
    099         *            the layer name
    100         * @return the layer provided by a WMS or null, if there is no such layer
    101         */
    102        public Layer getLayer( String name );
    103
    104        /**
    105         * @return the operations metadata object
    106         */
    107        public OperationsMetadata getOperationMetadata();
    108
    109        /**
    110         *
    111         * @param version
    112         *            the input version
    113         * @return the nearest supported version according to the version negotiation rules.
    114         */
    115        public String calculateVersion( String version );
    116
    117        /**
    118         * @return the list of available exceptions
    119         */
    120        public List<String> getExceptions();
    121
    122    }