public class HelpManagerImpl
extends org.springframework.orm.hibernate3.support.HibernateDaoSupport
implements org.sakaiproject.api.app.help.HelpManager
Constructor and Description |
---|
HelpManagerImpl() |
Modifier and Type | Method and Description |
---|---|
void |
addContexts(Map session,
String mappedView) |
org.sakaiproject.api.app.help.Category |
createCategory() |
org.sakaiproject.api.app.help.Resource |
createResource() |
void |
deleteContext(Long contextId) |
void |
deleteResource(Long resourceId) |
void |
deleteSource(Long sourceId) |
List |
getActiveContexts(Map session) |
org.sakaiproject.api.app.help.Category |
getCategoryByName(String name)
Find a Category by name
|
org.sakaiproject.api.app.help.Context |
getContext(Long id) |
List |
getContexts(String mappedView) |
int |
getContextSize()
Get ContextSize.
|
protected org.apache.lucene.document.Document |
getDocument(org.sakaiproject.component.app.help.model.ResourceBean resource)
Get Document.
|
String |
getExternalLocation() |
org.sakaiproject.api.app.help.Glossary |
getGlossary() |
org.sakaiproject.api.app.help.Resource |
getResource(Long id) |
org.sakaiproject.api.app.help.Resource |
getResourceByDocId(String docId) |
protected org.sakaiproject.component.app.help.model.ResourceBean |
getResourceFromDocument(org.apache.lucene.document.Document document)
Get Resource From Document.
|
protected Collection<? extends org.sakaiproject.api.app.help.Resource> |
getResources()
Get entire Collection of Resources.
|
Set<org.sakaiproject.api.app.help.Resource> |
getResources(Long contextId)
return list of resources matching context id
|
Map |
getResourcesForActiveContexts(Map session) |
org.sakaiproject.api.app.help.RestConfiguration |
getRestConfiguration() |
org.sakaiproject.component.api.ServerConfigurationService |
getServerConfigurationService() |
org.sakaiproject.api.app.help.Source |
getSource(Long id) |
String |
getSupportEmailAddress()
Get Support Email Address.
|
org.sakaiproject.api.app.help.TableOfContents |
getTableOfContents() |
org.sakaiproject.component.app.help.model.TableOfContentsBean |
getToc()
Get Table Of Contents Bean.
|
org.sakaiproject.tool.api.ToolManager |
getToolManager()
get tool manager
|
String |
getWelcomePage() |
void |
initialize()
Synchronize first access to tool.
|
void |
recursiveExternalReg(Node n,
org.sakaiproject.api.app.help.Category category,
Set<org.sakaiproject.api.app.help.Category> categories)
Parse external help reg doc recursively
|
void |
registerCorpusDocs(Document doc)
Parse corpus document
|
void |
registerExternalHelpContent(String helpFile)
register external help content
build document from external reg file
|
void |
registerStaticContent()
register local content
|
void |
reInitialize()
Reinitialize help content from UI
|
org.sakaiproject.api.app.help.GlossaryEntry |
searchGlossary(String keyword) |
protected Set<org.sakaiproject.api.app.help.Resource> |
searchResources(org.apache.lucene.search.Query query)
Search Resources
|
Set<org.sakaiproject.api.app.help.Resource> |
searchResources(String queryStr) |
protected Set<org.sakaiproject.api.app.help.Resource> |
searchResources(String queryStr,
String defaultField)
Search Lucene
|
void |
setContextSize(int contextSize)
Set ContextSize
|
void |
setGlossary(org.sakaiproject.api.app.help.Glossary glossary)
Set Glossary.
|
void |
setPreferencesService(org.sakaiproject.user.api.PreferencesService preferencesService) |
void |
setRestConfiguration(org.sakaiproject.api.app.help.RestConfiguration restConfiguration)
set REST configuration
|
void |
setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService s) |
void |
setSupportEmailAddress(String email)
set Support Email Address.
|
void |
setTableOfContents(org.sakaiproject.api.app.help.TableOfContents toc) |
void |
setToc(org.sakaiproject.component.app.help.model.TableOfContentsBean toc)
Set Table Of Contents Bean.
|
void |
setToolManager(org.sakaiproject.tool.api.ToolManager toolManager)
set tool manager
|
void |
setTxManager(org.springframework.orm.hibernate3.HibernateTransactionManager txManager) |
void |
setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService) |
void |
storeCategory(org.sakaiproject.api.app.help.Category category) |
void |
storeContext(org.sakaiproject.api.app.help.Context context) |
void |
storeResource(org.sakaiproject.api.app.help.Resource resource)
Store resource
|
void |
storeSource(org.sakaiproject.api.app.help.Source source) |
public org.sakaiproject.component.api.ServerConfigurationService getServerConfigurationService()
getServerConfigurationService
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.getServerConfigurationService()
public void setServerConfigurationService(org.sakaiproject.component.api.ServerConfigurationService s)
setServerConfigurationService
in interface org.sakaiproject.api.app.help.HelpManager
org.sakaiproject.api.app.help.HelpManager#setServerConfigurationService(org.sakaiproject.service.framework.config.ServerConfigurationService)
public void setPreferencesService(org.sakaiproject.user.api.PreferencesService preferencesService)
public void setUserDirectoryService(org.sakaiproject.user.api.UserDirectoryService userDirectoryService)
public List getContexts(String mappedView)
getContexts
in interface org.sakaiproject.api.app.help.HelpManager
public List getActiveContexts(Map session)
getActiveContexts
in interface org.sakaiproject.api.app.help.HelpManager
public void addContexts(Map session, String mappedView)
addContexts
in interface org.sakaiproject.api.app.help.HelpManager
public Set<org.sakaiproject.api.app.help.Resource> getResources(Long contextId)
getResources
in interface org.sakaiproject.api.app.help.HelpManager
contextId
- public void storeResource(org.sakaiproject.api.app.help.Resource resource)
storeResource
in interface org.sakaiproject.api.app.help.HelpManager
org.sakaiproject.api.app.help.HelpManager#storeResource(org.sakaiproject.api.help.Entity)
public org.sakaiproject.api.app.help.Resource getResource(Long id)
getResource
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.getResource(java.lang.Long)
public void deleteResource(Long resourceId)
deleteResource
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.deleteResource(java.lang.Long)
public org.sakaiproject.api.app.help.Source getSource(Long id)
getSource
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.getSource(java.lang.Long)
public void storeSource(org.sakaiproject.api.app.help.Source source)
storeSource
in interface org.sakaiproject.api.app.help.HelpManager
org.sakaiproject.api.app.help.HelpManager#storeSource(org.sakaiproject.api.help.Source)
public void deleteSource(Long sourceId)
deleteSource
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.deleteSource(java.lang.Long)
public org.sakaiproject.api.app.help.Context getContext(Long id)
getContext
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.getContext(java.lang.Long)
public void storeContext(org.sakaiproject.api.app.help.Context context)
storeContext
in interface org.sakaiproject.api.app.help.HelpManager
org.sakaiproject.api.app.help.HelpManager#storeContext(org.sakaiproject.api.help.Context)
public void deleteContext(Long contextId)
deleteContext
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.deleteContext(java.lang.Long)
public Map getResourcesForActiveContexts(Map session)
getResourcesForActiveContexts
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.getResourcesForActiveContexts(java.util.Map)
public Set<org.sakaiproject.api.app.help.Resource> searchResources(String queryStr)
searchResources
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.searchResources(java.lang.String)
public org.sakaiproject.api.app.help.TableOfContents getTableOfContents()
getTableOfContents
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.getTableOfContents()
public void setTableOfContents(org.sakaiproject.api.app.help.TableOfContents toc)
setTableOfContents
in interface org.sakaiproject.api.app.help.HelpManager
org.sakaiproject.api.app.help.HelpManager#setTableOfContents(org.sakaiproject.api.help.TableOfContents)
public org.sakaiproject.api.app.help.GlossaryEntry searchGlossary(String keyword)
searchGlossary
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.searchGlossary(java.lang.String)
protected Set<org.sakaiproject.api.app.help.Resource> searchResources(org.apache.lucene.search.Query query)
query
- protected Set<org.sakaiproject.api.app.help.Resource> searchResources(String queryStr, String defaultField) throws org.apache.lucene.queryparser.classic.ParseException
queryStr
- defaultField
- org.apache.lucene.queryparser.classic.ParseException
protected org.sakaiproject.component.app.help.model.ResourceBean getResourceFromDocument(org.apache.lucene.document.Document document)
document
- protected Collection<? extends org.sakaiproject.api.app.help.Resource> getResources()
public int getContextSize()
public void setContextSize(int contextSize)
contextSize
- protected org.apache.lucene.document.Document getDocument(org.sakaiproject.component.app.help.model.ResourceBean resource) throws IOException, MalformedURLException
resource
- IOException
MalformedURLException
public org.sakaiproject.component.app.help.model.TableOfContentsBean getToc()
public void setToc(org.sakaiproject.component.app.help.model.TableOfContentsBean toc)
toc
- public org.sakaiproject.api.app.help.Glossary getGlossary()
getGlossary
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.getGlossary()
public void setGlossary(org.sakaiproject.api.app.help.Glossary glossary)
glossary
- public void storeCategory(org.sakaiproject.api.app.help.Category category)
storeCategory
in interface org.sakaiproject.api.app.help.HelpManager
org.sakaiproject.api.app.help.HelpManager#storeCategory(org.sakaiproject.api.help.Category)
public org.sakaiproject.api.app.help.Category createCategory()
createCategory
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.createCategory()
public org.sakaiproject.api.app.help.Resource createResource()
createResource
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.createResource()
public org.sakaiproject.api.app.help.Resource getResourceByDocId(String docId)
getResourceByDocId
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.getResourceByDocId(java.lang.String)
public String getWelcomePage()
getWelcomePage
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.getWelcomePage()
public org.sakaiproject.api.app.help.Category getCategoryByName(String name)
name
- public String getSupportEmailAddress()
getSupportEmailAddress
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.getSupportEmailAddress()
public void setSupportEmailAddress(String email)
email
- public org.sakaiproject.tool.api.ToolManager getToolManager()
public void setToolManager(org.sakaiproject.tool.api.ToolManager toolManager)
toolManager
- The toolManager to set.public void setTxManager(org.springframework.orm.hibernate3.HibernateTransactionManager txManager)
txManager
- The txManager to set.public org.sakaiproject.api.app.help.RestConfiguration getRestConfiguration()
getRestConfiguration
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.getRestConfiguration()
public void setRestConfiguration(org.sakaiproject.api.app.help.RestConfiguration restConfiguration)
restConfiguration
- public void reInitialize()
reInitialize
in interface org.sakaiproject.api.app.help.HelpManager
public void initialize()
initialize
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.initialize()
public String getExternalLocation()
getExternalLocation
in interface org.sakaiproject.api.app.help.HelpManager
HelpManager.getExternalLocation()
public void registerExternalHelpContent(String helpFile)
externalHelpReg
- public void registerStaticContent()
public void recursiveExternalReg(Node n, org.sakaiproject.api.app.help.Category category, Set<org.sakaiproject.api.app.help.Category> categories)
n
- category
- public void registerCorpusDocs(Document doc)
doc
- documentCopyright © 2003-2016 Sakai Foundation. All Rights Reserved.