cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/common/IDefinedTerm.java

   1 /**
   2 * Copyright (C) 2007 EDIT
   3 * European Distributed Institute of Taxonomy
   4 * http://www.e-taxonomy.eu
   5 *
   6 * The contents of this file are subject to the Mozilla Public License Version 1.1
   7 * See LICENSE.TXT at the top of this package for the full license terms.
   8 */
   9
  10 package eu.etaxonomy.cdm.model.common;
  11
  12 import java.util.Set;
  13 import java.util.UUID;
  14
  15 import javax.persistence.Transient;
  16
  17
  18 import eu.etaxonomy.cdm.model.media.Media;
  19
  20 public interface IDefinedTerm<T extends IDefinedTerm> extends ILoadableTerm<T> {
  21
  22         @Transient
  23         public UUID getUuid();
  24
  25         public T getByUuid(UUID uuid);
  26
  27         /**
  28          * Returns the defined term this term is a kind of.
  29          * Therefore the returned term is a generalization of <code>this</code> term
  30          */
  31         public T getKindOf();
  32
  33 //      public void setKindOf(T kindOf);
  34
  35         /**
  36          * Returns all defined terms this term is a generalization for.
  37          * Therefore the returned terms are kind of <code>this</code> term
  38          */
  39         public Set<T> getGeneralizationOf();
  40
  41 //      public void setGeneralizationOf(Set<T> generalizationOf);
  42 //
  43 //      public void addGeneralizationOf(T generalization);
  44 //
  45 //      public void removeGeneralization(T generalization);
  46
  47         /**
  48          * Returns the defined term this term is a part of.
  49          * Therefore the returned term includes <code>this</code> term
  50          */
  51         public T getPartOf();
  52
  53 //      public void setPartOf(T partOf);
  54
  55         /**
  56          * Returns all defined terms this term includes.
  57          * Therefore the returned terms are part of <code>this</code> term
  58          */
  59         public Set<T> getIncludes();
  60
  61 //      public void setIncludes(Set<T> includes);
  62 //
  63 //      public void addIncludes(T includes);
  64 //
  65 //      public void removeIncludes(T includes);
  66
  67         public Set<Media> getMedia();
  68
  69 //      public void setMedia(Set<Media> media);
  70 //
  71 //      public void addMedia(Media media);
  72 //
  73 //      public void removeMedia(Media media);
  74
  75         /* (non-Javadoc)
  76          * @see eu.etaxonomy.cdm.model.common.IDefTerm#getVocabulary()
  77          */
  78 //      public TermVocabulary<T> getVocabulary();
  79
  80         /* (non-Javadoc)
  81          * @see eu.etaxonomy.cdm.model.common.IDefTerm#setVocabulary(eu.etaxonomy.cdm.model.common.TermVocabulary)
  82          */
  83 //      public void setVocabulary(TermVocabulary<T> newVocabulary);
  84
  85 }