com.yandex.metrica.ecommerce

Class ECommerceProduct

java.lang.Object

com.yandex.metrica.ecommerce.ECommerceProduct

public class ECommerceProduct
extends java.lang.Object

Describes a product.

Constructor Summary

Constructors
Constructor and Description
`ECommerceProduct(java.lang.String sku)` Creates a product.

Method Summary

All Methods
Instance Methods
Concrete Methods
Modifier and Type	Method and Description
`ECommercePrice`	`getActualPrice()`
`java.util.List<java.lang.String>`	`getCategoriesPath()`
`java.lang.String`	`getName()`
`ECommercePrice`	`getOriginalPrice()`
`java.util.Map<java.lang.String,java.lang.String>`	`getPayload()`
`java.util.List<java.lang.String>`	`getPromocodes()`
`java.lang.String`	`getSku()`
`ECommerceProduct`	`setActualPrice(ECommercePrice actualPrice)` Sets actual price of the product - price after all discounts and promocodes are applied.
`ECommerceProduct`	`setCategoriesPath(java.util.List<java.lang.String> categoriesPath)` Sets product categories path.
`ECommerceProduct`	`setName(java.lang.String name)` Sets product name.
`ECommerceProduct`	`setOriginalPrice(ECommercePrice originalPrice)` Sets original price of the product.
`ECommerceProduct`	`setPayload(java.util.Map<java.lang.String,java.lang.String> payload)` Sets payload.
`ECommerceProduct`	`setPromocodes(java.util.List<java.lang.String> promocodes)` Sets promocodes.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object

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

Constructor Detail

ECommerceProduct

public ECommerceProduct(@NonNull
                        java.lang.String sku)

Creates a product.

Parameters:: sku - product SKU (Stock Keeping Unit).

Method Detail

getSku

@NonNull
public java.lang.String getSku()

Returns:: sku
See Also:: ECommerceProduct(String)

getName

@Nullable
public java.lang.String getName()

Returns:: name
See Also:: setName(String)

setName

@NonNull
public ECommerceProduct setName(@Nullable
                                         java.lang.String name)

Sets product name.

Parameters:: name - Name of the product.
Returns:: same ECommerceProduct object

getCategoriesPath

@Nullable
public java.util.List<java.lang.String> getCategoriesPath()

Returns:: categories path
See Also:: setCategoriesPath(java.util.List)

setCategoriesPath

@NonNull
public ECommerceProduct setCategoriesPath(@Nullable
                                                   java.util.List<java.lang.String> categoriesPath)

Sets product categories path.

Parameters:: categoriesPath - Categories-wise path to the product.
Returns:: same ECommerceProduct object

getPayload

@Nullable
public java.util.Map<java.lang.String,java.lang.String> getPayload()

Returns:: payload
See Also:: setPayload(java.util.Map)

setPayload

@NonNull
public ECommerceProduct setPayload(@Nullable
                                            java.util.Map<java.lang.String,java.lang.String> payload)

Sets payload.

Parameters:: payload - Payload - additional key-value structured data with various content.
Returns:: same ECommerceProduct object

getActualPrice

@Nullable
public ECommercePrice getActualPrice()

Returns:: actual price
See Also:: setActualPrice(ECommercePrice)

setActualPrice

@NonNull
public ECommerceProduct setActualPrice(@Nullable
                                                ECommercePrice actualPrice)

Sets actual price of the product - price after all discounts and promocodes are applied.

Parameters:: actualPrice - Actual price of the product.
Returns:: same ECommerceProduct object
See Also:: ECommercePrice

getOriginalPrice

@Nullable
public ECommercePrice getOriginalPrice()

Returns:: original price
See Also:: setOriginalPrice(ECommercePrice)

setOriginalPrice

@NonNull
public ECommerceProduct setOriginalPrice(@Nullable
                                                  ECommercePrice originalPrice)

Sets original price of the product.

Parameters:: originalPrice - Original price of the product.
Returns:: same ECommerceProduct object
See Also:: ECommercePrice

getPromocodes

@Nullable
public java.util.List<java.lang.String> getPromocodes()

Returns:: promocodes
See Also:: setPromocodes(java.util.List)

setPromocodes

@NonNull
public ECommerceProduct setPromocodes(@Nullable
                                               java.util.List<java.lang.String> promocodes)

Sets promocodes.

Parameters:: promocodes - List of promocodes applied to the product.
Returns:: same ECommerceProduct object

toString

public java.lang.String toString()

Overrides:: toString in class java.lang.Object