01: /**********************************************************************************
02: * $URL:https://source.sakaiproject.org/svn/osp/trunk/glossary/api/src/java/org/theospi/portfolio/help/model/Glossary.java $
03: * $Id:Glossary.java 9134 2006-05-08 20:28:42Z chmaurer@iupui.edu $
04: ***********************************************************************************
05: *
06: * Copyright (c) 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.theospi.portfolio.help.model;
21:
22: import java.util.Collection;
23: import java.util.Set;
24:
25: import org.sakaiproject.metaobj.shared.model.Id;
26: import org.sakaiproject.service.legacy.resource.DuplicatableToolService;
27:
28: public interface Glossary extends DuplicatableToolService {
29: public GlossaryEntry load(Id id);
30:
31: /**
32: * find the keyword in the glossary.
33: * return null if not found.
34: * @param keyword
35: * @return
36: */
37: public GlossaryEntry find(String keyword, String worksite);
38:
39: /**
40: * returns the list of all GlossaryEntries
41: * @return
42: */
43: public Collection findAll(String keyword, String worksite);
44:
45: public Collection findAll(String worksite);
46:
47: public Collection findAll();
48:
49: public Collection findAllGlobal();
50:
51: /**
52: * url to glossary web page
53: * @return
54: */
55: public String getUrl();
56:
57: public GlossaryEntry addEntry(GlossaryEntry newEntry);
58:
59: public void removeEntry(GlossaryEntry entry);
60:
61: public void updateEntry(GlossaryEntry entry);
62:
63: public boolean isPhraseStart(String phraseFragment, String worksite);
64:
65: public Set getSortedWorksiteTerms(String siteId);
66:
67: public void checkCache();
68: }
|