Files
alfresco-community-repo/source/java/org/alfresco/service/cmr/rating/Rating.java
Raluca Munteanu 6afb44e712 Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
      125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125788 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2016-04-26 13:45:01 +00:00

93 lines
2.6 KiB
Java

/*
* #%L
* Alfresco Repository
* %%
* Copyright (C) 2005 - 2016 Alfresco Software Limited
* %%
* This file is part of the Alfresco software.
* If the software was purchased under a paid Alfresco license, the terms of
* the paid license agreement will prevail. Otherwise, the software is
* provided under the following open source license terms:
*
* 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/>.
* #L%
*/
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;
}
}