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

   1 /**
   2 * Copyright (C) 2014 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 package eu.etaxonomy.cdm.api.service.molecular;
  10
  11 import java.util.List;
  12 import java.util.UUID;
  13
  14 import org.hibernate.criterion.Criterion;
  15
  16 import eu.etaxonomy.cdm.api.service.IAnnotatableService;
  17 import eu.etaxonomy.cdm.api.service.pager.Pager;
  18 import eu.etaxonomy.cdm.model.molecular.Amplification;
  19 import eu.etaxonomy.cdm.persistence.dao.initializer.IBeanInitializer;
  20 import eu.etaxonomy.cdm.persistence.dto.UuidAndTitleCache;
  21 import eu.etaxonomy.cdm.persistence.query.MatchMode;
  22 import eu.etaxonomy.cdm.persistence.query.OrderHint;
  23
  24 /**
  25  * @author pplitzner
  26  * @since 11.03.2014
  27  *
  28  */
  29 public interface IAmplificationService extends IAnnotatableService<Amplification>{
  30
  31     /**
  32      * Retrieves the {@link UUID} and the string label of all
  33      * {@link Amplification}s found in the data base.
  34      * @return a list of {@link UuidAndTitleCache}
  35      */
  36     public List<UuidAndTitleCache<Amplification>> getAmplificationUuidAndLabelCache(Integer limit, String pattern);
  37
  38     /**
  39     * Return a List of {@link Amplification}s matching the given query string, optionally with a particular MatchMode
  40     *
  41     * @param queryString the query string to filter by
  42     * @param matchmode use a particular type of matching (can be null - defaults to exact matching)
  43     * @param criteria extra restrictions to apply
  44     * @param pageSize The maximum number of rights returned (can be null for all rights)
  45     * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
  46     * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
  47     * @param orderHints
  48     *            Supports path like <code>orderHints.propertyNames</code> which
  49     *            include *-to-one properties like createdBy.username or
  50     *            authorTeam.persistentTitleCache
  51     * @return a List of instances of type T matching the queryString
  52     */
  53     Pager<Amplification> findByLabelCache(String queryString, MatchMode matchmode, List<Criterion> criteria,
  54             Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
  55 }