X-Git-Url: https://dev.e-taxonomy.eu/gitweb/cdmlib.git/blobdiff_plain/0ba4e977297771bdbe5ff8dfb31665c122cc39cc..bc45d7e377271e52da2962cc82c3a02c0643d560:/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IVocabularyService.java?ds=sidebyside

diff --git a/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IVocabularyService.java b/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IVocabularyService.java
index 56fb198591..086ccd3927 100644
--- a/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IVocabularyService.java
+++ b/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IVocabularyService.java
@@ -5,12 +5,11 @@
 *
 * The contents of this file are subject to the Mozilla Public License Version 1.1
 * See LICENSE.TXT at the top of this package for the full license terms.
-*/ 
+*/
 
 package eu.etaxonomy.cdm.api.service;
 
 import java.util.List;
-import java.util.UUID;
 
 import eu.etaxonomy.cdm.api.service.pager.Pager;
 import eu.etaxonomy.cdm.model.common.DefinedTermBase;
@@ -20,34 +19,57 @@ import eu.etaxonomy.cdm.model.common.VocabularyEnum;
 import eu.etaxonomy.cdm.persistence.query.OrderHint;
 
 public interface IVocabularyService extends IIdentifiableEntityService<TermVocabulary> {
-    
+
+    //TODO candidate for harmonization: rename to load(VocabularyEnum vocabularyType)
 	public TermVocabulary getVocabulary(VocabularyEnum vocabularyType);
-	
+
     /**
      * Returns term vocabularies that contain terms of a certain class e.g. Feature, Modifier, State.
-     * 
+     *
      * @param <TERM>
      * @param clazz the term class of the terms in the vocabulary
      * @param limit The maximum number of vocabularies returned (can be null for all vocabularies)
      * @param start The offset from the start of the result set (0 - based, can be null - equivalent of starting at the beginning of the recordset)
-     * @param orderHints 
+     * @param orderHints
      *            Supports path like <code>orderHints.propertyNames</code> which
 	 *            include *-to-one properties like createdBy.username or
 	 *            authorTeam.persistentTitleCache
      * @param propertyPaths properties to be initialized
      * @return a list of term vocabularies
+     * @see #listByTermClass(Class, boolean, Integer, Integer, List, List)
      */
 	public <TERM extends DefinedTermBase> List<TermVocabulary<TERM>> listByTermClass(Class<TERM> clazz, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);
-	
+
+	   /**
+     * Returns term vocabularies that contain terms of a certain class e.g. Feature, Modifier, State.
+     *
+     * @param <TERM>
+     * @param clazz the term class of the terms in the vocabulary
+     * @param includeSubclasses if <code>true</code> all subclasses of clazz will be included for computation of the result
+     * @param includeEmptyVocs if <code>true</code> all vocabularies that do not contain any term will be included in the result
+     * @param limit The maximum number of vocabularies returned (can be null for all vocabularies)
+     * @param start The offset from the start of the result set (0 - based, can be null - equivalent of starting at the beginning of the recordset)
+     * @param orderHints
+     *            Supports path like <code>orderHints.propertyNames</code> which
+	 *            include *-to-one properties like createdBy.username or
+	 *            authorTeam.persistentTitleCache
+     * @param propertyPaths properties to be initialized
+     * @return a list of term vocabularies
+     * @see #listByTermClass(Class, Integer, Integer, List, List)
+     */
+	public <TERM extends DefinedTermBase> List<TermVocabulary<? extends TERM>> listByTermClass(Class<TERM> clazz, boolean includeSubclasses, boolean includeEmptyVocs, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);
+
+
 	/**
 	 * Returns Language Vocabulary
 	 * @return
 	 */
+	//TODO candidate for harmonization: rename to loadLanguageVocabulary(...
 	public TermVocabulary<Language> getLanguageVocabulary();
-	
+
 	/**
 	 * Returns a list of terms belonging to the vocabulary passed as an argument
-	 * 
+	 *
 	 * @param vocabulary The vocabulary for which the list of terms is desired
 	 * @param limit The maximum number of terms returned (can be null for all terms in the vocabulary)
 	 * @param start The offset from the start of the result set (0 - based, can be null - equivalent of starting at the beginning of the recordset)
@@ -58,6 +80,7 @@ public interface IVocabularyService extends IIdentifiableEntityService<TermVocab
 	 * @param propertyPaths properties to be initialized
 	 * @return a paged list of terms
 	 */
+	//TODO candidate for harmonization: rename to getTerms(...
 	public Pager<DefinedTermBase> getTerms(TermVocabulary vocabulary, Integer limit, Integer start, List<OrderHint> orderHints, List<String> propertyPaths);
 
 }