org.sakaiproject.entitybroker.entityprovider.capabilities

Interface Searchable

All Superinterfaces:

EntityProvider

public interface Searchable
extends EntityProvider

Indicates an entity provider has the capability of allowing the entities associated with it to be searchable, entities which implement this will be linked to the core search functionality
If you need to force an entity or entities to be added to the search indexes then you should use the SearchProvider.add(String, org.sakaiproject.entitybroker.entityprovider.extension.SearchContent) method in the system core to cause immediate indexing
This is one of the capability extensions for the EntityProvider interface

Author:

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

Method Summary

Modifier and Type	Method and Description
List<String>	getAllRefs(String context) Retrieve all entities for a given context
SearchContent	getData(String reference) Will be called to retrieve the data for this item when the system thinks the data related to an entity may have changed

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

getEntityPrefix

Method Detail

getData

SearchContent getData(String reference)

Will be called to retrieve the data for this item when the system thinks the data related to an entity may have changed

Parameters:

reference - a globally unique reference to an entity (e.g. /myprefix/myid), consists of the entity prefix and optional segments (normally the id at least)

Returns:

the search content which should be indexed OR null to cause nothing to happen

Throws:

EntityNotFoundException - if it does not exist (causes the search system to purge out the entry)

getAllRefs

List<String> getAllRefs(String context)

Retrieve all entities for a given context

Parameters:

context - probably a site or group but this may also be null to indicate that the entire list of all entity refs should be sent

Returns:

the list of all entity references (e.g. /myprefix/myid)