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 eu.etaxonomy.cdm.api.service.pager.Pager;
  14 import eu.etaxonomy.cdm.model.common.ISourceable;
  15 import eu.etaxonomy.cdm.model.common.IdentifiableEntity;
  16 import eu.etaxonomy.cdm.model.common.OriginalSource;
  17 import eu.etaxonomy.cdm.model.media.Rights;
  18
  19 public interface IIdentifiableEntityService<T extends IdentifiableEntity> extends IAnnotatableService<T> {
  20
  21         /**
  22          * (Re-)generate the title caches for all objects of this concrete IdentifiableEntity class
  23          */
  24         public abstract void generateTitleCache();
  25
  26         /**
  27          * Return a Pager of sources belonging to this object
  28          *
  29          * @param t The identifiable entity
  30          * @param pageSize The maximum number of sources returned (can be null for all sources)
  31          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
  32          * @return a Pager of OriginalSource entities
  33          */
  34     public Pager<OriginalSource> getSources(T t, Integer pageSize, Integer pageNumber);
  35
  36         /**
  37          * Return a Pager of rights belonging to this object
  38          *
  39          * @param t The identifiable entity
  40          * @param pageSize The maximum number of rights returned (can be null for all rights)
  41          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
  42          * @return a Pager of Rights entities
  43          */
  44     public Pager<Rights> getRights(T t, Integer pageSize, Integer pageNumber);
  45
  46     public abstract ISourceable getSourcedObjectByIdInSource(Class clazz, String idInSource, String idNamespace);
  47 }