org.nuxeo.ecm.rating

Class RatingServiceImpl

java.lang.Object

org.nuxeo.runtime.model.DefaultComponent

org.nuxeo.ecm.rating.RatingServiceImpl

All Implemented Interfaces:

RatingService, Adaptable, Component, Extensible, TimestampedService

public class RatingServiceImpl
extends DefaultComponent
implements RatingService

Default implementation of RatingService.

Since:

5.6

Author:

Thomas Roger

Constructor Summary

Constructors

Constructor and Description
RatingServiceImpl()

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.

Methods inherited from class org.nuxeo.runtime.model.DefaultComponent

activate, applicationStarted, deactivate, getAdapter, getApplicationStartedOrder, getLastModified, registerContribution, registerExtension, setLastModified, unregisterContribution, unregisterExtension

Methods inherited from class java.lang.Object

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

Constructor Detail

RatingServiceImpl

public RatingServiceImpl()

Method Detail

rate

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

Description copied from interface: RatingService

Rates the activityObject by the username.

Specified by:

rate in interface RatingService

rating - the rating

aspect - the rating aspect

cancelRate

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

Description copied from interface: RatingService

Cancels a rate by the username.

Specified by:

cancelRate in interface RatingService

activityObject - the activity object on which cancelling the rate

aspect - the rating aspect

cancelRates

public void cancelRates(String activityObject,
               String aspect)

Description copied from interface: RatingService

Cancels all rates.

Specified by:

cancelRates in interface RatingService

Parameters:

activityObject - the activity object on which cancelling the rate

aspect - the rating aspect may be null.

hasUserRated

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

Description copied from interface: RatingService

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

Specified by:

hasUserRated in interface RatingService

getRatesCount

public long getRatesCount(String activityObject,
                 String aspect)

Description copied from interface: RatingService

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

Specified by:

getRatesCount in interface RatingService

getRatesCount

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

Description copied from interface: RatingService

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

Specified by:

getRatesCount in interface RatingService

getRatesCountForUser

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

Description copied from interface: RatingService

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

Specified by:

getRatesCountForUser in interface RatingService

getRatesCountForUser

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

Description copied from interface: RatingService

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

Specified by:

getRatesCountForUser in interface RatingService

getAverageRating

public double getAverageRating(String activityObject,
                      String aspect)

Description copied from interface: RatingService

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

Specified by:

getAverageRating in interface RatingService

getAverageRatingForUser

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

Description copied from interface: RatingService

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

Specified by:

getAverageRatingForUser in interface RatingService

getRatedChildren

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

Description copied from interface: RatingService

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

Specified by:

getRatedChildren in interface RatingService

Returns:

a List of activityObject

getLastestRatedDocByUser

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

Description copied from interface: RatingService

Get the latest docs activities rated by a specific user

Specified by:

getLastestRatedDocByUser in interface RatingService

Parameters:

username - the desired user

Returns:

a List of activityObject