01: /**********************************************************************************
02: * $URL:https://source.sakaiproject.org/svn/osp/trunk/glossary/api/src/java/org/theospi/portfolio/help/model/HelpManager.java $
03: * $Id:HelpManager.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.io.IOException;
23: import java.util.Collection;
24: import java.util.Set;
25:
26: import org.jdom.JDOMException;
27: import org.sakaiproject.exception.UnsupportedFileTypeException;
28: import org.sakaiproject.metaobj.shared.model.Id;
29: import org.theospi.portfolio.shared.model.Node;
30:
31: /**
32: * Responsible for managing help activities. This includes
33: * managing contexts, resources, the glossary, and the
34: * table of contents.
35: *
36: * @see org.theospi.portfolio.help.model.Glossary
37: */
38: public interface HelpManager {
39:
40: public final static String TOOL_GLOBAL_GLOSSARY = "theospi.help.glossary.global";
41: public final static String GLOBAL_GLOSSARY_QUALIFIER = "theospi.help.glossary.global";
42:
43: /**
44: * searches the glossary for the keyword.
45: * Returns a GlossaryEntry for this keyword if found,
46: * return null if no entry is found.
47: * @param keyword
48: * @return
49: */
50: public GlossaryEntry searchGlossary(String keyword);
51:
52: public boolean isPhraseStart(String phraseFragment);
53:
54: public Glossary getGlossary();
55:
56: public GlossaryEntry addEntry(GlossaryEntry newEntry);
57:
58: public void removeEntry(GlossaryEntry entry);
59:
60: public void updateEntry(GlossaryEntry entry);
61:
62: public Collection getWorksiteTerms();
63:
64: public boolean isMaintainer();
65:
66: public boolean isGlobal();
67:
68: public void removeFromSession(Object obj);
69:
70: public Set getSortedWorksiteTerms();
71:
72: public Node getNode(Id artifactId);
73:
74: public void importTermsResource(String resourceId,
75: boolean replaceExisting) throws IOException,
76: UnsupportedFileTypeException, JDOMException;
77:
78: public void importTermsResource(Id worksiteId, String resourceId,
79: boolean replaceExisting) throws IOException,
80: UnsupportedFileTypeException, JDOMException;
81: }
|