|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.sakaiproject.search.tool.SearchBeanImpl
public class SearchBeanImpl
Implementation of the search bean backing bean
Nested Class Summary | |
---|---|
static class |
SearchBeanImpl.Scope
|
protected class |
SearchBeanImpl.TermHolder
|
Field Summary | |
---|---|
static String |
SEARCH_ALL_SITES
|
static String |
SEARCH_SITE_IDS
|
Constructor Summary | |
---|---|
SearchBeanImpl(javax.servlet.http.HttpServletRequest request,
SearchService searchService,
org.sakaiproject.site.api.SiteService siteService,
org.sakaiproject.tool.api.ToolManager toolManager,
org.sakaiproject.user.api.UserDirectoryService userDirectoryService,
org.sakaiproject.authz.api.SecurityService securityService,
org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)
Creates a searchBean |
|
SearchBeanImpl(javax.servlet.http.HttpServletRequest request,
String sortName,
String filterName,
SearchService searchService,
org.sakaiproject.site.api.SiteService siteService,
org.sakaiproject.tool.api.ToolManager toolManager,
org.sakaiproject.user.api.UserDirectoryService userDirectoryService,
org.sakaiproject.authz.api.SecurityService securityService,
org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)
|
|
SearchBeanImpl(String siteId,
SearchService ss,
String search,
org.sakaiproject.tool.api.ToolManager tm,
org.sakaiproject.authz.api.SecurityService securityService,
org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)
|
Method Summary | |
---|---|
protected Properties |
extractPropertiesFromTool()
|
protected String[] |
extractSiteIdsFromProperties(Properties props)
|
boolean |
foundNoResults()
|
protected String[] |
getAllUsersSites()
Get all the sites a user has access to. |
String |
getBaseUrl()
get the base URL |
int |
getCensoredResultCount()
|
String |
getDateNow()
get the date now in RFS-822 format |
String |
getErrorMessage()
get the error message |
int |
getNlistPages()
|
int |
getNresults()
The Total number of results |
String |
getOpenSearchUrl()
Get the OpensearchURL |
List<SearchPage> |
getPages()
get a pager objects |
int |
getPagesize()
|
String |
getPortalBaseUrl()
|
int |
getRequestPage()
|
String |
getRequestUrl()
get the request URL |
List<SearchOutputItem> |
getResults()
get the results for the current pages |
String |
getRssURL()
get the RSS URL |
String |
getSearch()
Gets the current search request |
String |
getSearchFound()
get the found string |
String |
getSearchFoundCensored()
|
protected List<String> |
getSearchSites(String[] toolPropertySiteIds)
|
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)
Deprecated. |
String |
getTimeTaken()
The time taken to perform the search only, not including rendering |
protected String[] |
getToolPropertySiteIds()
|
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)
|
SearchList |
search()
Perform the search |
void |
setNlistPages(int nlistPages)
|
void |
setPagesize(int pagesize)
|
void |
setRequestPage(int requestPage)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String SEARCH_SITE_IDS
public static final String SEARCH_ALL_SITES
Constructor Detail |
---|
public SearchBeanImpl(String siteId, SearchService ss, String search, org.sakaiproject.tool.api.ToolManager tm, org.sakaiproject.authz.api.SecurityService securityService, org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService)
public SearchBeanImpl(javax.servlet.http.HttpServletRequest request, SearchService searchService, org.sakaiproject.site.api.SiteService siteService, org.sakaiproject.tool.api.ToolManager toolManager, org.sakaiproject.user.api.UserDirectoryService userDirectoryService, org.sakaiproject.authz.api.SecurityService securityService, org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService) throws org.sakaiproject.exception.IdUnusedException
request
- The HTTP requestsearchService
- The search service to usesiteService
- the site serviceportalService
- the portal service
org.sakaiproject.exception.IdUnusedException
- if there is no current worksitepublic SearchBeanImpl(javax.servlet.http.HttpServletRequest request, String sortName, String filterName, SearchService searchService, org.sakaiproject.site.api.SiteService siteService, org.sakaiproject.tool.api.ToolManager toolManager, org.sakaiproject.user.api.UserDirectoryService userDirectoryService, org.sakaiproject.authz.api.SecurityService securityService, org.sakaiproject.component.api.ServerConfigurationService serverConfigurationService) throws org.sakaiproject.exception.IdUnusedException
org.sakaiproject.exception.IdUnusedException
#SearchBeanImpl(HttpServletRequest, SearchService, SiteService, ToolManager)
Method Detail |
---|
public String getTerms(String format)
SearchBean
getTerms
in interface SearchBean
format
- format is {0} is the term {1} is the frequency
public boolean isEnabled()
SearchBean
isEnabled
in interface SearchBean
public boolean isScope(String scope)
isScope
in interface SearchBean
public String getSearch()
getSearch
in interface SearchBean
public String getTimeTaken()
protected List<String> getSearchSites(String[] toolPropertySiteIds)
protected String[] getToolPropertySiteIds()
protected String[] getAllUsersSites()
protected String[] extractSiteIdsFromProperties(Properties props)
protected Properties extractPropertiesFromTool()
public SearchList search()
public int getNlistPages()
public void setNlistPages(int nlistPages)
nlistPages
- The nlistPages to set.public int getPagesize()
public void setPagesize(int pagesize)
pagesize
- The pagesize to set.public int getRequestPage()
public void setRequestPage(int requestPage)
requestPage
- The requestPage to set.public int getNresults()
getNresults
in interface SearchBean
public String getSearchTitle()
getSearchTitle
in interface SearchBean
public boolean hasAdmin()
hasAdmin
in interface SearchBean
public String getToolUrl()
getToolUrl
in interface SearchBean
public boolean hasResults()
SearchBean
hasResults
in interface SearchBean
public boolean foundNoResults()
foundNoResults
in interface SearchBean
public String getOpenSearchUrl()
SearchBean
getOpenSearchUrl
in interface SearchBean
public String getSherlockIconUrl()
getSherlockIconUrl
in interface SearchBean
public String getSherlockUpdateUrl()
getSherlockUpdateUrl
in interface SearchBean
public String getBaseUrl()
SearchBean
getBaseUrl
in interface SearchBean
public String getPortalBaseUrl()
getPortalBaseUrl
in interface SearchBean
public String getSiteTitle()
SearchBean
getSiteTitle
in interface SearchBean
public String getSystemName()
SearchBean
getSystemName
in interface SearchBean
public List<SearchPage> getPages()
SearchBean
getPages
in interface SearchBean
public List<SearchOutputItem> getResults()
SearchBean
getResults
in interface SearchBean
public String getSearchFound()
SearchBean
getSearchFound
in interface SearchBean
public String getSearchFoundCensored()
public List<SearchTerm> getTerms()
SearchBean
getTerms
in interface SearchBean
public boolean hasError()
SearchBean
hasError
in interface SearchBean
public String getErrorMessage()
SearchBean
getErrorMessage
in interface SearchBean
public String getRssURL()
SearchBean
getRssURL
in interface SearchBean
public String getDateNow()
SearchBean
getDateNow
in interface SearchBean
public String getRequestUrl()
SearchBean
getRequestUrl
in interface SearchBean
public int getCensoredResultCount()
public String getSuggestion()
getSuggestion
in interface SearchBean
public boolean hasSuggestion()
hasSuggestion
in interface SearchBean
public String getSuggestionUrl()
getSuggestionUrl
in interface SearchBean
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |