Package org.apache.unomi.api.services

Interface PersonalizationService

All Known Implementing Classes:

PersonalizationServiceImpl

public interface PersonalizationService

A service to fulfill personalization request.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	PersonalizationService.Filter	A filter definition for content filtering
static class	PersonalizationService.PersonalizationRequest	Personalization request
static class	PersonalizationService.PersonalizedContent	A personalizated content definition.
static class	PersonalizationService.Target	A target for content filtering.

Method Summary

Modifier and Type	Method	Description
String	bestMatch(Profile profile, Session session, PersonalizationService.PersonalizationRequest personalizationRequest)	Get the best match among a list of items, for the specified profile and session
boolean	filter(Profile profile, Session session, PersonalizationService.PersonalizedContent personalizedContent)	Check if an item is visible for the specified profile and session
PersonalizationResult	personalizeList(Profile profile, Session session, PersonalizationService.PersonalizationRequest personalizationRequest)	Get a personalized list, filtered and sorted, based on the profile and session

Method Detail

filter

boolean filter(Profile profile,
               Session session,
               PersonalizationService.PersonalizedContent personalizedContent)

Check if an item is visible for the specified profile and session

Parameters:

profile - The profile

session - The session

personalizedContent - Personalized content, containing a list of filters

Returns:

If the content is visible or not

bestMatch

String bestMatch(Profile profile,
                 Session session,
                 PersonalizationService.PersonalizationRequest personalizationRequest)

Get the best match among a list of items, for the specified profile and session

Parameters:

profile - The profile

session - The session

personalizationRequest - Personalization request, containing the list of variants and the required strategy

Returns:

The id of the best-matching variant

personalizeList

PersonalizationResult personalizeList(Profile profile,
                                      Session session,
                                      PersonalizationService.PersonalizationRequest personalizationRequest)

Get a personalized list, filtered and sorted, based on the profile and session

Parameters:

profile - The profile

session - The session

personalizationRequest - Personalization request, containing the list of variants and the required strategy

Returns:

List of ids, based on user profile