01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/search/tags/sakai_2-4-1/search-tool/tool/src/java/org/sakaiproject/search/tool/api/OpenSearchBean.java $
03: * $Id: OpenSearchBean.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: public interface OpenSearchBean {
23: /**
24: * get the human readable site name for OpenSearch
25: * @return
26: */
27: String getSiteName();
28:
29: /**
30: * get the absoute icon url
31: * @return
32: */
33: String getIconUrl();
34:
35: /**
36: * Get the attribution text
37: * @return
38: */
39: String getAttibution();
40:
41: /**
42: * get the Sindication Rights
43: * @return
44: */
45: String getSindicationRight();
46:
47: /**
48: * get the adult content setting (defaults to false)
49: * @return
50: */
51: String getAdultContent();
52:
53: /**
54: * get the absolute search URL for HTML output
55: * @return
56: */
57: String getHTMLSearchTemplate();
58:
59: /**
60: * get the absolute search URL for RSS output
61: * @return
62: */
63: String getRSSSearchTemplate();
64:
65: /**
66: * get the Search Form URL
67: * @return
68: */
69: String getHTMLSearchFormUrl();
70:
71: /**
72: * get the name of the system
73: * @return
74: */
75: String getSystemName();
76:
77: }
|