Package org.sakaiproject.api.app.help

Interface HelpManager

public interface HelpManager

Help Manager for the Sakai Help Tool.

Version:

$Id$

Field Summary

Fields

Modifier and Type	Field	Description
static String	HELP_DOC_REGEXP
static String	TOOLCONFIG_HELP_COLLECTIONS

Method Summary

Modifier and Type	Method	Description
Resource	createResource()	create a resource
void	deleteResource(Long resourceId)	delete a resource by id
String	getExternalLocation()	get static EXTERNAL_LOCATION
Resource	getResource(Long id)	get a resource by id
Resource	getResourceByDocId(String helpDocIdString)	get resource by doc id
RestConfiguration	getRestConfiguration()	get REST configuration
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.
Set<Resource>	searchResources(String query)
void	setTableOfContents(TableOfContents toc)	set table of contents
void	storeResource(Resource resource)	persist a resource

Field Detail

TOOLCONFIG_HELP_COLLECTIONS

static final String TOOLCONFIG_HELP_COLLECTIONS

See Also:

Constant Field Values

HELP_DOC_REGEXP

static final String HELP_DOC_REGEXP

See Also:

Constant Field Values

Method Detail

initialize

void initialize()

Synchronize initialization of the manager.

reInitialize

void reInitialize()

reInitialization of the help tool.

getResource

Resource getResource(Long id)

get a resource by id

Parameters:

id -

Returns:

createResource

Resource createResource()

create a resource

Returns:

Resource

storeResource

void storeResource(Resource resource)

persist a resource

Parameters:

resource -

deleteResource

void deleteResource(Long resourceId)

delete a resource by id

Parameters:

resourceId -

searchResources

Set<Resource> 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

TableOfContents getTableOfContents()

get table of contents of manager

Returns:

TableOfContents

setTableOfContents

void setTableOfContents(TableOfContents toc)

set table of contents

Parameters:

toc -

getResourceByDocId

Resource getResourceByDocId(String helpDocIdString)

get resource by doc id

Parameters:

helpDocIdString -

Returns:

Resource

getSupportEmailAddress

String getSupportEmailAddress()

get support email address

Returns:

address as string

getRestConfiguration

RestConfiguration getRestConfiguration()

get REST configuration

Returns:

REST configuration

getExternalLocation

String getExternalLocation()

get static EXTERNAL_LOCATION

Returns:

EXTERNAL_LOCATION

getWelcomePage

String getWelcomePage()

get Welcome Page

Returns:

docId of Welcome Page