org.xwiki.ratings.script

Class RatingsScriptService

java.lang.Object

org.xwiki.ratings.script.AbstractScriptRatingsManager

org.xwiki.ratings.script.RatingsScriptService

All Implemented Interfaces:

org.xwiki.component.phase.Initializable, RatingsScriptServiceAPI, org.xwiki.script.service.ScriptService

@Component
 @Singleton
 @Named(value="ratings")
 @Unstable
public class RatingsScriptService
extends AbstractScriptRatingsManager
implements org.xwiki.component.phase.Initializable, org.xwiki.script.service.ScriptService

Script service to manipulate ratings for different ratings hints. This service might be used in two ways: by default it performs calls on the default Ratings Application hint (see RatingsManagerFactory.DEFAULT_APP_HINT), but it can be used with the hint of a custom application e.g. $services.ratings.foo will call the methods for a RatingsManager identified by foo. For more information, see the documentation of RatingsManagerFactory.

Since:

12.9RC1

Version:

$Id: 4e3d5ed114e1b9938fd4cc5ea24f5d2a868ebc63 $

Constructor Summary

Constructors

Constructor and Description
RatingsScriptService()

Method Summary

Modifier and Type	Method and Description
DefaultScriptRatingsManager	get(String managerHint) Retrieve a specific DefaultScriptRatingsManager for the given hint.
void	initialize()

Methods inherited from class org.xwiki.ratings.script.AbstractScriptRatingsManager

getAverageRating, getConfiguration, getCurrentUserRatings, getRating, getRatings, getRatings, isExcludedFromRatings, setRating, setRating

Methods inherited from class java.lang.Object

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

Constructor Detail

RatingsScriptService

public RatingsScriptService()

Method Detail

initialize

public void initialize()
                throws org.xwiki.component.phase.InitializationException

Specified by:

initialize in interface org.xwiki.component.phase.Initializable

Throws:

org.xwiki.component.phase.InitializationException

get

public DefaultScriptRatingsManager get(String managerHint)

Retrieve a specific DefaultScriptRatingsManager for the given hint. This method will in fact instantiate the right RatingsManager for the given hint, and create a DefaultScriptRatingsManager around it to allow performing all script service calls on it. Note that the method also caches the instantiated DefaultScriptRatingsManager in the ExecutionContext so that it's kept during the execution of a script.

Parameters:

managerHint - the hint of a RatingsManager to use. See RatingsManagerFactory for more information.

Returns:

a wrapper around the RatingsManager to perform the script service calls.