Interface PortletRatingsDefinition
public interface PortletRatingsDefinition
Provides an interface for defining the ratings used by an entity (or
entities) in a portlet.
This information is used to render a user interface with the entities using ratings, grouped by portlet to allow changing the ratings type.
Implementations must be registered in the OSGI Registry with the property "model.class.name" to specify which entity this definition applies to.
- Author:
- Roberto Díaz, Sergio González
-
Method Summary
Modifier and TypeMethodDescriptionReturns the default ratings type of the entity.Returns the ID of the main portlet associated to the entity.
-
Method Details
-
getDefaultRatingsType
RatingsType getDefaultRatingsType()Returns the default ratings type of the entity. This ratings type is used as long as no other ratings type has been set.- Returns:
- the default ratings type of the entity
-
getPortletId
String getPortletId()Returns the ID of the main portlet associated to the entity. This portlet ID is used to group the entity; so if the entity is used by more than one portlet, the ID of the most relevant portlet is returned.- Returns:
- the main portlet ID associated to the entity.
-