| 1 |
c2f269f9
|
Andreas Kohlbecker
|
// $Id$
|
| 2 |
|
|
/**
|
| 3 |
|
|
* Copyright (C) 2007 EDIT
|
| 4 |
d9f134f9
|
Katja Luther
|
* European Distributed Institute of Taxonomy
|
| 5 |
c2f269f9
|
Andreas Kohlbecker
|
* http://www.e-taxonomy.eu
|
| 6 |
d9f134f9
|
Katja Luther
|
*
|
| 7 |
c2f269f9
|
Andreas Kohlbecker
|
* 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 |
fdf5453b
|
a.babadshanjan
|
package eu.etaxonomy.cdm.api.service;
|
| 12 |
|
|
|
| 13 |
|
|
import java.util.List;
|
| 14 |
d57c0df0
|
ben.clark
|
import java.util.Set;
|
| 15 |
d9f134f9
|
Katja Luther
|
import java.util.UUID;
|
| 16 |
fdf5453b
|
a.babadshanjan
|
|
| 17 |
d9f134f9
|
Katja Luther
|
import eu.etaxonomy.cdm.api.service.config.MediaDeletionConfigurator;
|
| 18 |
d57c0df0
|
ben.clark
|
import eu.etaxonomy.cdm.api.service.pager.Pager;
|
| 19 |
0f7d0d42
|
h.fradin
|
import eu.etaxonomy.cdm.model.description.MediaKey;
|
| 20 |
d57c0df0
|
ben.clark
|
import eu.etaxonomy.cdm.model.location.NamedArea;
|
| 21 |
fdf5453b
|
a.babadshanjan
|
import eu.etaxonomy.cdm.model.media.Media;
|
| 22 |
d44277a9
|
ben.clark
|
import eu.etaxonomy.cdm.model.media.Rights;
|
| 23 |
d57c0df0
|
ben.clark
|
import eu.etaxonomy.cdm.model.taxon.Taxon;
|
| 24 |
b9cbcc7c
|
Andreas Kohlbecker
|
import eu.etaxonomy.cdm.persistence.dao.initializer.IBeanInitializer;
|
| 25 |
aba8d6ad
|
ben.clark
|
import eu.etaxonomy.cdm.persistence.query.OrderHint;
|
| 26 |
fdf5453b
|
a.babadshanjan
|
|
| 27 |
c4e812bc
|
ben.clark
|
public interface IMediaService extends IIdentifiableEntityService<Media> {
|
| 28 |
fdf5453b
|
a.babadshanjan
|
|
| 29 |
d57c0df0
|
ben.clark
|
/**
|
| 30 |
0f7d0d42
|
h.fradin
|
* Return a List of MediaKeys, optionally filtered by the parameters passed.
|
| 31 |
d9f134f9
|
Katja Luther
|
*
|
| 32 |
d57c0df0
|
ben.clark
|
* @param taxonomicScope a Set of Taxon instances that define the taxonomic scope of the key (can be null)
|
| 33 |
|
|
* @param geoScopes a Set of NamedArea instances that define the geospatial scope of the key (can be null)
|
| 34 |
|
|
* @param pageSize The maximum number of keys returned (can be null for all keys)
|
| 35 |
|
|
* @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
|
| 36 |
dd4c21b7
|
Andreas Kohlbecker
|
* @param propertyPaths Properties to initialize in the returned entities, following the syntax described in {@link IBeanInitializer#initialize(Object, List)}
|
| 37 |
0f7d0d42
|
h.fradin
|
* @return a Pager containing MediaKey instances
|
| 38 |
d57c0df0
|
ben.clark
|
*/
|
| 39 |
0f7d0d42
|
h.fradin
|
public Pager<MediaKey> getMediaKeys(Set<Taxon> taxonomicScope, Set<NamedArea> geoScopes, Integer pageSize, Integer pageNumber, List<String> propertyPaths);
|
| 40 |
d9f134f9
|
Katja Luther
|
|
| 41 |
d44277a9
|
ben.clark
|
/**
|
| 42 |
|
|
* Return a Pager of rights belonging to this object
|
| 43 |
d9f134f9
|
Katja Luther
|
*
|
| 44 |
d44277a9
|
ben.clark
|
* @param t The media object
|
| 45 |
|
|
* @param pageSize The maximum number of rights returned (can be null for all rights)
|
| 46 |
|
|
* @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
|
| 47 |
dd4c21b7
|
Andreas Kohlbecker
|
* @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
|
| 48 |
d44277a9
|
ben.clark
|
* @return a Pager of Rights entities
|
| 49 |
|
|
*/
|
| 50 |
d9f134f9
|
Katja Luther
|
@Override
|
| 51 |
d44277a9
|
ben.clark
|
public Pager<Rights> getRights(Media t, Integer pageSize, Integer pageNumber, List<String> propertyPaths);
|
| 52 |
d9f134f9
|
Katja Luther
|
|
| 53 |
aba8d6ad
|
ben.clark
|
/**
|
| 54 |
|
|
* Returns a Paged List of Media instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser)
|
| 55 |
d9f134f9
|
Katja Luther
|
*
|
| 56 |
aba8d6ad
|
ben.clark
|
* @param clazz filter the results by class (or pass null to return all Media instances)
|
| 57 |
|
|
* @param queryString
|
| 58 |
|
|
* @param pageSize The maximum number of media returned (can be null for all matching media)
|
| 59 |
|
|
* @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
|
| 60 |
|
|
* @param orderHints
|
| 61 |
|
|
* Supports path like <code>orderHints.propertyNames</code> which
|
| 62 |
|
|
* include *-to-one properties like createdBy.username or
|
| 63 |
|
|
* authorTeam.persistentTitleCache
|
| 64 |
|
|
* @param propertyPaths properties to be initialized
|
| 65 |
|
|
* @return a Pager Media instances
|
| 66 |
|
|
* @see <a href="http://lucene.apache.org/java/2_4_0/queryparsersyntax.html">Apache Lucene - Query Parser Syntax</a>
|
| 67 |
|
|
*/
|
| 68 |
d9f134f9
|
Katja Luther
|
@Override
|
| 69 |
|
|
public Pager<Media> search(Class<? extends Media> clazz, String queryString, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths);
|
| 70 |
|
|
|
| 71 |
|
|
|
| 72 |
|
|
public DeleteResult delete(UUID mediaUuid, MediaDeletionConfigurator config);
|
| 73 |
fdf5453b
|
a.babadshanjan
|
}
|