cdmlib-persistence/src/main/java/eu/etaxonomy/cdm/persistence/dao/common/IMarkerDao.java

   1 /**
   2 * Copyright (C) 2009 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
  10 package eu.etaxonomy.cdm.persistence.dao.common;
  11
  12 import java.util.List;
  13
  14 import eu.etaxonomy.cdm.model.common.Marker;
  15 import eu.etaxonomy.cdm.model.common.MarkerType;
  16 import eu.etaxonomy.cdm.persistence.dao.BeanInitializer;
  17 import eu.etaxonomy.cdm.persistence.query.OrderHint;
  18
  19 public interface IMarkerDao extends IVersionableDao<Marker> {
  20
  21         /**
  22          * Returns a count of markers which have the same type
  23          * @param markerType The type of markerType
  24          * @return a count of markers
  25          */
  26         public int count(MarkerType markerType);
  27
  28         /**
  29          * Returns a list of markers which have the same type
  30          *
  31          * @param markerType The type of markerType
  32          * @param pageSize The maximum number of markers returned (can be null for all markers)
  33          * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
  34          * @param orderHints may be null
  35          * @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
  36          * @return
  37          */
  38         public List<Marker> list(MarkerType markerType, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
  39
  40 }