01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/search/tags/sakai_2-4-1/search-tool/tool/src/java/org/sakaiproject/search/tool/api/SearchBeanFactory.java $
03: * $Id: SearchBeanFactory.java 22723 2007-03-16 01:35:32Z ian@caret.cam.ac.uk $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004, 2005, 2006 The Sakai Foundation.
07: *
08: * Licensed under the Educational Community License, Version 1.0 (the "License");
09: * you may not use this file except in compliance with the License.
10: * You may obtain a copy of the License at
11: *
12: * http://www.opensource.org/licenses/ecl1.php
13: *
14: * Unless required by applicable law or agreed to in writing, software
15: * distributed under the License is distributed on an "AS IS" BASIS,
16: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17: * See the License for the specific language governing permissions and
18: * limitations under the License.
19: *
20: **********************************************************************************/package org.sakaiproject.search.tool.api;
21:
22: import javax.servlet.ServletContext;
23: import javax.servlet.http.HttpServletRequest;
24:
25: import org.sakaiproject.exception.PermissionException;
26:
27: /**
28: * A factory bean to construct backing beans efficiently on a request basis.
29: * This is normally injected into the request attributes for each individual
30: * page to construct the backing beans that they require. Ideally there should
31: * be a one to one mapping between backing beans and pages, and the page should
32: * be as simple as possible
33: *
34: * @author ieb
35: */
36: public interface SearchBeanFactory {
37:
38: public final static String SEARCH_BEAN_FACTORY_ATTR = SearchBean.class
39: .getName();
40:
41: /**
42: * create a search bean based on the request
43: *
44: * @param request
45: * @return
46: * @throws PermissionException
47: */
48: SearchBean newSearchBean(HttpServletRequest request)
49: throws PermissionException;
50:
51: SearchBean newSearchBean(HttpServletRequest request,
52: String sortName, String filterName)
53: throws PermissionException;
54:
55: /**
56: * Create a search admin bean based ont he request
57: *
58: * @param request
59: * @return
60: * @throws PermissionException
61: */
62: SearchAdminBean newSearchAdminBean(HttpServletRequest request)
63: throws PermissionException;
64:
65: /**
66: * get a OpenSearchBean model
67: * @param request
68: * @return
69: * @throws PermissionException
70: */
71: OpenSearchBean newOpenSearchBean(HttpServletRequest request)
72: throws PermissionException;
73:
74: /**
75: * get a Sherlock SearchBean model
76: * @param request
77: * @return
78: * @throws PermissionException
79: */
80: SherlockSearchBean newSherlockSearchBean(HttpServletRequest request)
81: throws PermissionException;
82:
83: /**
84: * set the servlet context that this factory is associated with
85: * @param servletContext
86: */
87: void setContext(ServletContext servletContext);
88:
89: }
|