org.xwiki.extension.repository.rating

Interface Ratable

All Known Subinterfaces:

RatableExtensionRepository

public interface Ratable

A repository can implement it to provide rating capabilities.

Since:

6.4M3

Version:

$Id: 069f5df4e5a3b2eb2f68e9841052fc8a72c5dee5 $

Method Summary

Methods

Modifier and Type	Method and Description
ExtensionRating	getRating(ExtensionId extensionId)
ExtensionRating	getRating(String extensionId, String extensionVersion)
ExtensionRating	getRating(String extensionId, Version extensionVersion)

Method Detail

getRating

ExtensionRating getRating(ExtensionId extensionId)
                          throws ResolveException

Parameters:

extensionId - the extension id

Returns:

the total votes/average vote pair representing an extension's rating

Throws:

ResolveException - error when trying to resolve extension for provided extensionId

getRating

ExtensionRating getRating(String extensionId,
                        Version extensionVersion)
                          throws ResolveException

Parameters:

extensionId - the extension id

extensionVersion - the extension version

Returns:

the total votes/average vote pair representing an extension's rating

Throws:

ResolveException - error when trying to resolve extension for provided extensionId

getRating

ExtensionRating getRating(String extensionId,
                        String extensionVersion)
                          throws ResolveException

Parameters:

extensionId - the extension id

extensionVersion - the extension version

Returns:

the total votes/average vote pair representing an extension's rating

Throws:

ResolveException - error when trying to resolve extension for provided extensionId