(no commit message)

[cdmlib.git] / cdmlib-model / src / main / java / eu / etaxonomy / cdm / model / agent / InstitutionType.java

diff --git a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/agent/InstitutionType.java b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/agent/InstitutionType.java
index 9a403729f8b8fe31e3118b2e1b6f60d3fa4985e0..e49b994fc30d9aeaaff44725b094be04348c1ecc 100644 (file)
--- a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/agent/InstitutionType.java
+++ b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/agent/InstitutionType.java
@@ -9,33 +9,52 @@
 
 package eu.etaxonomy.cdm.model.agent;
 
-
 import eu.etaxonomy.cdm.model.common.DefinedTermBase;
-import eu.etaxonomy.cdm.model.common.OrderedTermBase;
-import eu.etaxonomy.cdm.model.common.TermVocabulary;
-
 import org.apache.log4j.Logger;
-
-import java.util.*;
 import javax.persistence.*;
+import javax.xml.bind.annotation.XmlAccessType;
+import javax.xml.bind.annotation.XmlAccessorType;
+import javax.xml.bind.annotation.XmlType;
 
 /**
- * http://rs.tdwg.org/ontology/voc/InstitutionType
+ * Represents an element of a controlled {@link common.TermVocabulary vocabulary} for different kinds of institutions.
+ * Each {@link common.DefinedTermBase element} belongs to one vocabulary.
+ * <p>
+ * See also the <a href="http://rs.tdwg.org/ontology/voc/InstitutionType">TDWG Ontology</a>
+ * 
+ * 
  * @author m.doering
  * @version 1.0
  * @created 08-Nov-2007 13:06:30
  */
+@XmlAccessorType(XmlAccessType.FIELD)
+@XmlType(name = "InstitutionType")
 @Entity
 public class InstitutionType extends DefinedTermBase {
        static Logger logger = Logger.getLogger(InstitutionType.class);
 
+       /** 
+        * Class constructor.
+        * 
+        * @see #InstitutionType(String, String)
+        */
        public InstitutionType() {
                super();
                // TODO Auto-generated constructor stub
        }
 
-       public InstitutionType(String term, String label) {
-               super(term, label);
+       /** 
+        * Class constructor using both term and label strings.
+        *
+        * @param  term   the string describing <i>this</i> vocabulary element
+        *                                in the default language
+        * @param  label  the string which identifies <i>this</i> vocabulary element
+        *                                irrespective of the language
+        * @see           common.Representation
+        * @see           common.TermBase#TermBase(String, String)
+        */
+       public InstitutionType(String term, String label, String labelAbbrev) {
+               super(term, label, labelAbbrev);
                // TODO Auto-generated constructor stub
        }