Package com.loop54.model.request

Class GetPopularEntitiesRequest

java.lang.Object

com.loop54.model.request.Request

com.loop54.model.request.GetPopularOrRecentEntitiesRequest

com.loop54.model.request.GetPopularEntitiesRequest

public class GetPopularEntitiesRequest
extends GetPopularOrRecentEntitiesRequest

This class used to perform a request to get entities that a user (or all users) most commonly interacted with or navigated to.

Field Summary

Fields inherited from class com.loop54.model.request.GetPopularOrRecentEntitiesRequest

behaviorType, CURRENT_USER_PLACEHOLDER, entityType, forUserId, resultsOptions

Fields inherited from class com.loop54.model.request.Request

customData

Constructor Summary

Constructors

Constructor	Description
GetPopularEntitiesRequest(String behaviorType)	Retrieve the globally most common products
GetPopularEntitiesRequest(String behaviorType, String forUserId)	Retrieve the globally most common entities for a specfic user
GetPopularEntitiesRequest(String behaviorType, String forUserId, List<String> entityType)

Method Summary

Modifier and Type	Method	Description
static GetPopularEntitiesRequest	forCurrentUser(String behaviorType, List<String> entityType)	Creates a request to get the most popular entities for the current user.

Methods inherited from class com.loop54.model.request.Request

addCustomData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

GetPopularEntitiesRequest

public GetPopularEntitiesRequest(String behaviorType,
 String forUserId,
 List<String> entityType)

Parameters:

behaviorType - interaction or navigation type to include (such as click, purchase or search).

forUserId - a user ID to retrieve the most common/recent entities for that user or null to retrieve the globally most common/recent entities. GetPopularOrRecentEntitiesRequest.CURRENT_USER_PLACEHOLDER can be specified to use the user ID from the User-Id request header.

entityType - entity types to include (such as Product or Query)

GetPopularEntitiesRequest

public GetPopularEntitiesRequest(String behaviorType,
 String forUserId)

Retrieve the globally most common entities for a specfic user

Parameters:

behaviorType - interaction or navigation type to include (such as click, purchase or search).

forUserId - a user ID to retrieve the most common/recent entities for that user or null to retrieve the globally most common/recent entities. GetPopularOrRecentEntitiesRequest.CURRENT_USER_PLACEHOLDER can be specified to use the user ID from the User-Id request header.

GetPopularEntitiesRequest

public GetPopularEntitiesRequest(String behaviorType)

Retrieve the globally most common products

Parameters:

behaviorType - interaction or navigation type to include (such as click, purchase or search).

Method Details

forCurrentUser

public static GetPopularEntitiesRequest forCurrentUser(String behaviorType,
 List<String> entityType)

Creates a request to get the most popular entities for the current user.

Parameters:

behaviorType - interaction or navigation type to include (such as click, purchase, or search).

entityType - entity types to include (such as Product or Query).

Returns:

a new instance of GetPopularEntitiesRequest for the current user.