/*
 * Copyright (c) 2010 by Intevation GmbH
 *
 * This program is free software under the LGPL (>=v2.1)
 * Read the file LGPL.txt coming with the software for details
 * or visit http://www.gnu.org/licenses/ if it does not exist.
 */

package de.intevation.gnv.artifacts.services.requestobjects;

/**
 * This is the inteface description of  a <code>Layer</code>. Currently, there
 * are four methods defined here:<br>
 * <ol>
 *  <li>getName(): Returns the name of this layer.</li>
 *  <li>getID(): Returns the id of this layer.</li>
 *  <li>isGroupLayer(): Returns true, if this layer contains child layers.</li>
 *  <li>parentID(): Returns the id of the parent layer if this layer is a
 *   group layer.</li>
 * </ol>
 *
 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
 *
 */
public interface Layer {

    /**
     * Returns the name of this layer.
     * @return the name of this layer.
     */
    String getName();

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

    /**
     * Returns true if the Layer is an GroupLayer
     * @return true, if this layer is a group layer - otherwise false.
     */
    boolean isGroupLayer();

    /**
     * Returned the ID of the Parent Layer.
     * Only if the Layer is a Child-Layer.
     * If this Layer is an Root-Layer null will be returned.
     * @return the id of the parent.
     */
    String parentID();
}
// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :