tim@597: package de.intevation.gnv.artifacts.services.requestobjects;
sascha@779: 
tim@597: /**
ingo@792:  * This is the inteface description of  a <code>Layer</code>. Currently, there
ingo@792:  * are four methods defined here:<br>
ingo@792:  * <ol>
ingo@792:  *  <li>getName(): Returns the name of this layer.</li>
ingo@792:  *  <li>getID(): Returns the id of this layer.</li>
ingo@792:  *  <li>isGroupLayer(): Returns true, if this layer contains child layers.</li>
ingo@792:  *  <li>parentID(): Returns the id of the parent layer if this layer is a
ingo@792:  *   group layer.</li>
ingo@792:  * </ol>
ingo@792:  *
sascha@780:  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
tim@597:  *
tim@597:  */
tim@597: public interface Layer {
sascha@778: 
ingo@792:     /**
tim@826:      * Returns the name of this layer.
ingo@792:      * @return the name of this layer.
ingo@792:      */
tim@597:     String getName();
ingo@792: 
ingo@792:     /**
tim@826:      * Returns the id of this layer.
ingo@792:      * @return the id of this layer.
ingo@792:      */
tim@597:     String getID();
ingo@792: 
ingo@792:     /**
tim@826:      * Returns true if the Layer is an GroupLayer
ingo@792:      * @return true, if this layer is a group layer - otherwise false.
ingo@792:      */
tim@597:     boolean isGroupLayer();
sascha@803: 
ingo@792:     /**
tim@826:      * Returned the ID of the Parent Layer.
tim@826:      * Only if the Layer is a Child-Layer.
tim@826:      * If this Layer is an Root-Layer null will be returned.
ingo@792:      * @return the id of the parent.
ingo@792:      */
tim@597:     String parentID();
tim@597: }
ingo@792: // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 :