Mercurial > dive4elements > gnv-client
comparison gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactObject.java @ 690:254f062e334b
Added JavaDoc.
gnv/trunk@908 c6561f87-3c4e-4783-a992-168aeb5c3f6f
| author | Ingo Weinzierl <ingo.weinzierl@intevation.de> |
|---|---|
| date | Mon, 12 Apr 2010 16:45:16 +0000 |
| parents | 57fa8019fbdc |
| children | af22fa5567a6 |
comparison
equal
deleted
inserted
replaced
| 689:8487581dfe3b | 690:254f062e334b |
|---|---|
| 1 package de.intevation.gnv.artifactdatabase.objects; | 1 package de.intevation.gnv.artifactdatabase.objects; |
| 2 | 2 |
| 3 import java.io.Serializable; | 3 import java.io.Serializable; |
| 4 | 4 |
| 5 /** | 5 /** |
| 6 * The <code>ArtifactObject</code> provides some information about an artifact. | |
| 7 * | |
| 6 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> | 8 * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a> |
| 7 * | |
| 8 */ | 9 */ |
| 9 public interface ArtifactObject extends Serializable { | 10 public interface ArtifactObject extends Serializable { |
| 10 | 11 |
| 12 /** | |
| 13 * Retrieves the id of this object. | |
| 14 * | |
| 15 * @return the id. | |
| 16 */ | |
| 11 public String getId(); | 17 public String getId(); |
| 12 | 18 |
| 19 /** | |
| 20 * Retrieves information about the selection state of this object. | |
| 21 * | |
| 22 * @return true, if this object is selected - otherwise false. | |
| 23 */ | |
| 13 public boolean isSelected(); | 24 public boolean isSelected(); |
| 14 | 25 |
| 26 /** | |
| 27 * Set the selection of this object. | |
| 28 * | |
| 29 * @param selected the new selection. | |
| 30 */ | |
| 15 public void setSelected(boolean selected); | 31 public void setSelected(boolean selected); |
| 16 | 32 |
| 33 /** | |
| 34 * Retrieves the name of this object. | |
| 35 * | |
| 36 * @return the name. | |
| 37 */ | |
| 17 public String getName(); | 38 public String getName(); |
| 18 | 39 |
| 40 /** | |
| 41 * Retrieves the description of the object. | |
| 42 * | |
| 43 * @return the description. | |
| 44 */ | |
| 19 public String getDescription(); | 45 public String getDescription(); |
| 20 | 46 |
| 47 /** | |
| 48 * Retrieves the hash value of this object. | |
| 49 * | |
| 50 * @return the hash value. | |
| 51 */ | |
| 21 public String getHash(); | 52 public String getHash(); |
| 22 | |
| 23 } | 53 } |
| 54 // vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 : |