| org.sakaiproject.search.tool.api.SearchBean
All known Subclasses: org.sakaiproject.search.tool.SearchBeanImpl,
| SearchBean | | public interface SearchBean (Code) | | An interface describing the backing bean to the search page
author:
ieb |
| foundNoResults | | boolean foundNoResults()(Code) | | |
| getDateNow | | String getDateNow()(Code) | | get the date now in RFS-822 format
|
| getErrorMessage | | String getErrorMessage()(Code) | | get the error message
|
| getHeader | | String getHeader(String headerFormat)(Code) | | Format the header, param {0} is the start doc on the page {1} is the end
doc {2} is the total docs, {3} is the time taken.
Parameters:
headerFormat - |
| getNresults | | int getNresults()(Code) | | |
| getOpenSearchUrl | | String getOpenSearchUrl()(Code) | | Get the OpensearchURL
|
| getPager | | String getPager(String pagerFormati, String singlePageFormat) throws UnsupportedEncodingException(Code) | | get an html fragment representing a pager the
Parameters:
pagerFormat - A MessageFormat format string {0} is the page URL, {1} is the pagetext, {2} is a css class id, 0 for first, 1 for middle, 2 for end |
| getRequestUrl | | String getRequestUrl()(Code) | | get the request URL
|
| getSearchFound | | String getSearchFound()(Code) | | get the found string
|
| getSearchResults | | String getSearchResults(String searchItemFormat, String errorFeedbackFormat)(Code) | | get an html fragmnent representing the search results
Parameters:
searchItemFormat - A Message format string {0} is the result index, {1} is the itemUR, {2} is the item title, {3} is the content fragment, {4} is thescore
Parameters:
errorFeedbackFormat - {0} is the error message location |
| getSearchTitle | | String getSearchTitle()(Code) | | Title for the search page
|
| getSystemName | | String getSystemName()(Code) | | get the name of the system
|
| getTerms | | String getTerms(String format)(Code) | | Get a formatted list of terms
Parameters:
format - format is {0} is the term {1} is the frequency |
| getToolUrl | | String getToolUrl()(Code) | | Gets the base url for the tool
|
| hasAdmin | | boolean hasAdmin()(Code) | | true if the user has admin rights
|
| hasError | | boolean hasError()(Code) | | does the page have an error
|
| hasResults | | boolean hasResults()(Code) | | Returns true if a search has been performed and there are some results
|
| isEnabled | | boolean isEnabled()(Code) | | returns true if search isEnabled
|
|
|