org.sakaiproject.search.tool.api
Interface SearchBean

All Known Implementing Classes:
SearchBeanImpl

public interface SearchBean

An interface describing the backing bean to the search page

Author:
ieb

Method Summary
 boolean foundNoResults()
           
 String getBaseUrl()
          get the base URL
 String getDateNow()
          get the date now in RFS-822 format
 String getErrorMessage()
          get the error message
 int getNresults()
           
 String getOpenSearchUrl()
          Get the OpensearchURL
 List<SearchPage> getPages()
          get a pager objects
 String getPortalBaseUrl()
           
 String getRequestUrl()
          get the request URL
 List<SearchOutputItem> getResults()
          get the results for the current pages
 String getRssURL()
          get the RSS URL
 String getSearch()
          The search text
 String getSearchFound()
          get the found string
 String getSearchTitle()
          Title for the search page
 String getSherlockIconUrl()
           
 String getSherlockUpdateUrl()
           
 String getSiteTitle()
          Get the site title
 String getSuggestion()
           
 String getSuggestionUrl()
           
 String getSystemName()
          get the name of the system
 List<SearchTerm> getTerms()
          get the terms on the current page
 String getTerms(String format)
          Get a formatted list of terms
 String getToolUrl()
          Gets the base url for the tool
 boolean hasAdmin()
          true if the user has admin rights
 boolean hasError()
          does the page have an error
 boolean hasResults()
          Returns true if a search has been performed and there are some results
 boolean hasSuggestion()
           
 boolean isEnabled()
          returns true if search isEnabled
 boolean isScope(String scope)
           
 

Method Detail

getSearchTitle

String getSearchTitle()
Title for the search page

Returns:

hasAdmin

boolean hasAdmin()
true if the user has admin rights

Returns:

getToolUrl

String getToolUrl()
Gets the base url for the tool

Returns:

getSearch

String getSearch()
The search text

Returns:

isEnabled

boolean isEnabled()
returns true if search isEnabled

Returns:

getTerms

String getTerms(String format)
Get a formatted list of terms

Parameters:
format - format is {0} is the term {1} is the frequency
Returns:

hasResults

boolean hasResults()
Returns true if a search has been performed and there are some results

Returns:

getOpenSearchUrl

String getOpenSearchUrl()
Get the OpensearchURL

Returns:

getSiteTitle

String getSiteTitle()
Get the site title

Returns:

getBaseUrl

String getBaseUrl()
get the base URL

Returns:

getSystemName

String getSystemName()
get the name of the system

Returns:

getSearchFound

String getSearchFound()
get the found string

Returns:

getPages

List<SearchPage> getPages()
get a pager objects

Returns:

getResults

List<SearchOutputItem> getResults()
get the results for the current pages

Returns:

getTerms

List<SearchTerm> getTerms()
get the terms on the current page

Returns:

hasError

boolean hasError()
does the page have an error

Returns:

getErrorMessage

String getErrorMessage()
get the error message

Returns:

getRssURL

String getRssURL()
get the RSS URL

Returns:

getDateNow

String getDateNow()
get the date now in RFS-822 format

Returns:

getRequestUrl

String getRequestUrl()
get the request URL

Returns:

getNresults

int getNresults()
Returns:

foundNoResults

boolean foundNoResults()
Returns:

getSherlockIconUrl

String getSherlockIconUrl()
Returns:

getSherlockUpdateUrl

String getSherlockUpdateUrl()
Returns:

getPortalBaseUrl

String getPortalBaseUrl()
Returns:

isScope

boolean isScope(String scope)

getSuggestion

String getSuggestion()

hasSuggestion

boolean hasSuggestion()

getSuggestionUrl

String getSuggestionUrl()


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