cdmlib-services/src/main/java/eu/etaxonomy/cdm/api/service/IIdentifiableEntityService.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.List;
  14
  15 import org.hibernate.criterion.Criterion;
  16
  17 import eu.etaxonomy.cdm.api.service.pager.Pager;
  18 import eu.etaxonomy.cdm.model.common.ISourceable;
  19 import eu.etaxonomy.cdm.model.common.IdentifiableEntity;
  20 import eu.etaxonomy.cdm.model.common.IdentifiableSource;
  21 import eu.etaxonomy.cdm.model.common.LSID;
  22 import eu.etaxonomy.cdm.model.common.UuidAndTitleCache;
  23 import eu.etaxonomy.cdm.model.media.Rights;
  24 import eu.etaxonomy.cdm.persistence.dao.BeanInitializer;
  25 import eu.etaxonomy.cdm.persistence.query.MatchMode;
  26 import eu.etaxonomy.cdm.persistence.query.OrderHint;
  27
  28 public interface IIdentifiableEntityService<T extends IdentifiableEntity> extends IAnnotatableService<T> {
  29
  30         /**
  31          * (Re-)generate the title caches for all objects of this concrete IdentifiableEntity class
  32          */
  33         public void generateTitleCache();
  34
  35         /**
  36          * Finds an object with a given LSID. If the object does not currently exist in the current view, then
  37          * the most recent prior version of the object will be returned, or null if an object with this identifier
  38          * has never existed
  39          *
  40          * @param lsid
  41          * @return an object of type T or null of the object has never existed
  42          */
  43         public T find(LSID lsid);
  44
  45         /**
  46          * Return a Pager of sources belonging to this object
  47          *
  48          * @param t The identifiable entity
  49          * @param pageSize The maximum number of sources returned (can be null for all sources)
  50          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
  51          * @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
  52          * @return a Pager of OriginalSource entities
  53          */
  54     public Pager<IdentifiableSource> getSources(T t, Integer pageSize, Integer pageNumber, List<String> propertyPaths);
  55
  56         /**
  57          * Return a Pager of rights belonging to this object
  58          *
  59          * @param t The identifiable entity
  60          * @param pageSize The maximum number of rights returned (can be null for all rights)
  61          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
  62          * @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
  63          * @return a Pager of Rights entities
  64          */
  65     public Pager<Rights> getRights(T t, Integer pageSize, Integer pageNumber, List<String> propertyPaths);
  66
  67     public ISourceable getSourcedObjectByIdInSource(Class clazz, String idInSource, String idNamespace);
  68
  69         /**
  70          * Return a list of all uuids mapped to titleCache in the convenient <code>UuidAndTitleCache</code> object.
  71          * Retrieving this list is considered to be significantly faster than initializing the fully fledged buiseness
  72          * objects. To be used in cases where you want to present large amount of data and provide details after
  73          * a selection has been made.
  74          *
  75          * @return a list of <code>UuidAndTitleCache</code> instances
  76          */
  77         public List<UuidAndTitleCache<T>> getUuidAndTitleCache();
  78
  79         /**
  80          * Return a Pager of objects matching the given query string, optionally filtered by class, optionally with a particular MatchMode
  81          *
  82          * @param clazz filter by class - can be null to include all instances of type T
  83          * @param queryString the query string to filter by
  84          * @param matchmode use a particular type of matching (can be null - defaults to exact matching)
  85          * @param criteria additional criteria to filter by
  86          * @param pageSize The maximum number of objects returned (can be null for all objects)
  87          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
  88          * @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
  89          * @param orderHints
  90          *            Supports path like <code>orderHints.propertyNames</code> which
  91          *            include *-to-one properties like createdBy.username or
  92          *            authorTeam.persistentTitleCache
  93          * @return a paged list of instances of type T matching the queryString
  94          */
  95     public Pager<T> findByTitle(Class<? extends T> clazz, String queryString,MatchMode matchmode, List<Criterion> criteria, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
  96 }