org.apache.sling.sample.slingshot.ratings

Interface RatingsService

public interface RatingsService

Service for handling the ratings

Method Summary

Modifier and Type	Method and Description
double	getRating(Resource resource) Get the overall rating for a resource.
double	getRating(Resource resource, String userId) Get the rating of a user for a resource.
String	getRatingsResourcePath(Resource resource) Return the path to the ratings resource for a resource.
void	setRating(Resource resource, String userId, double rating) Set the rating of a user for a resource.

Method Detail

getRatingsResourcePath

String getRatingsResourcePath(Resource resource)

Return the path to the ratings resource for a resource.

Parameters:

resource - The content resource, this is usually an entry.

Returns:

The path to the ratings resource or null if the passed in content resource is not part of Slingshot.

getRating

double getRating(Resource resource)

Get the overall rating for a resource.

Parameters:

resource - The content resource, this is usually an entry.

Returns:

The rating or 0 if the passed in content resource is not part of Slingshot.

getRating

double getRating(Resource resource,
                 String userId)

Get the rating of a user for a resource.

Parameters:

resource - The content resource, this is usually an entry.

userId - The user id

Returns:

The rating or 0 if the passed in content resource is not part of Slingshot.

setRating

void setRating(Resource resource,
               String userId,
               double rating)
        throws PersistenceException

Set the rating of a user for a resource.

Parameters:

resource - The content resource, this is usually an entry.

userId - The user id

Throws:

PersistenceException