org.alfresco.service.cmr.rating
Interface RatingScheme
All Superinterfaces:
-
@org.alfresco.api.AlfrescoPublicApi
public interface RatingScheme
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
org.alfresco.repo.rating.RatingSchemeRegistry at startup.
Since:
-
3.4
Author:
-
Neil McErlean
| Method Summary |
float |
getMaxRating() This method returns the maximum rating defined for this scheme. |
float |
getMinRating() This method returns the minimum rating defined for this scheme. |
|
getModelPrefix() This method returns the namespace (prefix e.g. |
|
getName() This method returns the name which uniquely identifies the rating scheme. |
|
getPropertyRollups() This method returns a List of property rollup algorithms which are used in order to calculate rating totals, counts etc for a rated node. |
boolean |
isSelfRatingAllowed() This method returns true if the cm:creator of the node is allowed to apply a rating to it, else false. |
getName
-
This method returns the name which uniquely identifies the rating scheme.
Returns:
-
the name.
getMinRating
float getMinRating()
-
This method returns the minimum rating defined for this scheme.
Returns:
-
the minimum rating.
getMaxRating
float getMaxRating()
-
This method returns the maximum rating defined for this scheme.
Returns:
-
the maximum rating.
getModelPrefix
-
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 Also:
-
org.alfresco.repo.rating.RatingNamingConventionsUtil
isSelfRatingAllowed
boolean isSelfRatingAllowed()
-
This method returns true if the cm:creator of the node is allowed
to apply a rating to it, else false.
Returns:
-
whether or not the cm:creator of the node can apply a rating in this scheme.
getPropertyRollups
-
This method returns a List of
property rollup algorithms
which are used in order to calculate rating totals, counts etc for a rated node.
Returns:
-
an unmodifiable list of property rollup algorithms.
Since:
-
3.5