org.sakaiproject.search.tool.api
Interface OpenSearchBean

All Known Implementing Classes:
OpenSearchBeanImpl

public interface OpenSearchBean


Method Summary
 String getAdultContent()
          get the adult content setting (defaults to false)
 String getAttibution()
          Get the attribution text
 String getHTMLSearchFormUrl()
          get the Search Form URL
 String getHTMLSearchTemplate()
          get the absolute search URL for HTML output
 String getIconUrl()
          get the absoute icon url
 String getRSSSearchTemplate()
          get the absolute search URL for RSS output
 String getSindicationRight()
          get the Sindication Rights
 String getSiteName()
          get the human readable site name for OpenSearch
 String getSystemName()
          get the name of the system
 

Method Detail

getSiteName

String getSiteName()
get the human readable site name for OpenSearch

Returns:

getIconUrl

String getIconUrl()
get the absoute icon url

Returns:

getAttibution

String getAttibution()
Get the attribution text

Returns:

getSindicationRight

String getSindicationRight()
get the Sindication Rights

Returns:

getAdultContent

String getAdultContent()
get the adult content setting (defaults to false)

Returns:

getHTMLSearchTemplate

String getHTMLSearchTemplate()
get the absolute search URL for HTML output

Returns:

getRSSSearchTemplate

String getRSSSearchTemplate()
get the absolute search URL for RSS output

Returns:

getHTMLSearchFormUrl

String getHTMLSearchFormUrl()
get the Search Form URL

Returns:

getSystemName

String getSystemName()
get the name of the system

Returns:


Copyright © 2003-2012 Sakai Project. All Rights Reserved.