com.adobe.cq.commerce.api

Interface CommerceSession.CartEntry

All Known Implementing Classes:

DefaultJcrCartEntry

Enclosing interface:

CommerceSession

public static interface CommerceSession.CartEntry

CartEntry represents shopping cart line-items with a certain product and quantity.

Method Summary

Modifier and Type	Method and Description
int	getEntryIndex()
java.lang.String	getPreTaxPrice() Deprecated. since 5.6, use getPrice(org.apache.commons.collections.Predicate) instead.
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()
<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. since 5.6, use getPrice(org.apache.commons.collections.Predicate) instead.
java.lang.String	getTotalPrice() Deprecated. since 5.6, use getPrice(org.apache.commons.collections.Predicate) instead.
java.lang.String	getUnitPrice() Deprecated. since 5.6, use getPrice(org.apache.commons.collections.Predicate) instead.

Method Detail

getEntryIndex

int getEntryIndex()

Returns:

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

getProduct

Product getProduct()
            throws CommerceException

Returns:

the Product for this entry

Throws:

CommerceException

getQuantity

int getQuantity()

Returns:

the quantity

getPriceInfo

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

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"));
 
 

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

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

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

Parameters:

filter - An optional predicate used for filtering the PriceInfos.

Returns:

Formatted price string of first matching price

Throws:

CommerceException

See Also:

getPriceInfo(Predicate)

getProperty

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

Get a cart entry property with the given type.

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.

getUnitPrice

@Deprecated
java.lang.String getUnitPrice()

Deprecated. since 5.6, use getPrice(org.apache.commons.collections.Predicate) instead.

Returns:

a formatted unit price

getPreTaxPrice

@Deprecated
java.lang.String getPreTaxPrice()

Deprecated. since 5.6, use getPrice(org.apache.commons.collections.Predicate) instead.

Returns:

a formatted pre-tax price

getTax

@Deprecated
java.lang.String getTax()

Deprecated. since 5.6, use getPrice(org.apache.commons.collections.Predicate) instead.

Returns:

a formatted tax value

getTotalPrice

@Deprecated
java.lang.String getTotalPrice()

Deprecated. since 5.6, use getPrice(org.apache.commons.collections.Predicate) instead.

Returns:

a formatted total price