minor

[cdmlib.git] / cdmlib-model / src / main / java / eu / etaxonomy / cdm / model / reference / IJournal.java

diff --git a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/reference/IJournal.java b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/reference/IJournal.java
index cb82b41df11eb562cd99347c24b570917fd7afc7..1ded05888f7930ce6ff1d22c08b59391d5ae99d1 100644 (file)
--- a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/reference/IJournal.java
+++ b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/reference/IJournal.java
@@ -11,10 +11,24 @@ package eu.etaxonomy.cdm.model.reference;
 \r
 import eu.etaxonomy.cdm.strategy.cache.reference.JournalDefaultCacheStrategy;\r
 \r
+/**\r
+ * This interface represents journals. A journal is a periodical \r
+ * {@link IPublicationBase publication} containing several {@link IArticle articles}.\r
+ * <P>\r
+ * This class corresponds, according to the TDWG ontology, to the publication type\r
+ * term (from PublicationTypeTerm): "Journal".\r
+ */\r
 public interface IJournal extends IPublicationBase{\r
 \r
+       /**\r
+        * Returns the ISSN (International Standard Serial Number)\r
+        */\r
        public String getIssn();\r
        \r
+       /**\r
+        * Sets the ISSN (International Standard Serial Number)\r
+        * @param issn\r
+        */\r
        public void setIssn(String issn);\r
        \r
        void setCacheStrategy(JournalDefaultCacheStrategy cacheStrategy);\r