diff 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
line wrap: on
line diff
--- a/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactObject.java	Mon Apr 12 10:56:55 2010 +0000
+++ b/gnv/src/main/java/de/intevation/gnv/artifactdatabase/objects/ArtifactObject.java	Mon Apr 12 16:45:16 2010 +0000
@@ -3,21 +3,52 @@
 import java.io.Serializable;
 
 /**
+ * The <code>ArtifactObject</code> provides some information about an artifact.
+ * 
  * @author <a href="mailto:tim.englich@intevation.de">Tim Englich</a>
- *
  */
 public interface ArtifactObject extends Serializable {
 
+    /**
+     * Retrieves the id of this object.
+     *
+     * @return the id.
+     */
     public String getId();
 
+    /**
+     * Retrieves information about the selection state of this object.
+     *
+     * @return true, if this object is selected - otherwise false.
+     */
     public boolean isSelected();
 
+    /**
+     * Set the selection of this object.
+     *
+     * @param selected the new selection.
+     */
     public void setSelected(boolean selected);
 
+    /**
+     * Retrieves the name of this object.
+     *
+     * @return the name.
+     */
     public String getName();
 
+    /**
+     * Retrieves the  description of the object.
+     *
+     * @return the description.
+     */
     public String getDescription();
 
+    /**
+     * Retrieves the hash value of this object.
+     *
+     * @return the hash value.
+     */
     public String getHash();
-
 }
+// vim:set ts=4 sw=4 si et sta sts=4 fenc=utf-8 :
\ No newline at end of file

http://dive4elements.wald.intevation.org