org.sakaiproject.search.entitybroker
Class SearchEntityProvider

java.lang.Object
  org.sakaiproject.entitybroker.util.AbstractEntityProvider
      org.sakaiproject.search.entitybroker.SearchEntityProvider

All Implemented Interfaces:

org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable, org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable, org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable, org.sakaiproject.entitybroker.entityprovider.EntityProvider, org.sakaiproject.entitybroker.entityprovider.extension.Formats, org.springframework.beans.factory.DisposableBean, org.springframework.beans.factory.InitializingBean

public class SearchEntityProvider
extends org.sakaiproject.entitybroker.util.AbstractEntityProvider
implements org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable, org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable, org.sakaiproject.entitybroker.entityprovider.capabilities.Describeable

Provides basic search functionality via EB.

Author:

Adrian Fish (a.fish@lancaster.ac.uk)

Nested Class Summary

class

SearchEntityProvider.SearchResultEntity

Field Summary

org.sakaiproject.user.api.UserDirectoryService

userDirectoryService

Fields inherited from class org.sakaiproject.entitybroker.util.AbstractEntityProvider

developerHelperService

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable

SEARCH_LOCATION_REFERENCE, SEARCH_TAGS, SEARCH_USER_REFERENCE

Fields inherited from interface org.sakaiproject.entitybroker.entityprovider.extension.Formats

ALL_KNOWN_FORMATS, ATOM, ATOM_EXTENSIONS, ATOM_MIME_TYPE, FORM, FORM_EXTENSIONS, FORM_MIME_TYPE, HTML, HTML_EXTENSIONS, HTML_MIME_TYPE, JSON, JSON_EXTENSIONS, JSON_MIME_TYPE, JSONP, JSONP_EXTENSIONS, JSONP_MIME_TYPE, RSS, RSS_EXTENSIONS, RSS_MIME_TYPE, TXT, TXT_EXTENSIONS, TXT_MIME_TYPE, UTF_8, XML, XML_EXTENSIONS, XML_MIME_TYPE

Constructor Summary

SearchEntityProvider()

Method Summary

List<?>	getEntities(org.sakaiproject.entitybroker.EntityReference ref, org.sakaiproject.entitybroker.entityprovider.search.Search search)
Object	getEntity(org.sakaiproject.entitybroker.EntityReference ref)
String	getEntityPrefix()
String[]	getHandledOutputFormats()
void	setSearchService(SearchService searchService)
void	setSiteService(org.sakaiproject.site.api.SiteService siteService)
void	setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService)

Methods inherited from class org.sakaiproject.entitybroker.util.AbstractEntityProvider

afterPropertiesSet, destroy, setDeveloperHelperService, setEntityProviderManager

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

userDirectoryService

public org.sakaiproject.user.api.UserDirectoryService userDirectoryService

Constructor Detail

SearchEntityProvider

public SearchEntityProvider()

Method Detail

setSearchService

public void setSearchService(SearchService searchService)

setSiteService

public void setSiteService(org.sakaiproject.site.api.SiteService siteService)

setUserDirectoryService

public void setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService)

getEntityPrefix

public String getEntityPrefix()

Specified by:

getEntityPrefix in interface org.sakaiproject.entitybroker.entityprovider.EntityProvider

getHandledOutputFormats

public String[] getHandledOutputFormats()

Specified by:

getHandledOutputFormats in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Outputable

getEntities

public List<?> getEntities(org.sakaiproject.entitybroker.EntityReference ref,
                           org.sakaiproject.entitybroker.entityprovider.search.Search search)

Specified by:

getEntities in interface org.sakaiproject.entitybroker.entityprovider.capabilities.CollectionResolvable

getEntity

public Object getEntity(org.sakaiproject.entitybroker.EntityReference ref)

Specified by:

getEntity in interface org.sakaiproject.entitybroker.entityprovider.capabilities.Resolvable