mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-08 14:51:49 +00:00
6afb44e712
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
96 lines
3.3 KiB
Java
96 lines
3.3 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.List;
|
|
|
|
import org.alfresco.api.AlfrescoPublicApi;
|
|
import org.alfresco.repo.rating.AbstractRatingRollupAlgorithm;
|
|
import org.alfresco.repo.rating.RatingNamingConventionsUtil;
|
|
import org.alfresco.repo.rating.RatingSchemeRegistry;
|
|
|
|
/**
|
|
* This interface defines a Rating Scheme, which is a named scheme for user-supplied
|
|
* ratings with a defined minimum value and a defined maximum value. The minimum must
|
|
* not be greater than the maximum but the two values can be equal.
|
|
* These schemes are defined within spring context files and injected into the
|
|
* {@link RatingSchemeRegistry} at startup.
|
|
*
|
|
* @author Neil McErlean
|
|
* @since 3.4
|
|
*/
|
|
@AlfrescoPublicApi
|
|
public interface RatingScheme extends Comparable<RatingScheme>
|
|
{
|
|
/**
|
|
* This method returns the name which uniquely identifies the rating scheme.
|
|
*
|
|
* @return the name.
|
|
*/
|
|
public String getName();
|
|
|
|
/**
|
|
* This method returns the minimum rating defined for this scheme.
|
|
*
|
|
* @return the minimum rating.
|
|
*/
|
|
public float getMinRating();
|
|
|
|
/**
|
|
* This method returns the maximum rating defined for this scheme.
|
|
*
|
|
* @return the maximum rating.
|
|
*/
|
|
public float getMaxRating();
|
|
|
|
/**
|
|
* This method returns the namespace (prefix e.g. "cm") of the Alfresco content model
|
|
* containing the definitions of the rollup aspect and properties.
|
|
* @since 4.1.5
|
|
* @see RatingNamingConventionsUtil
|
|
*/
|
|
public String getModelPrefix();
|
|
|
|
/**
|
|
* This method returns <code>true</code> if the cm:creator of the node is allowed
|
|
* to apply a rating to it, else <code>false</code>.
|
|
*
|
|
* @return whether or not the cm:creator of the node can apply a rating in this scheme.
|
|
*/
|
|
public boolean isSelfRatingAllowed();
|
|
|
|
/**
|
|
* This method returns a List of {@link AbstractRatingRollupAlgorithm property rollup algorithms}
|
|
* which are used in order to calculate rating totals, counts etc for a rated node.
|
|
*
|
|
* @return an unmodifiable list of property rollup algorithms.
|
|
* @since 3.5
|
|
*/
|
|
public List<AbstractRatingRollupAlgorithm> getPropertyRollups();
|
|
|
|
}
|