view gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/MapService.java @ 826:32d01e1ce2df

Added more JavaDocs gnv-artifacts/trunk@920 c6561f87-3c4e-4783-a992-168aeb5c3f6f
author Tim Englich <tim.englich@intevation.de>
date Tue, 13 Apr 2010 12:32:24 +0000
parents feae2f9d6c6f
children 05bf8534a35a
line wrap: on
line source
package de.intevation.gnv.artifacts.services.requestobjects;

import java.util.Collection;

/**
 * This is the interface description of <code>MapService</code>. Currently,
 * there are four methods defined:<br>
 * <ol>
 *  <li>getID(): Returns the id of this service.</li>
 *  <li>getURL(): Returns the url used to call this service.</li>
 *  <li>getType(): Returns the service type.</li>
 *  <li>getLayer(): Returns a collection of layers contained in this service.
 *  </li>
 * </ol>
 *
 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
 *
 */
public interface MapService {


    /**
     * Returns the id of this Service.
     * @return the id of this service.
     */
    String getID();

    /**
     * Returns the Url under which this service is available.
     * @return the url under which this service is available.
     */
    String getURL();

    /**
     * Returns the service type
     * @return the service type.
     */
    String getType();

    /**
     * Returns the Layer which belongs to this Service.
     * @return a collection of layers contained in this service.
     */
    Collection<Layer> getLayer();

}
// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :

http://dive4elements.wald.intevation.org