Developer's Guide - EPiServer World

14 | Developer’s Guide EPiServer Community 3.1
The EPiServer Community tag system allows for each entity class to have their own ID domain. However, it is required
that the combination of entity type and a single integer ID uniquely specifies an instance of the entity class.
For the tag system to be able to recreate the objects there must be an EntityProvider configured for the Type that has
been tagged. Providers are already configured for all relevant EPiServer Community objects.
2.3 Rating
The rating system allows for rating of objects that implements the IRatableEntity interface. A Rating is defined as the
object to rate, the rating value and the rater. Rated entities can then for example be retrieved by the average rate. The
use the Rating system, first import the necessary namespace:
using StarCommunity.Core.Modules;
using StarCommunity.Core.Modules.Security;
using StarCommunity.Core.Modules.Rating;
using StarCommunity.Modules.Blog; //only for this example.
2.3.1 Rating an entity
In this example we use a Blog to rate. However, the similar approach is taken for all ratable entities.
//Get the rating user by id
IUser user =
(IUser)StarCommunitySystem.CurrentContext.DefaultSecurity.GetUser(1234);
//Get the blog to rate by id
Blog b = BlogHandler.GetBlog(1);
//Create a rating object with the rating value 3
IRating rating = new Rating(b, 3, new UserAuthor(user));
//Rate the blog
RatingHandler.Rate(rating);
2.3.2 Examine if a entity is already rated by an user
It may be of interest to see if a ratable entity has already been rated by a specific user. We call the HasRated method in
the RatingHandler. In the example below, the method would return true.
RatingHandler.HasRated(b, new UserAuthor(user));
2.3.3 Retrieving ratings for an entity
There are many different overloads for getting ratings for a specific item. The example below shows how to get all
ratings for Blog b, rated by a specific user
RatingCollection ratingCollection =
b.GetRatings(new UserAuthor(user), 1, 10, out totalItems);
© EPiServer AB