-package eu.etaxonomy.cdm.api.service;
+// $Id$
+/**
+* Copyright (C) 2007 EDIT
+* 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.
+*/
-import java.util.UUID;
-import eu.etaxonomy.cdm.model.reference.ReferenceBase;
+package eu.etaxonomy.cdm.api.service;
+import java.util.List;
-public interface IReferenceService extends IIdentifiableEntityService<ReferenceBase>{
-
- /** find reference by UUID**/
- public abstract ReferenceBase getReferenceByUuid(UUID uuid);
+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.query.OrderHint;
- /** save a reference and return its UUID**/
- public abstract UUID saveReference(ReferenceBase reference);
+public interface IReferenceService extends IIdentifiableEntityService<Reference> {
+
+ /**
+ * 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)
+ * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
+ * @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 Pager Reference instances
+ * @see <a href="http://lucene.apache.org/java/2_4_0/queryparsersyntax.html">Apache Lucene - Query Parser Syntax</a>
+ */
+ public Pager<Reference> search(Class<? extends Reference> clazz, String queryString, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
+ /**
+ * Returns a map that holds uuid, titleCache pairs of all references in the current database
+ *
+ * @return
+ * a <code>Map</code> containing uuid and titleCache of references
+ */
+ public List<UuidAndTitleCache<Reference>> getUuidAndTitle();
+
+ /**
+ * TODO candidate for harmonization: rename to listForPublishing
+ * @return
+ */
+ public List<Reference> getAllReferencesForPublishing();
+
+ /**
+ * TODO candidate for harmonization: rename to listNomenclaturalReferences
+ * @return
+ */
+ public List<Reference> getAllNomenclaturalReferences();
+
+ /**
+ * returns
+ *
+ * <ol>
+ * <li>all taxa directly covered by this reference</li>
+ * <li>all taxa covered by the according in references of this reference</li>
+ * </ol>
+ *
+ * searches for taxa using the following relations:
+ * <ul>
+ * <li>taxon.name.nomenclaturalreference</li>
+ * <li>taxon.descriptions.descriptionElement.sources.citation</li>
+ * <li>taxon.descriptions.descriptionSources</li>
+ * <li>taxon.name.descriptions.descriptionElement.sources</li>
+ * <li>taxon.name.descriptions.descriptionSources</li>
+ * </ul>
+ *
+ * @param reference
+ * @param includeSubordinateReferences TODO
+ * @param propertyPaths
+ * @return
+ */
+ public List<TaxonBase> listCoveredTaxa(Reference reference, boolean includeSubordinateReferences, List<String> propertyPaths);
}