org.olat.core.commons.contextHelp
Class ContextHelpManager

java.lang.Object
  org.olat.core.logging.LogDelegator
      org.olat.core.manager.BasicManager
          org.olat.core.commons.contextHelp.ContextHelpManager

All Implemented Interfaces:

GenericEventListener

public class ContextHelpManager
extends BasicManager
implements GenericEventListener

Description:

This manager offers methods to deal with the context help. This version of the manager stores file in the filesystem because brasato has not yet database stuff in it.

Events thrown by this manager:

• ContextHelpRatingEvent: communicate new user ratings between cluster nodes via CoordinatorManager

Initial Date: 31.10.2008

Author:

Florian Gnaegi, frentix GmbH, http://www.frentix.com

Method Summary

java.lang.String	calculateCombinedKey(java.util.Locale locale, java.lang.String bundleName, java.lang.String page) Method to calculate a key that identifies a help page uniquely
int	countCommunityRatings(java.util.Locale locale, java.lang.String bundleName, java.lang.String page) Deprecated. - use the CommentAndRatingService instead. Still here in case we want to migrate the ratings
void	event(Event event)
float	getCommunityPageRanking(java.util.Locale locale, java.lang.String bundleName, java.lang.String page) Deprecated. - use the CommentAndRatingService instead. Still here in case we want to migrate the ratings
static ContextHelpManager	getInstance() Get an instance of the manager
float	getPersonalPageRanking(UserRequest ureq, java.util.Locale locale, java.lang.String bundleName, java.lang.String page) Deprecated. - use the CommentAndRatingService instead. Still here in case we want to migrate the ratings
void	storePageRating(UserRequest ureq, java.util.Locale locale, java.lang.String bundleName, java.lang.String page, float rating) Deprecated. - use the CommentAndRatingService instead. Still here in case we want to migrate the ratings

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static ContextHelpManager getInstance()

Get an instance of the manager

Returns:

storePageRating

@Deprecated
public void storePageRating(UserRequest ureq,
                                       java.util.Locale locale,
                                       java.lang.String bundleName,
                                       java.lang.String page,
                                       float rating)

Deprecated. - use the CommentAndRatingService instead. Still here in case we want to migrate the ratings

Store the new page rating somewhere

Parameters:

ureq -

locale -

bundleName -

page -

rating -

getCommunityPageRanking

@Deprecated
public float getCommunityPageRanking(java.util.Locale locale,
                                                java.lang.String bundleName,
                                                java.lang.String page)

Deprecated. - use the CommentAndRatingService instead. Still here in case we want to migrate the ratings

Get the ranking of the given page for the average community rating

Parameters:

locale -

bundleName -

page -

Returns:

the average ranking (simple average)

getPersonalPageRanking

@Deprecated
public float getPersonalPageRanking(UserRequest ureq,
                                               java.util.Locale locale,
                                               java.lang.String bundleName,
                                               java.lang.String page)

Deprecated. - use the CommentAndRatingService instead. Still here in case we want to migrate the ratings

Get the ranking of the given page for a single user

Parameters:

ureq -

locale -

bundleName -

page -

Returns:

the average ranking (simple average)

countCommunityRatings

@Deprecated
public int countCommunityRatings(java.util.Locale locale,
                                            java.lang.String bundleName,
                                            java.lang.String page)

Deprecated. - use the CommentAndRatingService instead. Still here in case we want to migrate the ratings

Get the number of ratings that have been made so far

Parameters:

locale -

bundleName -

page -

Returns:

calculateCombinedKey

public java.lang.String calculateCombinedKey(java.util.Locale locale,
                                             java.lang.String bundleName,
                                             java.lang.String page)

Method to calculate a key that identifies a help page uniquely

Parameters:

locale -

bundleName -

page -

Returns:

event

public void event(Event event)

Specified by:

event in interface GenericEventListener

See Also:

GenericEventListener.event(org.olat.core.gui.control.Event)