Neil McErlean eece9fef5e Rating Service. Allow fractional ratings.
I've changed the ratings 'score' from an integer to a float as fractional ratings seems like a reasonable idea to me.
  This had impact all through the Java layer, the REST layer, the model and the test code.


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@21128 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2010-07-13 13:31:07 +00:00

86 lines
2.4 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.Date;
/**
* This struct class holds the essential data of a rating.
*
* @author Neil McErlean
* @since 3.4
*/
public class Rating
{
private final float ratingScore;
private final String ratingAppliedBy;
private final Date ratingAppliedAt;
private final RatingScheme ratingScheme;
public Rating(RatingScheme scheme, float 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 float 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;
}
}