eu.dnetlib.clients.functionality.rating.ws

Interface RatingWebService

All Superinterfaces:

eu.dnetlib.common.rmi.BaseService, eu.dnetlib.api.DriverServiceEndpoint<eu.dnetlib.api.functionality.RatingService>, DriverWebService<eu.dnetlib.api.functionality.RatingService>

All Known Implementing Classes:

RatingWebServiceImpl

public interface RatingWebService
extends DriverWebService<eu.dnetlib.api.functionality.RatingService>

This interface describes the available methods of a rating web service.

Author:

thanos@di.uoa.gr

Method Summary

Modifier and Type	Method and Description
List<eu.dnetlib.domain.functionality.Rating>	getTopDocuments(int limit) Get the top documents.
List<eu.dnetlib.domain.functionality.Rating>	getTopRatings(int limit) Get the top ratings.
void	rate(String userId, String documentId, float score) Rate a document by a specifed user.
List<eu.dnetlib.domain.functionality.Rating>	searchRatingsByDocument(String documentId) Search for existing ratings by document.
List<eu.dnetlib.domain.functionality.Rating>	searchRatingsByUser(String userId) Search for existing ratings by user.

Methods inherited from interface eu.dnetlib.common.rmi.BaseService

identify, notify, start

Method Detail

rate

void rate(String userId,
          String documentId,
          float score)
   throws RatingWebServiceException

Rate a document by a specifed user.

Parameters:

userId - the id of the user

documentId - the id of the document

score - the rating score

Throws:

RatingWebServiceException - if any errors occur

searchRatingsByUser

List<eu.dnetlib.domain.functionality.Rating> searchRatingsByUser(String userId)
                                                          throws RatingWebServiceException

Search for existing ratings by user.

Parameters:

userId - the id of the user

Returns:

a list containing all the ratings of the specified user ordered by score

Throws:

RatingWebServiceException - if any errors occur

searchRatingsByDocument

List<eu.dnetlib.domain.functionality.Rating> searchRatingsByDocument(String documentId)
                                                              throws RatingWebServiceException

Search for existing ratings by document.

Parameters:

documentId - the id of the document

Returns:

a list containing all the ratings of the soecified document ordered by score

Throws:

RatingWebServiceException - if any errors occur

getTopRatings

List<eu.dnetlib.domain.functionality.Rating> getTopRatings(int limit)
                                                    throws RatingWebServiceException

Get the top ratings.

Parameters:

limit - the maximum number of ratings to retrieve

Returns:

a list containing the top ratings ordered by score

Throws:

RatingWebServiceException - if any errors occur

getTopDocuments

List<eu.dnetlib.domain.functionality.Rating> getTopDocuments(int limit)
                                                      throws RatingWebServiceException

Get the top documents.

Parameters:

limit - the maximum number of ratings to retrieve

Returns:

a list containing the top document average ratings ordered by score

Throws:

RatingWebServiceException - if any errors occur