Merged HEAD-BUG-FIX (5.1/Cloud) to HEAD (5.1/Cloud)

99981: Merged 5.0.N (5.0.2) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE) 99482: Merged DEV to 5.0.N (5.0.1) 99198 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc typo in project alfresco-jlan 99413 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc parameters inconsistence in project alfresco-jlan 99205 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc parameters inconsistence in project core 99415 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc parameters inconsistence in project data-model 99227 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc parameters inconsistence in project file-transfer-receiver 99416 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc parameters inconsistence in project legacy-lucene 99417 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc parameters inconsistence in project qa-share 99418 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc parameters inconsistence in project remote-api 99427 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc in project Repository, letters S..Z 99433 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc in project Repository, letters A..R 99421 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc parameters inconsistence in project share-po 99247 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc typo in project slingshot 99248 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc parameters inconsistence in project slingshot 99424 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc parameters inconsistence in project solr 99426 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc parameters inconsistence in project solr4 99253 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc parameters inconsistence in project solr-client 99259 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc parameters inconsistence in project web-client 99260 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code - Changed Javadoc parameters inconsistence in project web-framework-commons git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@100501 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2025-10-15 15:02:20 +00:00 · 2015-03-27 23:00:01 +00:00
parent 8109be0920
commit a4a7c5f8e7
492 changed files with 4135 additions and 4255 deletions
--- a/source/java/org/alfresco/service/cmr/rating/RatingService.java
+++ b/source/java/org/alfresco/service/cmr/rating/RatingService.java
@@ -34,13 +34,13 @@ import org.alfresco.service.cmr.repository.NodeRef;
 * 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, float, String) applied},
- * {@link RatingService#applyRating(NodeRef, float, String) updated} and
- * {@link RatingService#removeRatingByCurrentUser(NodeRef, RatingScheme) removed}.
- * 
- * @author Neil McErlean
- * @since 3.4
+ * <p/>
+ * Ratings can be {@link RatingService#applyRating(NodeRef, float, String) applied},
+ * {@link RatingService#applyRating(NodeRef, float, String) updated} and
+ * {@link RatingService#removeRatingByCurrentUser(NodeRef, String) removed}.
+ * 
+ * @author Neil McErlean
+ * @since 3.4
 */
 public interface RatingService
 {
@@ -80,13 +80,13 @@ public interface RatingService

    /**
     * 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()
+     * the specified node in the specified {@link RatingScheme}.
+     * 
+     * @param targetNode the node on which the rating is sought.
+     * @param ratingSchemeName the rating scheme name to use.
+     * 
+     * @return the number of individual ratings applied to this node.
+     * @see RatingService#getRatingSchemes()
     * @see RatingScheme
     */
    @NotAuditable
@@ -96,13 +96,13 @@ public interface RatingService
     * This method gets the total accumulated rating score for
     * the specified node in the specified {@link RatingScheme}.
     * That is, the rating scores for all users for the specified
-     * node are summed to give the result.
-     * 
-     * @param targetNode the node on which the rating total is sought.
-     * @param ratingScheme the rating scheme to use.
-     * 
-     * @return the sum of all individual ratings applied to this node in the specified scheme.
-     * @see RatingService#getRatingSchemes()
+     * node are summed to give the result.
+     * 
+     * @param targetNode the node on which the rating total is sought.
+     * @param ratingSchemeName the rating scheme name to use.
+     * 
+     * @return the sum of all individual ratings applied to this node in the specified scheme.
+     * @see RatingService#getRatingSchemes()
     * @see RatingScheme
     */
    @NotAuditable
@@ -120,13 +120,13 @@ public interface RatingService

    /**
     * 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()
+     * {@link RatingScheme} - if there is one.
+     * 
+     * @param targetNode the node on which the rating is sought.
+     * @param ratingSchemeName the rating scheme name to use.
+     * 
+     * @return the Rating object if there is one, else <code>null</code>.
+     * @see RatingService#getRatingSchemes()
     * @see RatingScheme
     */
    @NotAuditable
@@ -148,13 +148,13 @@ public interface RatingService
    
    /**
     * 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()
+     * {@link RatingScheme}.
+     * 
+     * @param targetNode the node from which the rating is to be removed.
+     * @param ratingSchemeName the rating scheme name to use.
+     * 
+     * @return the deleted Rating object if there was one, else <code>null</code>.
+     * @see RatingService#getRatingSchemes()
     * @see RatingScheme
     */
    @NotAuditable