com.adobe.cq.commerce.common

Class DefaultJcrCartEntry

java.lang.Object

com.adobe.cq.commerce.common.DefaultJcrCartEntry

All Implemented Interfaces:

CommerceSession.CartEntry

public class DefaultJcrCartEntry
extends java.lang.Object
implements CommerceSession.CartEntry

The default implementation for a CommerceSession.CartEntry used by AbstractJcrCommerceSession. Implementations requiring customization should extend this class and override AbstractJcrCommerceService.newCartEntryImpl(int, com.adobe.cq.commerce.api.Product, int) to return said extension.

Constructor Summary

Constructors

Constructor and Description
DefaultJcrCartEntry(int index, Product product, int quantity)

Method Summary

Modifier and Type	Method and Description
int	getEntryIndex()
java.lang.String	getPreTaxPrice() Deprecated.
java.lang.String	getPrice(Predicate filter) Shortcut for getting a formatted string of the first matching price.
java.util.List<PriceInfo>	getPriceInfo(Predicate filter) Get a list of detailed price info objects for a cart entry filtered by the provided predicate (usually a PriceFilter).
Product	getProduct()
ValueMap	getProperties() Returns the properties of this cart entry or an empty map if there are no properties.
<T> T	getProperty(java.lang.String name, java.lang.Class<T> type) Get a cart entry property with the given type.
int	getQuantity()
java.lang.String	getTax() Deprecated.
java.lang.String	getTotalPrice() Deprecated.
java.lang.String	getUnitPrice() Deprecated.
void	setEntryIndex(int index)
void	setPrice(PriceInfo priceInfo, java.lang.String... types) A helper routine which updates the cart entry prices with a new PriceInfo.
void	setQuantity(int quantity)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultJcrCartEntry

public DefaultJcrCartEntry(int index,
                           Product product,
                           int quantity)

Method Detail

getEntryIndex

public int getEntryIndex()

Specified by:

getEntryIndex in interface CommerceSession.CartEntry

Returns:

the (0-based) index of the entry in the cart

setEntryIndex

public void setEntryIndex(int index)

getProduct

public Product getProduct()
                   throws CommerceException

Specified by:

getProduct in interface CommerceSession.CartEntry

Returns:

the Product for this entry

Throws:

CommerceException

getQuantity

public int getQuantity()

Specified by:

getQuantity in interface CommerceSession.CartEntry

Returns:

the quantity

setQuantity

public void setQuantity(int quantity)

getPriceInfo

public java.util.List<PriceInfo> getPriceInfo(Predicate filter)
                                       throws CommerceException

Description copied from interface: CommerceSession.CartEntry

Get a list of detailed price info objects for a cart entry filtered by the provided predicate (usually a PriceFilter).

Current components expect price infos with (at least) the following classifiers, in this order:

1. "LINE" (line subtotal, generally without tax)
2. "UNIT" (unit price, generally without tax)

Example: to get the unit price of a cart entry, you could use the following statement:

 
 cartEntry.getPriceInfo(new PriceFilter("UNIT"));
 
 

Specified by:

getPriceInfo in interface CommerceSession.CartEntry

Parameters:

filter - An optional predicate used for filtering the PriceInfos. Pass null to fetch all PriceInfos.

Returns:

a list of prices, can be empty if no price matches.

Throws:

CommerceException

See Also:

PriceFilter

getPrice

public java.lang.String getPrice(Predicate filter)
                          throws CommerceException

Description copied from interface: CommerceSession.CartEntry

Shortcut for getting a formatted string of the first matching price.

Specified by:

getPrice in interface CommerceSession.CartEntry

Parameters:

filter - An optional predicate used for filtering the PriceInfos.

Returns:

Formatted price string of first matching price

Throws:

CommerceException

See Also:

CommerceSession.CartEntry.getPriceInfo(Predicate)

setPrice

public void setPrice(PriceInfo priceInfo,
                     java.lang.String... types)

A helper routine which updates the cart entry prices with a new PriceInfo. If all the priceInfo's types match an existing entry, the entry will be updated.

Note: automatically add the priceInfo's currencyCode as an additional tag to ease filtering on currency.

Parameters:

priceInfo - A PriceInfo containing the amount and currency.

types - Classifiers indicating the usage of the PriceInfo (ie: "UNIT", "PRE_TAX").

getProperty

public <T> T getProperty(java.lang.String name,
                         java.lang.Class<T> type)

Description copied from interface: CommerceSession.CartEntry

Get a cart entry property with the given type.

Specified by:

getProperty in interface CommerceSession.CartEntry

Parameters:

name - The property's name

type - The property's type

Returns:

The property or null if it doesn't exist or can not be converted to the given type.

getProperties

public ValueMap getProperties()

Returns the properties of this cart entry or an empty map if there are no properties.

getUnitPrice

@Deprecated
public java.lang.String getUnitPrice()

Deprecated.

Specified by:

getUnitPrice in interface CommerceSession.CartEntry

Returns:

a formatted unit price

getPreTaxPrice

@Deprecated
public java.lang.String getPreTaxPrice()

Deprecated.

Specified by:

getPreTaxPrice in interface CommerceSession.CartEntry

Returns:

a formatted pre-tax price

getTax

@Deprecated
public java.lang.String getTax()

Deprecated.

Specified by:

getTax in interface CommerceSession.CartEntry

Returns:

a formatted tax value

getTotalPrice

@Deprecated
public java.lang.String getTotalPrice()

Deprecated.

Specified by:

getTotalPrice in interface CommerceSession.CartEntry

Returns:

a formatted total price