org.nuxeo.ecm.rating.api

Interface RatingService

All Known Implementing Classes:

RatingServiceImpl

public interface RatingService

Service handling rating on activity objects.

The same activity object can handle multiple ratings by using different aspects.

Since:

5.6

Author:

Thomas Roger

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelRate(String username, String activityObject, String aspect) Cancels a rate by the username.
void	cancelRates(String activityObject, String aspect) Cancels all rates.
double	getAverageRating(String activityObject, String aspect) Returns the average rating for the activityObject on the given aspect.
double	getAverageRatingForUser(String username, String activityObject, String aspect) Returns the average rating by username for the activityObject on the given aspect.
ActivitiesList	getLastestRatedDocByUser(String username, String aspect, int limit) Get the latest docs activities rated by a specific user
ActivitiesList	getRatedChildren(String activityObject, int rating, String aspect) Returns the list of their rated children activityObject on the given aspect with rating.
long	getRatesCount(String activityObject, int rating, String aspect) Returns the rates count for the activityObject on the given aspect where the rating is equals to rating.
long	getRatesCount(String activityObject, String aspect) Returns the rates count for the activityObject on the given aspect.
long	getRatesCountForUser(String username, String activityObject, int rating, String aspect) Returns the rates count by username for the activityObject on the given aspect where the rating is equals to rating.
long	getRatesCountForUser(String username, String activityObject, String aspect) Returns the rates count by username for the activityObject on the given aspect.
boolean	hasUserRated(String username, String activityObject, String aspect) Returns true if the username already rated the activityObject on the given aspect , false otherwise.
void	rate(String username, int rating, String activityObject, String aspect) Rates the activityObject by the username.

Method Detail

rate

void rate(String username,
        int rating,
        String activityObject,
        String aspect)

Rates the activityObject by the username.

Parameters:

rating - the rating

aspect - the rating aspect

cancelRate

void cancelRate(String username,
              String activityObject,
              String aspect)

Cancels a rate by the username.

Parameters:

activityObject - the activity object on which cancelling the rate

aspect - the rating aspect

cancelRates

void cancelRates(String activityObject,
               String aspect)

Cancels all rates.

Parameters:

activityObject - the activity object on which cancelling the rate

aspect - the rating aspect may be null.

hasUserRated

boolean hasUserRated(String username,
                   String activityObject,
                   String aspect)

Returns true if the username already rated the activityObject on the given aspect , false otherwise.

getRatesCount

long getRatesCount(String activityObject,
                 String aspect)

Returns the rates count for the activityObject on the given aspect.

getRatesCount

long getRatesCount(String activityObject,
                 int rating,
                 String aspect)

Returns the rates count for the activityObject on the given aspect where the rating is equals to rating.

getRatesCountForUser

long getRatesCountForUser(String username,
                        String activityObject,
                        String aspect)

Returns the rates count by username for the activityObject on the given aspect.

getRatesCountForUser

long getRatesCountForUser(String username,
                        String activityObject,
                        int rating,
                        String aspect)

Returns the rates count by username for the activityObject on the given aspect where the rating is equals to rating.

getAverageRating

double getAverageRating(String activityObject,
                      String aspect)

Returns the average rating for the activityObject on the given aspect.

getAverageRatingForUser

double getAverageRatingForUser(String username,
                             String activityObject,
                             String aspect)

Returns the average rating by username for the activityObject on the given aspect.

getRatedChildren

ActivitiesList getRatedChildren(String activityObject,
                              int rating,
                              String aspect)

Returns the list of their rated children activityObject on the given aspect with rating.

Returns:

a List of activityObject

getLastestRatedDocByUser

ActivitiesList getLastestRatedDocByUser(String username,
                                      String aspect,
                                      int limit)

Get the latest docs activities rated by a specific user

Parameters:

username - the desired user

limit -

Returns:

a List of activityObject