com.gravityrd.receng.web.webshop.jsondto

Class GravityRecommendationContext

java.lang.Object

com.gravityrd.receng.web.webshop.jsondto.GravityRecommendationContext

public class GravityRecommendationContext
extends java.lang.Object

The context of recommendation.

Field Summary

Fields

Modifier and Type	Field and Description
java.util.List<FacetRequest<?>>	facets
GravityNameValue[]	nameValues The NameValues for the context.
int	numberLimit The maximum number of items in the result.
int	recommendationTime The time of the recommendation, the time when it will be shown to the end user (seconds in UNIX time).
java.util.HashMap<java.lang.String,java.lang.String[]>	resultNameValueFilters
java.lang.String[]	resultNameValues If not null, specifies which NameValues of the recommended items should be included in the result.
java.lang.String	scenarioId Scenarios are defined by the scenario management API.

Constructor Summary

Constructors

Constructor and Description
GravityRecommendationContext()

Method Summary

Modifier and Type	Method and Description
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

recommendationTime

public int recommendationTime

The time of the recommendation, the time when it will be shown to the end user (seconds in UNIX time). The default value is the current timestamp.

numberLimit

public int numberLimit

The maximum number of items in the result.

scenarioId

public java.lang.String scenarioId

Scenarios are defined by the scenario management API. A scenario describes a way how recommended items will be filtered, ordered.

nameValues

public GravityNameValue[] nameValues

The NameValues for the context. NameValues can describe the parameters for the actual scenario, like current item id, filtering by category etc. Item-to-item recommendation is possible by a specific scenario which parses a NameValue describing the current item, or multiple NameValues if there are multiple actual items. The list of allowed names depends on the actual scenario.

The scenario can also specify that the result is not a list of items, but a list of values of item NameValues.

Name	Description
CurrentItemId	The identifier of the actual item, if the current page is an item page.
ItemOnPage	Identifier of item displayed elsewhere on the page. They will be excluded from recommendation. This namevalue can be used multiple times to provide a list of items.
CartItemId	Identifier of item in the current shopping cart. This can provide additional information to improve the quality of recommendation. This namevalue must be used as many times as many items the shopping cart contains.
CartItemQuantity	The quantity of items in the current shopping cart, in the same order as CartItemId namevalues.
Filter.*	If specified, only items having the specified name and value as metadata will be in the result. For example, the namevalue with name='Filter'.'CategoryId' and value='A' means that only items belonging to category 'A' will be in the result.

The recommendation engine can accept arbitrary namevalues, the list above is just an example of basic properties that are used almost everywhere.

resultNameValues

public java.lang.String[] resultNameValues

If not null, specifies which NameValues of the recommended items should be included in the result. If null, the returned NameValues are determined by the actual scenario.

resultNameValueFilters

public java.util.HashMap<java.lang.String,java.lang.String[]> resultNameValueFilters

facets

public java.util.List<FacetRequest<?>> facets

Constructor Detail

GravityRecommendationContext

public GravityRecommendationContext()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object