C D E F G H I O R S T

C

Category - Interface in org.sakaiproject.api.app.help

Category container.

comparator(ServerConfigurationService) - Static method in interface org.sakaiproject.api.app.help.Category

Get Comparator for sorting Categories.

Context - Interface in org.sakaiproject.api.app.help

Context name.

createResource() - Method in interface org.sakaiproject.api.app.help.HelpManager

create a resource

D

deleteResource(Long) - Method in interface org.sakaiproject.api.app.help.HelpManager

delete a resource by id

E

ENTTITY_PREFIX - Static variable in interface org.sakaiproject.api.app.help.TutorialEntityProvider

F

find(String) - Method in interface org.sakaiproject.api.app.help.Glossary

find the keyword in the glossary.

findAll() - Method in interface org.sakaiproject.api.app.help.Glossary

returns the list of all GlossaryEntries

G

getAttributes() - Method in interface org.sakaiproject.api.app.help.Source

get attributes

getCacheInterval() - Method in interface org.sakaiproject.api.app.help.RestConfiguration

get cache interval

getCategories() - Method in interface org.sakaiproject.api.app.help.Category

get categories

getCategories() - Method in interface org.sakaiproject.api.app.help.TableOfContents

get categories

getCorpusDocument() - Method in interface org.sakaiproject.api.app.help.RestConfiguration

get corpus document (xml containing all available docs in domain)

getDefaultForTool() - Method in interface org.sakaiproject.api.app.help.Resource

determine if this document is the default for a tool

getDescription() - Method in interface org.sakaiproject.api.app.help.GlossaryEntry

get description

getDocId() - Method in interface org.sakaiproject.api.app.help.Resource

get the doc id for the resource

getExternalLocation() - Method in interface org.sakaiproject.api.app.help.HelpManager

get static EXTERNAL_LOCATION

getFormattedScore() - Method in interface org.sakaiproject.api.app.help.Resource

get the formatted score for this resource

getId() - Method in interface org.sakaiproject.api.app.help.Category

get id

getLocation() - Method in interface org.sakaiproject.api.app.help.Resource

get the location of this resource

getName() - Method in interface org.sakaiproject.api.app.help.Category

get name

getName() - Method in interface org.sakaiproject.api.app.help.Context

get name

getName() - Method in interface org.sakaiproject.api.app.help.Resource

get the name of this resource

getName() - Method in interface org.sakaiproject.api.app.help.Source

get name

getName() - Method in interface org.sakaiproject.api.app.help.TableOfContents

get name

getOrganization() - Method in interface org.sakaiproject.api.app.help.RestConfiguration

get organization

getParent() - Method in interface org.sakaiproject.api.app.help.Category

get parent category

getResource(Long) - Method in interface org.sakaiproject.api.app.help.HelpManager

get a resource by id

getResourceByDocId(String) - Method in interface org.sakaiproject.api.app.help.HelpManager

get resource by doc id

getResourceNameFromCorpusDoc(String) - Method in interface org.sakaiproject.api.app.help.RestConfiguration

upon initialization of the help tool this method will get the resource name out of the xml

getResources() - Method in interface org.sakaiproject.api.app.help.Category

get resources

getRestConfiguration() - Method in interface org.sakaiproject.api.app.help.HelpManager

get REST configuration

getRestCorpusUrl() - Method in interface org.sakaiproject.api.app.help.RestConfiguration

gets the REST URL for corpus xml document

getRestCredentials() - Method in interface org.sakaiproject.api.app.help.RestConfiguration

get REST credentials

getRestDomain() - Method in interface org.sakaiproject.api.app.help.RestConfiguration

get REST domain

getRestUrl() - Method in interface org.sakaiproject.api.app.help.RestConfiguration

get REST URL

getRestUrlInDomain() - Method in interface org.sakaiproject.api.app.help.RestConfiguration

get REST URL with domain

getScore() - Method in interface org.sakaiproject.api.app.help.Resource

get the score for this resource

getSource() - Method in interface org.sakaiproject.api.app.help.Resource

get the source of this resource

getSupportEmailAddress() - Method in interface org.sakaiproject.api.app.help.HelpManager

get support email address

getTableOfContents() - Method in interface org.sakaiproject.api.app.help.HelpManager

get table of contents of manager

getTerm() - Method in interface org.sakaiproject.api.app.help.GlossaryEntry

get term

getTstamp() - Method in interface org.sakaiproject.api.app.help.Resource

get the time stamp of this resource

getUrl() - Method in interface org.sakaiproject.api.app.help.Glossary

url to glossary web page

getUrlAppenders() - Method in interface org.sakaiproject.api.app.help.Source

get url appenders

getWelcomePage() - Method in interface org.sakaiproject.api.app.help.HelpManager

get Welcome Page

getWelcomePage() - Method in interface org.sakaiproject.api.app.help.Resource

determine if this document welcome page for the help tool

Glossary - Interface in org.sakaiproject.api.app.help

GlossaryEntry - Interface in org.sakaiproject.api.app.help

Glossary Entry.

H

HELP_DOC_REGEXP - Static variable in interface org.sakaiproject.api.app.help.HelpManager

HelpManager - Interface in org.sakaiproject.api.app.help

Help Manager for the Sakai Help Tool.

I

initialize() - Method in interface org.sakaiproject.api.app.help.HelpManager

Synchronize initialization of the manager.

O

org.sakaiproject.api.app.help - package org.sakaiproject.api.app.help

R

reInitialize() - Method in interface org.sakaiproject.api.app.help.HelpManager

reInitialization of the help tool.

Resource - Interface in org.sakaiproject.api.app.help

Resource in the help system

RestConfiguration - Interface in org.sakaiproject.api.app.help

S

searchResources(String) - Method in interface org.sakaiproject.api.app.help.HelpManager

setAttributes(Map) - Method in interface org.sakaiproject.api.app.help.Source

set attributes

setCacheInterval(long) - Method in interface org.sakaiproject.api.app.help.RestConfiguration

set cache interval

setCategories(Set<Category>) - Method in interface org.sakaiproject.api.app.help.Category

set categories

setCategories(Set<Category>) - Method in interface org.sakaiproject.api.app.help.TableOfContents

set categories

setCategory(Category) - Method in interface org.sakaiproject.api.app.help.Resource

get the category for this resource

setDefaultForTool(String) - Method in interface org.sakaiproject.api.app.help.Resource

set whether this resource is the default for a tool

setDescription(String) - Method in interface org.sakaiproject.api.app.help.GlossaryEntry

set description

setDocId(String) - Method in interface org.sakaiproject.api.app.help.Resource

set the doc id for the resource

setId(Long) - Method in interface org.sakaiproject.api.app.help.Category

set id

setLocation(String) - Method in interface org.sakaiproject.api.app.help.Resource

set the location of this resource

setName(String) - Method in interface org.sakaiproject.api.app.help.Category

set name

setName(String) - Method in interface org.sakaiproject.api.app.help.Context

set name

setName(String) - Method in interface org.sakaiproject.api.app.help.Resource

set the name of this resource

setName(String) - Method in interface org.sakaiproject.api.app.help.Source

set name

setName(String) - Method in interface org.sakaiproject.api.app.help.TableOfContents

set name

setOrganization(String) - Method in interface org.sakaiproject.api.app.help.RestConfiguration

set organization

setParent(Category) - Method in interface org.sakaiproject.api.app.help.Category

set parent category

setResources(Set<Resource>) - Method in interface org.sakaiproject.api.app.help.Category

set resources

setRestCredentials(String) - Method in interface org.sakaiproject.api.app.help.RestConfiguration

set REST credentials

setRestDomain(String) - Method in interface org.sakaiproject.api.app.help.RestConfiguration

set REST domain

setRestUrl(String) - Method in interface org.sakaiproject.api.app.help.RestConfiguration

set REST URL

setScore(float) - Method in interface org.sakaiproject.api.app.help.Resource

set the score for this resource

setSource(String) - Method in interface org.sakaiproject.api.app.help.Resource

set the source of this resource

setTableOfContents(TableOfContents) - Method in interface org.sakaiproject.api.app.help.HelpManager

set table of contents

setTerm(String) - Method in interface org.sakaiproject.api.app.help.GlossaryEntry

set term

setTstamp(Long) - Method in interface org.sakaiproject.api.app.help.Resource

set the time stamp of this resource

setUrlAppenders(Set) - Method in interface org.sakaiproject.api.app.help.Source

set url appenders

setWelcomePage(String) - Method in interface org.sakaiproject.api.app.help.Resource

set whether this resource is the welcome page for the tool

Source - Interface in org.sakaiproject.api.app.help

storeResource(Resource) - Method in interface org.sakaiproject.api.app.help.HelpManager

persist a resource

T

TableOfContents - Interface in org.sakaiproject.api.app.help

Table of Contents

TOOLCONFIG_HELP_COLLECTIONS - Static variable in interface org.sakaiproject.api.app.help.HelpManager

TutorialEntityProvider - Interface in org.sakaiproject.api.app.help

C D E F G H I O R S T