org.xwiki.ratings

Interface RatingsConfiguration

@Unstable
 @Role
public interface RatingsConfiguration

Configuration of RatingsManager.

Since:

12.9RC1

Version:

$Id: 5a8c69e6f2e94d87754d102c4d15a80400def664 $

Method Summary

Modifier and Type	Method and Description
String	getAverageRatingStorageHint()
Set<org.xwiki.model.reference.EntityReference>	getExcludedReferencesFromRatings() Allow to define a set of references that cannot be rated.
String	getRatingsStorageHint()
int	getScaleUpperBound()
boolean	hasDedicatedCore()
boolean	isAverageStored()
boolean	isEnabled()
boolean	isZeroStored()

Method Detail

isZeroStored

boolean isZeroStored()

Returns:

false if a rating set to 0 shoud lead to the deletion of a previously made vote. true means that all ratings noted to 0 are stored. Note that this option will impact the average rating.

getScaleUpperBound

int getScaleUpperBound()

Returns:

the upper bound of the scale. The lower bound is always 0.

hasDedicatedCore

boolean hasDedicatedCore()

Returns:

true to create - if possible, depending on the storage implementation - a dedicated store. false means that all ratings from any applications will be stored on the same storage.

isAverageStored

boolean isAverageStored()

Returns:

true to store the average rating. false means that the average rating is never stored nor computed.

getRatingsStorageHint

String getRatingsStorageHint()

Returns:

the storage hint to be used for Ratings data (e.g. solr).

getAverageRatingStorageHint

String getAverageRatingStorageHint()

Returns:

the storage hint to be used for Average Ratings data (e.g. solr or xobject)

getExcludedReferencesFromRatings

Set<org.xwiki.model.reference.EntityReference> getExcludedReferencesFromRatings()

Allow to define a set of references that cannot be rated. This list is mainly used in the UI and in the script service. Note that the provided references are actually also excluding their children, so excluding a wiki reference will excludes all elements from this wiki to be rated.

Returns:

the set of references to be excluded from ratings.

isEnabled

boolean isEnabled()

Returns:

true if the ratings is enabled. This configuration is only used to control the UI.