X-Git-Url: https://dev.e-taxonomy.eu/gitweb/cdmlib.git/blobdiff_plain/1d36aa543c3acc5c2d7cd81e35ddca50a70a4f11..45546a913cf144912d383d54758aa51c81367ec9:/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IReferenceService.java diff --git a/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IReferenceService.java b/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IReferenceService.java index a92543e516..71e528a8da 100644 --- a/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IReferenceService.java +++ b/cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IReferenceService.java @@ -1,9 +1,9 @@ // $Id$ /** * Copyright (C) 2007 EDIT -* European Distributed Institute of Taxonomy +* European Distributed Institute of Taxonomy * http://www.e-taxonomy.eu -* +* * 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. */ @@ -13,17 +13,17 @@ package eu.etaxonomy.cdm.api.service; import java.util.List; import eu.etaxonomy.cdm.api.service.pager.Pager; -import eu.etaxonomy.cdm.model.common.UuidAndTitleCache; import eu.etaxonomy.cdm.model.reference.Reference; import eu.etaxonomy.cdm.model.taxon.TaxonBase; +import eu.etaxonomy.cdm.persistence.dto.UuidAndTitleCache; import eu.etaxonomy.cdm.persistence.query.OrderHint; public interface IReferenceService extends IIdentifiableEntityService { - + /** * Returns a Paged List of Reference instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser) - * + * * @param clazz filter the results by class (or pass null to return all Reference instances) * @param queryString * @param pageSize The maximum number of references returned (can be null for all matching references) @@ -36,22 +36,23 @@ public interface IReferenceService extends IIdentifiableEntityService * @return a Pager Reference instances * @see Apache Lucene - Query Parser Syntax */ - public Pager search(Class clazz, String queryString, Integer pageSize, Integer pageNumber, List orderHints, List propertyPaths); - + @Override + public Pager search(Class clazz, String queryString, Integer pageSize, Integer pageNumber, List orderHints, List propertyPaths); + /** * Returns a map that holds uuid, titleCache pairs of all references in the current database - * - * @return + * + * @return * a Map containing uuid and titleCache of references */ public List> getUuidAndTitle(); - + /** * TODO candidate for harmonization: rename to listForPublishing * @return */ public List getAllReferencesForPublishing(); - + /** * TODO candidate for harmonization: rename to listNomenclaturalReferences * @return @@ -60,12 +61,12 @@ public interface IReferenceService extends IIdentifiableEntityService /** * returns - * + * *
    *
  1. all taxa directly covered by this reference
  2. *
  3. all taxa covered by the according in references of this reference
  4. *
- * + * * searches for taxa using the following relations: *
    *
  • taxon.name.nomenclaturalreference
  • @@ -74,7 +75,7 @@ public interface IReferenceService extends IIdentifiableEntityService *
  • taxon.name.descriptions.descriptionElement.sources
  • *
  • taxon.name.descriptions.descriptionSources
  • *
- * + * * @param reference * @param includeSubordinateReferences TODO * @param propertyPaths