eu.etaxonomy.cdm.api.service
Interface IMediaService

All Superinterfaces:

IAnnotatableService<Media>, IIdentifiableEntityService<Media>, IService<Media>, IVersionableService<Media>

All Known Implementing Classes:

MediaServiceImpl

public interface IMediaService
extends IIdentifiableEntityService<Media>

Method Summary

Pager<MediaKey>	getMediaKeys(Set<Taxon> taxonomicScope, Set<NamedArea> geoScopes, Integer pageSize, Integer pageNumber, List<String> propertyPaths) Return a List of MediaKeys, optionally filtered by the parameters passed.
Pager<Rights>	getRights(Media t, Integer pageSize, Integer pageNumber, List<String> propertyPaths) Return a Pager of rights belonging to this object
Pager<Media>	search(Class<? extends Media> clazz, String queryString, Integer pageSize, Integer pageNumber, List<OrderHint> orderHints, List<String> propertyPaths) Returns a Paged List of Media instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser)

Methods inherited from interface eu.etaxonomy.cdm.api.service.IIdentifiableEntityService

countByTitle, countByTitle, deduplicate, find, findByTitle, findByTitle, findTitleCache, getSourcedObjectByIdInSource, getSources, getUuidAndTitleCache, listByReferenceTitle, listByTitle, replace, updateTitleCache, updateTitleCache

Methods inherited from interface eu.etaxonomy.cdm.api.service.IAnnotatableService

countMarkers, getAnnotations, getMarkers, groupMarkers

Methods inherited from interface eu.etaxonomy.cdm.api.service.IVersionableService

getNextAuditEvent, getPreviousAuditEvent, pageAuditEvents, pageAuditEvents

Methods inherited from interface eu.etaxonomy.cdm.api.service.IService

clear, count, delete, exists, find, find, find, findById, getSession, group, list, list, load, load, lock, merge, page, refresh, refresh, rows, save, save, saveOrUpdate, saveOrUpdate, update

Method Detail

getMediaKeys

Pager<MediaKey> getMediaKeys(Set<Taxon> taxonomicScope,
                             Set<NamedArea> geoScopes,
                             Integer pageSize,
                             Integer pageNumber,
                             List<String> propertyPaths)

Return a List of MediaKeys, optionally filtered by the parameters passed.

Parameters:

taxonomicScope - a Set of Taxon instances that define the taxonomic scope of the key (can be null)

geoScopes - a Set of NamedArea instances that define the geospatial scope of the key (can be null)

pageSize - The maximum number of keys returned (can be null for all keys)

pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)

propertyPaths - Properties to initialize in the returned entities, following the syntax described in IBeanInitializer.initialize(Object, List)

Returns:

a Pager containing MediaKey instances

getRights

Pager<Rights> getRights(Media t,
                        Integer pageSize,
                        Integer pageNumber,
                        List<String> propertyPaths)

Return a Pager of rights belonging to this object

Specified by:

getRights in interface IIdentifiableEntityService<Media>

Parameters:

t - The media object

pageSize - The maximum number of rights returned (can be null for all rights)

pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)

propertyPaths - properties to initialize - see IBeanInitializer.initialize(Object, List)

Returns:

a Pager of Rights entities

search

Pager<Media> search(Class<? extends Media> clazz,
                    String queryString,
                    Integer pageSize,
                    Integer pageNumber,
                    List<OrderHint> orderHints,
                    List<String> propertyPaths)

Returns a Paged List of Media instances where the default field matches the String queryString (as interpreted by the Lucene QueryParser)

Specified by:

search in interface IIdentifiableEntityService<Media>

Parameters:

clazz - filter the results by class (or pass null to return all Media instances)

queryString -

pageSize - The maximum number of media returned (can be null for all matching media)

pageNumber - The offset (in pageSize chunks) from the start of the result set (0 - based)

orderHints - Supports path like orderHints.propertyNames which include *-to-one properties like createdBy.username or authorTeam.persistentTitleCache

propertyPaths - properties to be initialized

Returns:

a Pager Media instances

See Also:

Apache Lucene - Query Parser Syntax