|
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
|
package eu.etaxonomy.cdm.api.service;
|
|
11
|
|
|
12
|
import java.util.List;
|
|
13
|
|
|
14
|
import eu.etaxonomy.cdm.api.service.pager.Pager;
|
|
15
|
import eu.etaxonomy.cdm.model.common.AnnotatableEntity;
|
|
16
|
import eu.etaxonomy.cdm.model.common.Annotation;
|
|
17
|
import eu.etaxonomy.cdm.model.common.MarkerType;
|
|
18
|
import eu.etaxonomy.cdm.persistence.dao.BeanInitializer;
|
|
19
|
import eu.etaxonomy.cdm.persistence.query.OrderHint;
|
|
20
|
|
|
21
|
public interface IAnnotatableService<T extends AnnotatableEntity> extends IVersionableService<T> {
|
|
22
|
|
|
23
|
/**
|
|
24
|
* Return a Pager containing Annotation entities belonging to the object supplied, optionally
|
|
25
|
* filtered by MarkerType
|
|
26
|
*
|
|
27
|
* @param annotatedObj The object that "owns" the annotations returned
|
|
28
|
* @param status Only return annotations which are marked with a Marker of this type (can be null to return all annotations)
|
|
29
|
* @param pageSize The maximum number of terms returned (can be null for all annotations)
|
|
30
|
* @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
|
|
31
|
* @param orderHints may be null
|
|
32
|
* @param propertyPaths properties to initialize - see {@link BeanInitializer#initialize(Object, List)}
|
|
33
|
* @return a Pager of Annotation entities
|
|
34
|
*/
|
|
35
|
public Pager<Annotation> getAnnotations(T annotatedObj, MarkerType status, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
|
|
36
|
}
|