Mercurial > dive4elements > gnv-client
comparison gnv-artifacts/src/main/java/de/intevation/gnv/artifacts/services/requestobjects/Layer.java @ 792:9b9bf42b7928
Added and repaired JavaDoc in artifacts package.
gnv-artifacts/trunk@874 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
|---|---|
| date | Wed, 31 Mar 2010 10:52:34 +0000 |
| parents | c4156275c1e1 |
| children | feae2f9d6c6f |
comparison
equal
deleted
inserted
replaced
| 791:23877dd69444 | 792:9b9bf42b7928 |
|---|---|
| 1 package de.intevation.gnv.artifacts.services.requestobjects; | 1 package de.intevation.gnv.artifacts.services.requestobjects; |
| 2 | 2 |
| 3 /** | 3 /** |
| 4 * This is the inteface description of a <code>Layer</code>. Currently, there | |
| 5 * are four methods defined here:<br> | |
| 6 * <ol> | |
| 7 * <li>getName(): Returns the name of this layer.</li> | |
| 8 * <li>getID(): Returns the id of this layer.</li> | |
| 9 * <li>isGroupLayer(): Returns true, if this layer contains child layers.</li> | |
| 10 * <li>parentID(): Returns the id of the parent layer if this layer is a | |
| 11 * group layer.</li> | |
| 12 * </ol> | |
| 13 * | |
| 4 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | 14 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
| 5 * | 15 * |
| 6 */ | 16 */ |
| 7 public interface Layer { | 17 public interface Layer { |
| 8 | 18 |
| 19 /** | |
| 20 * | |
| 21 * @return the name of this layer. | |
| 22 */ | |
| 9 String getName(); | 23 String getName(); |
| 24 | |
| 25 /** | |
| 26 * | |
| 27 * @return the id of this layer. | |
| 28 */ | |
| 10 String getID(); | 29 String getID(); |
| 30 | |
| 31 /** | |
| 32 * | |
| 33 * @return true, if this layer is a group layer - otherwise false. | |
| 34 */ | |
| 11 boolean isGroupLayer(); | 35 boolean isGroupLayer(); |
| 36 | |
| 37 /** | |
| 38 * | |
| 39 * @return the id of the parent. | |
| 40 */ | |
| 12 String parentID(); | 41 String parentID(); |
| 13 | |
| 14 } | 42 } |
| 43 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf8 : |