org.sakaiproject.search.tool.api
Interface SearchBeanFactory

All Known Implementing Classes:
SearchBeanFactoryImpl

public interface SearchBeanFactory

A factory bean to construct backing beans efficiently on a request basis. This is normally injected into the request attributes for each individual page to construct the backing beans that they require. Ideally there should be a one to one mapping between backing beans and pages, and the page should be as simple as possible

Author:
ieb

Field Summary
static String SEARCH_BEAN_FACTORY_ATTR
           
 
Method Summary
 OpenSearchBean newOpenSearchBean(javax.servlet.http.HttpServletRequest request)
          get a OpenSearchBean model
 SearchAdminBean newSearchAdminBean(javax.servlet.http.HttpServletRequest request)
          Create a search admin bean based ont he request
 SearchBean newSearchBean(javax.servlet.http.HttpServletRequest request)
          create a search bean based on the request
 SearchBean newSearchBean(javax.servlet.http.HttpServletRequest request, String sortName, String filterName)
           
 SherlockSearchBean newSherlockSearchBean(javax.servlet.http.HttpServletRequest request)
          get a Sherlock SearchBean model
 void setContext(javax.servlet.ServletContext servletContext)
          set the servlet context that this factory is associated with
 

Field Detail

SEARCH_BEAN_FACTORY_ATTR

static final String SEARCH_BEAN_FACTORY_ATTR
Method Detail

newSearchBean

SearchBean newSearchBean(javax.servlet.http.HttpServletRequest request)
                         throws org.sakaiproject.exception.PermissionException
create a search bean based on the request

Parameters:
request -
Returns:
Throws:
org.sakaiproject.exception.PermissionException

newSearchBean

SearchBean newSearchBean(javax.servlet.http.HttpServletRequest request,
                         String sortName,
                         String filterName)
                         throws org.sakaiproject.exception.PermissionException
Throws:
org.sakaiproject.exception.PermissionException

newSearchAdminBean

SearchAdminBean newSearchAdminBean(javax.servlet.http.HttpServletRequest request)
                                   throws org.sakaiproject.exception.PermissionException
Create a search admin bean based ont he request

Parameters:
request -
Returns:
Throws:
org.sakaiproject.exception.PermissionException

newOpenSearchBean

OpenSearchBean newOpenSearchBean(javax.servlet.http.HttpServletRequest request)
                                 throws org.sakaiproject.exception.PermissionException
get a OpenSearchBean model

Parameters:
request -
Returns:
Throws:
org.sakaiproject.exception.PermissionException

newSherlockSearchBean

SherlockSearchBean newSherlockSearchBean(javax.servlet.http.HttpServletRequest request)
                                         throws org.sakaiproject.exception.PermissionException
get a Sherlock SearchBean model

Parameters:
request -
Returns:
Throws:
org.sakaiproject.exception.PermissionException

setContext

void setContext(javax.servlet.ServletContext servletContext)
set the servlet context that this factory is associated with

Parameters:
servletContext -


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