cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/ILocationService.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.api.service;
  11
  12 import java.util.List;
  13
  14 import eu.etaxonomy.cdm.model.description.PresenceAbsenceTerm;
  15 import eu.etaxonomy.cdm.model.location.NamedArea;
  16 import eu.etaxonomy.cdm.model.location.NamedAreaLevel;
  17 import eu.etaxonomy.cdm.model.location.NamedAreaType;
  18 import eu.etaxonomy.cdm.model.term.DefinedTermBase;
  19 import eu.etaxonomy.cdm.model.term.OrderedTermVocabulary;
  20 import eu.etaxonomy.cdm.model.term.TermVocabulary;
  21
  22 /**
  23  * @author n.hoffman
  24  * @since 08.04.2009
  25  */
  26 public interface ILocationService extends IService<DefinedTermBase> {
  27
  28
  29         public static enum NamedAreaVocabularyType{
  30                 TDWG_AREA, COUNTRY, WATERBODY, CONTINENT
  31         }
  32
  33     /**
  34      * Returns a list of NamedArea Types "TDWG Areas", "ISO Country Codes"
  35      *
  36      * @return
  37      */
  38     public List<NamedAreaVocabularyType> getNamedAreaVocabularyTypes();
  39
  40     /**
  41      *  - these would be top-level areas for nested area vocabularies, e.g. North America and Europe, but NOT USA, Germany - alternatively:
  42      *
  43      * @param vocabularyType
  44      * @return
  45      * @deprecated use TermService#getVocabulary(VocabularyType) instead
  46      */
  47     @Deprecated
  48     public OrderedTermVocabulary<NamedArea> getNamedAreaVocabulary(NamedAreaVocabularyType vocabularyType);
  49
  50     /**
  51      *
  52      * @return
  53      * @deprecated use TermService#getVocabulary(VocabularyType) instead
  54      */
  55     @Deprecated
  56     public TermVocabulary<NamedAreaType> getNamedAreaTypeVocabulary();
  57
  58     /**
  59      * @return
  60      * @deprecated use TermService#getVocabulary(VocabularyType) instead
  61      */
  62     @Deprecated
  63     public OrderedTermVocabulary<NamedAreaLevel> getNamedAreaLevelVocabulary();
  64
  65     /**
  66      *
  67      * @return
  68      * @deprecated use TermService#getVocabulary(VocabularyType) instead
  69      */
  70     @Deprecated
  71     public OrderedTermVocabulary<PresenceAbsenceTerm> getPresenceAbsenceTermVocabulary();
  72
  73     /**
  74      *
  75      */
  76     public List<NamedArea> getTopLevelNamedAreasByVocabularyType(NamedAreaVocabularyType vocabularyType);
  77 }