org.sakaiproject.entitybroker.entityprovider.extension
Interface TagSearchService

All Superinterfaces:

TagProvider

public interface TagSearchService
extends TagProvider

Defines the methods necessary for searching for entities by tags (shared interface)

Author:

Aaron Zeckoski (aaron@caret.cam.ac.uk)

Method Summary

List<EntityData>

findEntitesByTags(String[] tags, String[] prefixes, boolean matchAll, Search search) Search for all entities with a set of tags, prefixes, and a search

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.extension.TagProvider

addTagsToEntity, getTagsForEntity, removeTagsFromEntity, setTagsForEntity

Method Detail

findEntitesByTags

List<EntityData> findEntitesByTags(String[] tags,
                                   String[] prefixes,
                                   boolean matchAll,
                                   Search search)

Search for all entities with a set of tags, prefixes, and a search

Parameters:

tags - a set of tags defined on these entities which should match

prefixes - (optional) limit the search to a given set of prefixes

matchAll - if true then all tags must be matched, else find entities with any tags in the set given

search - (optional) search params which are used to limit the return (paging and max/limit)

Returns:

a list of entity data objects representing all found entities