Java Doc for HelpManager.java in  » ERP-CRM-Financial » sakai » org » sakaiproject » api » app » help » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » ERP CRM Financial » sakai » org.sakaiproject.api.app.help 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.sakaiproject.api.app.help.HelpManager

All known Subclasses:   org.sakaiproject.component.app.help.HelpManagerImpl,
HelpManager
public interface HelpManager (Code)
Help Manager for the Sakai Help Tool.
version:
   $Id: HelpManager.java 7900 2006-04-18 08:04:32Z marquard@ched.uct.ac.za $




Method Summary
public  voidaddContexts(Map session, String mappedView)
    
public  CategorycreateCategory()
    
public  ResourcecreateResource()
    
public  voiddeleteContext(Long contextId)
    
public  voiddeleteResource(Long resourceId)
    
public  voiddeleteSource(Long sourceId)
    
public  ListgetActiveContexts(Map session)
     returns a list of all active contexts.
public  ContextgetContext(Long id)
    
public  ListgetContexts(String mappedView)
    
public  StringgetExternalLocation()
    
public  GlossarygetGlossary()
    
public  ResourcegetResource(Long id)
    
public  ResourcegetResourceByDocId(String helpDocIdString)
    
public  SetgetResources(Long context)
    
public  MapgetResourcesForActiveContexts(Map session)
    
public  RestConfigurationgetRestConfiguration()
    
public  ServerConfigurationServicegetServerConfigurationService()
    
public  SourcegetSource(Long id)
    
public  StringgetSupportEmailAddress()
    
public  TableOfContentsgetTableOfContents()
    
public  StringgetWelcomePage()
    
public  voidinitialize()
     Synchronize initialization of the manager.
public  voidreInitialize()
     reInitialization of the help tool.
public  GlossaryEntrysearchGlossary(String keyword)
     searches the glossary for the keyword.
public  SetsearchResources(String query)
    
public  voidsetServerConfigurationService(ServerConfigurationService s)
    
public  voidsetTableOfContents(TableOfContents toc)
    
public  voidstoreCategory(Category category)
    
public  voidstoreContext(Context context)
    
public  voidstoreResource(Resource resource)
    
public  voidstoreSource(Source source)
    



Method Detail
addContexts
public void addContexts(Map session, String mappedView)(Code)
adds a context to the active context list
Parameters:
  session -
Parameters:
  mappedView -



createCategory
public Category createCategory()(Code)
Create Category Category



createResource
public Resource createResource()(Code)
create a resource Resource



deleteContext
public void deleteContext(Long contextId)(Code)
delete context by id
Parameters:
  contextId -



deleteResource
public void deleteResource(Long resourceId)(Code)
delete a resource by id
Parameters:
  resourceId -



deleteSource
public void deleteSource(Long sourceId)(Code)
delete source by id
Parameters:
  sourceId -



getActiveContexts
public List getActiveContexts(Map session)(Code)
returns a list of all active contexts. Active contexts are created when the user navigates around the site.
Parameters:
  session -



getContext
public Context getContext(Long id)(Code)
get context by id
Parameters:
  id - Context



getContexts
public List getContexts(String mappedView)(Code)
find all contexts associated with mappedView
Parameters:
  mappedView - - list of contexts (String)



getExternalLocation
public String getExternalLocation()(Code)
get static EXTERNAL_LOCATION EXTERNAL_LOCATION



getGlossary
public Glossary getGlossary()(Code)
get glossary Glossary



getResource
public Resource getResource(Long id)(Code)
get a resource by id
Parameters:
  id -



getResourceByDocId
public Resource getResourceByDocId(String helpDocIdString)(Code)
get resource by doc id
Parameters:
  helpDocIdString - Resource



getResources
public Set getResources(Long context)(Code)
get Resources for a context
Parameters:
  context - set of resources associated with the supplied context



getResourcesForActiveContexts
public Map getResourcesForActiveContexts(Map session)(Code)

Parameters:
  session - map of resources keyed by active contexts



getRestConfiguration
public RestConfiguration getRestConfiguration()(Code)
get REST configuration REST configuration



getServerConfigurationService
public ServerConfigurationService getServerConfigurationService()(Code)
get server config service



getSource
public Source getSource(Long id)(Code)
get source
Parameters:
  id - Source



getSupportEmailAddress
public String getSupportEmailAddress()(Code)
get support email address address as string



getTableOfContents
public TableOfContents getTableOfContents()(Code)
get table of contents of manager TableOfContents



getWelcomePage
public String getWelcomePage()(Code)
get Welcome Page docId of Welcome Page



initialize
public void initialize()(Code)
Synchronize initialization of the manager.



reInitialize
public void reInitialize()(Code)
reInitialization of the help tool.



searchGlossary
public GlossaryEntry searchGlossary(String keyword)(Code)
searches the glossary for the keyword. Returns a GlossaryEntry for this keyword if found, return null if no entry is found.
Parameters:
  keyword -



searchResources
public Set searchResources(String query) throws RuntimeException(Code)

Parameters:
  query - set of resources found by searching with the supplied query.
throws:
  RuntimeException - - if query can't be parsed



setServerConfigurationService
public void setServerConfigurationService(ServerConfigurationService s)(Code)
set server config service
Parameters:
  s -



setTableOfContents
public void setTableOfContents(TableOfContents toc)(Code)
set table of contents
Parameters:
  toc -



storeCategory
public void storeCategory(Category category)(Code)
Store Category
Parameters:
  category -



storeContext
public void storeContext(Context context)(Code)
store context
Parameters:
  context -



storeResource
public void storeResource(Resource resource)(Code)
persist a resource
Parameters:
  resource -



storeSource
public void storeSource(Source source)(Code)
store source
Parameters:
  source -



www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.