com.gravityrd.receng.web.webshop.jsondto

Class GravityItem

java.lang.Object

com.gravityrd.receng.web.webshop.jsondto.GravityItem

public class GravityItem
extends java.lang.Object

An item is something that can be recommended to users.

Field Summary

Fields

Modifier and Type	Field and Description
int	fromDate An item is never recommended before this date.
java.lang.Boolean	hidden A hidden item will be never recommended.
java.lang.String	itemId The itemId is an external identifier of the item.
java.lang.String	itemType The type of the item.
GravityNameValue[]	nameValues The NameValues for the item.
java.lang.String	title Title is a short, human-readable name of the item.
int	toDate An item is never recommended after this date.

Constructor Summary

Constructors

Constructor and Description
GravityItem()

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

itemId

public java.lang.String itemId

The itemId is an external identifier of the item.

title

public java.lang.String title

Title is a short, human-readable name of the item. If the title is available in multiple languages, try to use your system's primary language, for example English.

itemType

public java.lang.String itemType

The type of the item. It can be used to create different item families. The purpose of itemtype is to differentiate items which will have different namevalue properties. Examples:

• Book
• Ticket
• Computer
• Food

hidden

public java.lang.Boolean hidden

A hidden item will be never recommended. The default value is false.

fromDate

public int fromDate

An item is never recommended before this date. The date is in the UNIX time format the number of seconds elapsed since 1970.01.01 00:00:00 UTC. Leave it empty if not important.

toDate

public int toDate

An item is never recommended after this date. The date is in the UNIX time format the number of seconds elapsed since 1970.01.01 00:00:00 UTC. Leave it empty if not important.

nameValues

public GravityNameValue[] nameValues

The NameValues for the item.

NameValues provide additional description of the item.

There can multiple NameValues with the same name.

The order of NameValues among different names will not be preserved, but the order of the values for the same name will be preserved.

The recommendation engine can be configured to use some properties to create a relation between items.

A possible list of names:

Name	Localizable	Description
Title	Yes	The title of the item.
Description	Yes	The description of item.
CategoryPath	No	The full path of the item's category. For example, CategoryPath might be "books/computers/databases" for a book about databases. CategoryPath can be repeated if an item belongs to multiple categories. Use "/" only for separating levels. Later it is possible to use the recommendation engine to filter the list of items based on category, so it can provide recommendations for "Computer Books" category or only for "Computer Books > Database" category.
Tags	No	Tags for the item. Specify a separate namevalue for each tag.
State	No	The state of the item, for example 'available', 'out of stock' etc.
Price	No	The price of the item.

The recommendation engine can accept arbitrary namevalues, the list above is just an example of basic properties that are used almost everywhere. The NameValues which are relevant to business rules and possible content based filtering should be provided to the recommendation engine.

You can use localization by appending a language identifier to the Name of the NameValue. For example, Title_EN, Title_HU. It is possible to use both non-localized and localized version.

Constructor Detail

GravityItem

public GravityItem()

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object