org.sakaiproject.api.app.help
Interface HelpManager

All Known Implementing Classes:
HelpManagerImpl

public interface HelpManager

Help Manager for the Sakai Help Tool.

Version:
$Id: HelpManager.java 2907 2005-10-25 19:28:37Z jlannan@iupui.edu $

Method Summary
 void addContexts(Map session, String mappedView)
          adds a context to the active context list
 Category createCategory()
          Create Category
 Resource createResource()
          create a resource
 void deleteContext(Long contextId)
          delete context by id
 void deleteResource(Long resourceId)
          delete a resource by id
 void deleteSource(Long sourceId)
          delete source by id
 List getActiveContexts(Map session)
          returns a list of all active contexts.
 Context getContext(Long id)
          get context by id
 List getContexts(String mappedView)
          find all contexts associated with mappedView
 String getExternalLocation()
          get static EXTERNAL_LOCATION
 Glossary getGlossary()
          get glossary
 Resource getResource(Long id)
          get a resource by id
 Resource getResourceByDocId(String helpDocIdString)
          get resource by doc id
 Set getResources(Long context)
          get Resources for a context
 Map getResourcesForActiveContexts(Map session)
           
 RestConfiguration getRestConfiguration()
          get REST configuration
 ServerConfigurationService getServerConfigurationService()
          get server config service
 Source getSource(Long id)
          get source
 String getSupportEmailAddress()
          get support email address
 TableOfContents getTableOfContents()
          get table of contents of manager
 String getWelcomePage()
          get Welcome Page
 void initialize()
          Synchronize initialization of the manager.
 void reInitialize()
          reInitialization of the help tool.
 GlossaryEntry searchGlossary(String keyword)
          searches the glossary for the keyword.
 Set searchResources(String query)
           
 void setServerConfigurationService(ServerConfigurationService s)
          set server config service
 void setTableOfContents(TableOfContents toc)
          set table of contents
 void storeCategory(Category category)
          Store Category
 void storeContext(Context context)
          store context
 void storeResource(Resource resource)
          persist a resource
 void storeSource(Source source)
          store source
 

Method Detail

initialize

public void initialize()
Synchronize initialization of the manager.


reInitialize

public void reInitialize()
reInitialization of the help tool.


createCategory

public Category createCategory()
Create Category

Returns:
Category

storeCategory

public void storeCategory(Category category)
Store Category

Parameters:
category -

getContexts

public List getContexts(String mappedView)
find all contexts associated with mappedView

Parameters:
mappedView -
Returns:
- list of contexts (String)

getActiveContexts

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

Parameters:
session -
Returns:

addContexts

public void addContexts(Map session,
                        String mappedView)
adds a context to the active context list

Parameters:
session -
mappedView -

getResources

public Set getResources(Long context)
get Resources for a context

Parameters:
context -
Returns:
set of resources associated with the supplied context

getResource

public Resource getResource(Long id)
get a resource by id

Parameters:
id -
Returns:

createResource

public Resource createResource()
create a resource

Returns:
Resource

storeResource

public void storeResource(Resource resource)
persist a resource

Parameters:
resource -

deleteResource

public void deleteResource(Long resourceId)
delete a resource by id

Parameters:
resourceId -

getSource

public Source getSource(Long id)
get source

Parameters:
id -
Returns:
Source

storeSource

public void storeSource(Source source)
store source

Parameters:
source -

deleteSource

public void deleteSource(Long sourceId)
delete source by id

Parameters:
sourceId -

getContext

public Context getContext(Long id)
get context by id

Parameters:
id -
Returns:
Context

storeContext

public void storeContext(Context context)
store context

Parameters:
context -

deleteContext

public void deleteContext(Long contextId)
delete context by id

Parameters:
contextId -

getResourcesForActiveContexts

public Map getResourcesForActiveContexts(Map session)
Parameters:
session -
Returns:
map of resources keyed by active contexts

searchResources

public Set searchResources(String query)
                    throws RuntimeException
Parameters:
query -
Returns:
set of resources found by searching with the supplied query.
Throws:
RuntimeException - - if query can't be parsed

getTableOfContents

public TableOfContents getTableOfContents()
get table of contents of manager

Returns:
TableOfContents

setTableOfContents

public void setTableOfContents(TableOfContents toc)
set table of contents

Parameters:
toc -

searchGlossary

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

Parameters:
keyword -
Returns:

getGlossary

public Glossary getGlossary()
get glossary

Returns:
Glossary

getResourceByDocId

public Resource getResourceByDocId(String helpDocIdString)
get resource by doc id

Parameters:
helpDocIdString -
Returns:
Resource

getSupportEmailAddress

public String getSupportEmailAddress()
get support email address

Returns:
address as string

getRestConfiguration

public RestConfiguration getRestConfiguration()
get REST configuration

Returns:
REST configuration

getExternalLocation

public String getExternalLocation()
get static EXTERNAL_LOCATION

Returns:
EXTERNAL_LOCATION

getServerConfigurationService

public ServerConfigurationService getServerConfigurationService()
get server config service

Returns:

setServerConfigurationService

public void setServerConfigurationService(ServerConfigurationService s)
set server config service

Parameters:
s -

getWelcomePage

public String getWelcomePage()
get Welcome Page

Returns:
docId of Welcome Page