3 * Copyright (C) 2007 EDIT
4 * European Distributed Institute of Taxonomy
5 * http://www.e-taxonomy.eu
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.
11 package eu
.etaxonomy
.cdm
.api
.service
;
13 import java
.util
.List
;
16 import eu
.etaxonomy
.cdm
.api
.service
.pager
.Pager
;
17 import eu
.etaxonomy
.cdm
.model
.description
.MediaKey
;
18 import eu
.etaxonomy
.cdm
.model
.location
.NamedArea
;
19 import eu
.etaxonomy
.cdm
.model
.media
.Media
;
20 import eu
.etaxonomy
.cdm
.model
.media
.Rights
;
21 import eu
.etaxonomy
.cdm
.model
.taxon
.Taxon
;
22 import eu
.etaxonomy
.cdm
.persistence
.dao
.initializer
.IBeanInitializer
;
23 import eu
.etaxonomy
.cdm
.persistence
.query
.OrderHint
;
25 public interface IMediaService
extends IIdentifiableEntityService
<Media
> {
28 * Return a List of MediaKeys, optionally filtered by the parameters passed.
30 * @param taxonomicScope a Set of Taxon instances that define the taxonomic scope of the key (can be null)
31 * @param geoScopes a Set of NamedArea instances that define the geospatial scope of the key (can be null)
32 * @param pageSize The maximum number of keys returned (can be null for all keys)
33 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
34 * @param propertyPaths Properties to initialize in the returned entities, following the syntax described in {@link IBeanInitializer#initialize(Object, List)}
35 * @return a Pager containing MediaKey instances
37 public Pager
<MediaKey
> getMediaKeys(Set
<Taxon
> taxonomicScope
, Set
<NamedArea
> geoScopes
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
40 * Return a Pager of rights belonging to this object
42 * @param t The media object
43 * @param pageSize The maximum number of rights returned (can be null for all rights)
44 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
45 * @param propertyPaths properties to initialize - see {@link IBeanInitializer#initialize(Object, List)}
46 * @return a Pager of Rights entities
48 public Pager
<Rights
> getRights(Media t
, Integer pageSize
, Integer pageNumber
, List
<String
> propertyPaths
);
51 * Returns a Paged List of Media instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser)
53 * @param clazz filter the results by class (or pass null to return all Media instances)
55 * @param pageSize The maximum number of media returned (can be null for all matching media)
56 * @param pageNumber The offset (in pageSize chunks) from the start of the result set (0 - based)
58 * Supports path like <code>orderHints.propertyNames</code> which
59 * include *-to-one properties like createdBy.username or
60 * authorTeam.persistentTitleCache
61 * @param propertyPaths properties to be initialized
62 * @return a Pager Media instances
63 * @see <a href="http://lucene.apache.org/java/2_4_0/queryparsersyntax.html">Apache Lucene - Query Parser Syntax</a>
65 public Pager
<Media
> search(Class
<?
extends Media
> clazz
, String queryString
, Integer pageSize
, Integer pageNumber
, List
<OrderHint
> orderHints
, List
<String
> propertyPaths
);