01: /**********************************************************************************
02: * $URL: https://source.sakaiproject.org/svn/help/tags/sakai_2-4-1/help-api/src/java/org/sakaiproject/api/app/help/Glossary.java $
03: * $Id: Glossary.java 7653 2006-04-12 12:10:02Z marquard@ched.uct.ac.za $
04: ***********************************************************************************
05: *
06: * Copyright (c) 2003, 2004 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.api.app.help;
21:
22: import java.util.Collection;
23:
24: /**
25: * @version $Id: Glossary.java 7653 2006-04-12 12:10:02Z marquard@ched.uct.ac.za $
26: */
27: public interface Glossary {
28: /**
29: * find the keyword in the glossary.
30: * return null if not found.
31: * @param keyword
32: * @return a GlossaryEntry
33: */
34: public GlossaryEntry find(String keyword);
35:
36: /**
37: * returns the list of all GlossaryEntries
38: * @return a Collection
39: */
40: public Collection findAll();
41:
42: /**
43: * url to glossary web page
44: * @return the Url
45: */
46: public String getUrl();
47: }
|