com.yandex.metrica.ecommerce

Class ECommerceCartItem

java.lang.Object

com.yandex.metrica.ecommerce.ECommerceCartItem

public class ECommerceCartItem
extends java.lang.Object

Describes an item in a cart.

Constructor Summary

Constructors

Constructor and Description
ECommerceCartItem(ECommerceProduct product, ECommercePrice revenue, java.math.BigDecimal quantity) Creates CartItem.
ECommerceCartItem(ECommerceProduct product, ECommercePrice revenue, double quantity) Creates CartItem.
ECommerceCartItem(ECommerceProduct product, ECommercePrice revenue, long quantityMicros) Creates CartItem.

Method Summary

Modifier and Type	Method and Description
ECommerceProduct	getProduct()
java.math.BigDecimal	getQuantity()
ECommerceReferrer	getReferrer()
ECommercePrice	getRevenue()
ECommerceCartItem	setReferrer(ECommerceReferrer referrer) Sets cart item referrer which describes a way item was added to cart.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ECommerceCartItem

public ECommerceCartItem(@NonNull
                         ECommerceProduct product,
                         @NonNull
                         ECommercePrice revenue,
                         long quantityMicros)

Creates CartItem.

Parameters:

product - Item product.

revenue - Total price of the cart item. Considers quantity, applied discounts, etc.

quantityMicros - Quantity of item product in micros (actual quantity multiplied by 10^6).

See Also:

ECommerceProduct, ECommercePrice, ECommerceCartItem(ECommerceProduct, ECommercePrice, double), ECommerceCartItem(ECommerceProduct, ECommercePrice, java.math.BigDecimal)

ECommerceCartItem

public ECommerceCartItem(@NonNull
                         ECommerceProduct product,
                         @NonNull
                         ECommercePrice revenue,
                         double quantity)

Creates CartItem.

Parameters:

product - Item product.

revenue - Total price of the cart item. Considers quantity, applied discounts, etc.

quantity - Quantity of item product as double. Double.POSITIVE_INFINITY, Double.NEGATIVE_INFINITY and Double.NaN will be treated as 0.

See Also:

ECommerceProduct, ECommercePrice, ECommerceCartItem(ECommerceProduct, ECommercePrice, long), ECommerceCartItem(ECommerceProduct, ECommercePrice, java.math.BigDecimal)

ECommerceCartItem

public ECommerceCartItem(@NonNull
                         ECommerceProduct product,
                         @NonNull
                         ECommercePrice revenue,
                         @NonNull
                         java.math.BigDecimal quantity)

Creates CartItem.

Parameters:

product - Item product.

revenue - Total price of the cart item. Considers quantity, applied discounts, etc.

quantity - Quantity of item product as BigDecimal.

See Also:

ECommerceProduct, ECommercePrice, ECommerceCartItem(ECommerceProduct, ECommercePrice, long), ECommerceCartItem(ECommerceProduct, ECommercePrice, double)

Method Detail

getProduct

@NonNull
public ECommerceProduct getProduct()

Returns:

item product

See Also:

ECommerceCartItem(ECommerceProduct, ECommercePrice, java.math.BigDecimal), ECommerceCartItem(ECommerceProduct, ECommercePrice, double), ECommerceCartItem(ECommerceProduct, ECommercePrice, long)

getQuantity

@NonNull
public java.math.BigDecimal getQuantity()

Returns:

item product quantity

See Also:

ECommerceCartItem(ECommerceProduct, ECommercePrice, java.math.BigDecimal), ECommerceCartItem(ECommerceProduct, ECommercePrice, double), ECommerceCartItem(ECommerceProduct, ECommercePrice, long)

getRevenue

@NonNull
public ECommercePrice getRevenue()

Returns:

item revenue

See Also:

ECommerceCartItem(ECommerceProduct, ECommercePrice, java.math.BigDecimal), ECommerceCartItem(ECommerceProduct, ECommercePrice, double), ECommerceCartItem(ECommerceProduct, ECommercePrice, long)

setReferrer

@NonNull
public ECommerceCartItem setReferrer(@Nullable
                                              ECommerceReferrer referrer)

Sets cart item referrer which describes a way item was added to cart.

Parameters:

referrer - Referrer.

Returns:

same ECommerceCartItem object

See Also:

ECommerceReferrer

getReferrer

@Nullable
public ECommerceReferrer getReferrer()

Returns:

referrer

See Also:

setReferrer(ECommerceReferrer)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object