cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IReferenceService.java

   1 // $Id$
   2 /**
   3 * Copyright (C) 2007 EDIT
   4 * European Distributed Institute of Taxonomy
   5 * http://www.e-taxonomy.eu
   6 *
   7 * The contents of this file are subject to the Mozilla Public License Version 1.1
   8 * See LICENSE.TXT at the top of this package for the full license terms.
   9 */
  10
  11 package eu.etaxonomy.cdm.api.service;
  12
  13 import java.util.Collection;
  14 import java.util.List;
  15 import java.util.Map;
  16 import java.util.UUID;
  17
  18 import eu.etaxonomy.cdm.api.service.pager.Pager;
  19 import eu.etaxonomy.cdm.model.common.UuidAndTitleCache;
  20 import eu.etaxonomy.cdm.model.reference.ReferenceBase;
  21 import eu.etaxonomy.cdm.persistence.query.OrderHint;
  22
  23
  24 public interface IReferenceService extends IIdentifiableEntityService<ReferenceBase> {
  25
  26         /**
  27          * FIXME candidate for harmonization?
  28          *
  29          * Finds reference by UUID
  30          */
  31         public abstract ReferenceBase getReferenceByUuid(UUID uuid);
  32
  33         /**
  34          * FIXME candidate for harmonization?
  35          * Finds references by title
  36          */
  37         public List<ReferenceBase> getReferencesByTitle(String title);
  38
  39         /**
  40          * FIXME candidate for harmonization?
  41          * Finds references of a certain kind by title
  42          */
  43         public List<ReferenceBase> getReferencesByTitle(String title, Class<ReferenceBase> clazz);
  44
  45         /**
  46          * FIXME candidate for harmonization?
  47          * Gets all references
  48          * @deprecated use {@link #getAllReferences(Integer, Integer) instead
  49          */
  50         @Deprecated
  51         public abstract List<ReferenceBase> getAllReferences(int limit, int start);
  52
  53         /**
  54          * Gets all references ordered by the properties defined by <code>orderHints</code>
  55          * @param pageSize the maximum number of entities returned entries per page. Can be null to return all entities.
  56          * @param pageNumber a numeric zero based page index
  57          * @param orderHints
  58          * @return a Pager instance
  59          */
  60         public Pager<ReferenceBase> getAllReferences(Integer pageSize, Integer pageNumber, List<OrderHint> orderHints);
  61
  62         /**
  63          * Gets all references unordered
  64          * @param pageSize the maximum number of entities returned entries per page. Can be null to return all entities.
  65          * @param pageNumber a numeric zero based page index
  66          * @return a Pager instance
  67          */
  68         public abstract Pager<ReferenceBase> getAllReferences(Integer pageSize, Integer pageNumber);
  69
  70 //      public abstract UUID saveReference(ReferenceBase reference);
  71
  72         /**
  73          * FIXME candidate for harmonization?
  74          * Saves a reference and return its UUID
  75          */
  76         public abstract UUID saveReference(ReferenceBase reference);
  77
  78 //      public abstract Map<UUID, ReferenceBase> saveReferenceAll(Collection<ReferenceBase> referenceCollection);
  79
  80         /**
  81          * FIXME candidate for harmonization?
  82          * Saves a collection of references
  83          */
  84         public abstract Map<UUID, ReferenceBase> saveReferenceAll(Collection<ReferenceBase> referenceCollection);
  85
  86         /**
  87          * Returns a Paged List of ReferenceBase instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser)
  88          *
  89          * @param clazz filter the results by class (or pass null to return all ReferenceBase instances)
  90          * @param queryString
  91          * @param pageSize The maximum number of references returned (can be null for all matching references)
  92          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
  93          * @param orderHints
  94          *            Supports path like <code>orderHints.propertyNames</code> which
  95          *            include *-to-one properties like createdBy.username or
  96          *            authorTeam.persistentTitleCache
  97          * @param propertyPaths properties to be initialized
  98          * @return a Pager ReferenceBase instances
  99          * @see <a href="http://lucene.apache.org/java/2_4_0/queryparsersyntax.html">Apache Lucene - Query Parser Syntax</a>
 100          */
 101         public Pager<ReferenceBase> search(Class<? extends ReferenceBase> clazz, String queryString, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
 102
 103         /**
 104          * Returns a map that holds uuid, titleCache pairs of all references in the current database
 105          *
 106          * @return
 107          *                      a <code>Map</code> containing uuid and titleCache of references
 108          */
 109         public List<UuidAndTitleCache> getUuidAndTitleCacheOfReferences();
 110
 111 }