RatingService Phase 1.

The RatingService will allow users to apply ratings to content nodes in the repository.
  There will be a number of built-in Rating Schemes and support to add more by the usual extension mechanism.
  Out of the box, we envision a 'likes' scheme (user X likes this document) and a 'star' rating
    (user X gave this document 3 out of 5 stars).

  Content model for ratings.
  Spring config includes two out-of-the-box rating schemes
  Various basic infrastructure classes for Ratings, RatingSchemes and the service itself.
  Basic CRUD for ratings in a Java foundation layer.
  Associated JUnit tests.

The next contribution will add support for per-node average and total ratings and associated tests.


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@21000 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/service/cmr/rating/Rating.java

@@ -0,0 +1,85 @@
+/*
+ * 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.Date;
+
+/**
+ * This struct class holds the essential data of a rating.
+ * 
+ * @author Neil McErlean
+ * @since 3.4
+ */
+public class Rating
+{
+    private final int ratingScore;
+    private final String ratingAppliedBy;
+    private final Date ratingAppliedAt;
+    private final RatingScheme ratingScheme;
+    
+    public Rating(RatingScheme scheme, int score, String appliedBy, Date appliedAt)
+    {
+        this.ratingScheme = scheme;
+        this.ratingScore = score;
+        this.ratingAppliedBy = appliedBy;
+        this.ratingAppliedAt = appliedAt;
+    }
+
+    /**
+     * Gets the score applied as part of this rating. In normal circumstances a score
+     * should always lie within the bounds defined by the {@link RatingScheme}.
+     * 
+     * @return the score.
+     */
+    public int getScore()
+    {
+        return ratingScore;
+    }
+
+    /**
+     * Gets the user name of the user who applied this rating.
+     * 
+     * @return the user who applied the rating.
+     */
+    public String getAppliedBy()
+    {
+        return ratingAppliedBy;
+    }
+
+    /**
+     * Gets the time/date at which the rating was applied.
+     * 
+     * @return the date/time at which the rating was applied.
+     */
+    public Date getAppliedAt()
+    {
+        return ratingAppliedAt;
+    }
+
+    /**
+     * Gets the {@link RatingScheme} under which the rating was applied.
+     * 
+     * @return the rating scheme used for this rating.
+     */
+    public RatingScheme getScheme()
+    {
+        return ratingScheme;
+    }
+}