org.sakaiproject.entitybroker.entityprovider.capabilities

Interface TagProvideable

All Superinterfaces:

EntityProvider, Taggable, TagProvider

public interface TagProvideable
extends Taggable, TagProvider

Allows an entity to control and provide tag storage and searching, this overrides internal tag storage and any existing tag storage will be ignored in favor of the provided tags
This is the provider interface for Taggable, inherits all methods from TagProvider
This is one of the capability extensions for the EntityProvider interface

Author:

Aaron Zeckoski (azeckoski @ gmail.com)

Method Summary

Methods

Modifier and Type	Method and Description
List<EntityData>	findEntitesByTags(String[] tags, boolean matchAll, Search search) Search for all entities which have the given tags, can limit the return using the search object NOTE: Don't forget to check the RequestStorable request params for extra information about the current user and location and other possible params when implementing this

Methods inherited from interface org.sakaiproject.entitybroker.entityprovider.EntityProvider

getEntityPrefix

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

addTagsToEntity, getTagsForEntity, removeTagsFromEntity, setTagsForEntity

Method Detail

findEntitesByTags

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

Search for all entities which have the given tags, can limit the return using the search object
NOTE: Don't forget to check the RequestStorable request params for extra information about the current user and location and other possible params when implementing this

Parameters:

tags - a set of tags associated with entities

matchAll - if true then all tags must exist on the entity for it to be matched, if false then the entity just has to have one or more of the given tags

search - (optional) a search object, used to order or limit the number of returned results, restrictions will be typically ignored

Returns:

a list of entity search results (contains the ref, url, displayname of the matching entities)

Throws:

IllegalArgumentException - if the tags set is empty or null