mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-07-07 18:25:23 +00:00
5cc26951f4
Users can't rate their own content any more. Added a RunAs(System) so that users can rate content they don't own, which is all they can rate! First stab at adding rating totals, means and counts - to be tidied tomorrow. Miscellaneous improvements & doc'ing. Tests for the above. Refactored existing tests to run as different users (all were running as admin previously). git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@21013 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
128 lines
4.9 KiB
Java
128 lines
4.9 KiB
Java
/*
|
|
* Copyright (C) 2005-2010 Alfresco Software Limited.
|
|
*
|
|
* This file is part of Alfresco
|
|
*
|
|
* Alfresco is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU Lesser General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
package org.alfresco.service.cmr.rating;
|
|
|
|
import java.util.Map;
|
|
|
|
import org.alfresco.service.NotAuditable;
|
|
import org.alfresco.service.PublicService;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
|
|
/**
|
|
* Interface for public and internal rating operations.
|
|
* <p/>
|
|
* The RatingService can be used to manage ratings on any content node in the repository.
|
|
* These ratings are defined by {@link RatingScheme rating schemes}
|
|
* which are injected via spring (see <code>rating-service-context.xml</code>). The rating
|
|
* schemes define a minimum and a maximum score value for that scheme.
|
|
* <p/>
|
|
* Ratings can be {@link RatingService#applyRating(NodeRef, int, String) applied},
|
|
* {@link RatingService#applyRating(NodeRef, int, String) updated} and
|
|
* {@link RatingService#removeRatingByCurrentUser(NodeRef, RatingScheme) removed}.
|
|
*
|
|
* TODO Get average/total
|
|
*
|
|
* @author Neil McErlean
|
|
* @since 3.4
|
|
*/
|
|
@PublicService
|
|
public interface RatingService
|
|
{
|
|
/**
|
|
* Returns the available {@link RatingScheme rating schemes} keyed by name.
|
|
*
|
|
* @return The {@link RatingScheme rating schemes}.
|
|
*/
|
|
@NotAuditable
|
|
Map<String, RatingScheme> getRatingSchemes();
|
|
|
|
/**
|
|
* Returns the named {@link RatingScheme rating scheme} if there is one.
|
|
*
|
|
* @param ratingSchemeName name of the rating scheme.
|
|
* @return The {@link RatingScheme rating schemes} if one of that name is registered,
|
|
* else <code>null</code>.
|
|
*/
|
|
@NotAuditable
|
|
RatingScheme getRatingScheme(String ratingSchemeName);
|
|
|
|
/**
|
|
* This method applies the given rating to the specified target node. If a rating
|
|
* from the current user in the specified scheme already exists, it will be replaced.
|
|
*
|
|
* @param targetNode the node to which the rating is to be applied.
|
|
* @param rating the rating which is to be applied.
|
|
* @param ratingSchemeName the name of the rating scheme to use.
|
|
*
|
|
* @throws RatingServiceException if the rating is not within the range defined by the named scheme
|
|
* or if the named scheme is not registered.
|
|
* @see RatingService#getRatingSchemes()
|
|
* @see RatingScheme
|
|
*/
|
|
@NotAuditable
|
|
void applyRating(NodeRef targetNode, int rating, String ratingSchemeName) throws RatingServiceException;
|
|
|
|
/**
|
|
* This method gets the number of individual ratings which have been applied to
|
|
* the specified node in the specified {@link RatingScheme}.
|
|
*
|
|
* @param targetNode the node on which the rating is sought.
|
|
* @param ratingScheme the rating scheme to use.
|
|
*
|
|
* @return the number of individual ratings applied to this node.
|
|
* @see RatingService#getRatingSchemes()
|
|
* @see RatingScheme
|
|
*/
|
|
@NotAuditable
|
|
int getRatingsCount(NodeRef targetNode, String ratingSchemeName);
|
|
|
|
int getTotalRating(NodeRef targetNode, String ratingSchemeName);
|
|
|
|
float getAverageRating(NodeRef targetNode, String ratingSchemeName);
|
|
|
|
/**
|
|
* This method gets the {@link Rating} applied by the current user to the specified node in the specified
|
|
* {@link RatingScheme} - if there is one.
|
|
*
|
|
* @param targetNode the node on which the rating is sought.
|
|
* @param ratingScheme the rating scheme to use.
|
|
*
|
|
* @return the Rating object if there is one, else <code>null</code>.
|
|
* @see RatingService#getRatingSchemes()
|
|
* @see RatingScheme
|
|
*/
|
|
@NotAuditable
|
|
Rating getRatingByCurrentUser(NodeRef targetNode, String ratingSchemeName);
|
|
|
|
/**
|
|
* This method removes any {@link Rating} applied by the current user to the specified node in the specified
|
|
* {@link RatingScheme}.
|
|
*
|
|
* @param targetNode the node from which the rating is to be removed.
|
|
* @param ratingScheme the rating scheme to use.
|
|
*
|
|
* @return the deleted Rating object if there was one, else <code>null</code>.
|
|
* @see RatingService#getRatingSchemes()
|
|
* @see RatingScheme
|
|
*/
|
|
@NotAuditable
|
|
Rating removeRatingByCurrentUser(NodeRef targetNode, String ratingSchemeName);
|
|
}
|