com.adobe.cq.commerce.api

Class PriceInfo

java.lang.Object

org.apache.sling.api.wrappers.ValueMapDecorator

com.adobe.cq.commerce.api.PriceInfo

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.Object>, ValueMap

@ProviderType
public class PriceInfo
extends ValueMapDecorator

PriceInfo provides information about prices for products, cart entries, and orders.

A product, cart entry, or order can have many prices associated with it. Each price is identified by a list of string classifiers. For instance, a product might have the following prices:

1. "UNIT", "PRE_TAX", "USD"
2. "UNIT", "PRE_TAX", "EUR"
3. "SHIPPING", "WEIGHT_SURCHARGE", "SURFACE", "EUR"
4. "SHIPPING", "WEIGHT_SURCHARGE", "AIR", "EUR"

A PriceFilter is normally used when fetching prices. Price searches can return a list (generally getPriceInfo()) of all prices matching the filter, or can return only the first (generally getPrice()). Because of the second form, more common (or default) price infos should be stored in front of less common (more specific) price infos.

For instance, if a product had the following prices:

1. "TAX"
2. "TAX", "CALIFORNIA", "SANTA_CLARA"
3. "TAX", "CALIFORNIA", "SAN_DIEGO"

The first price would be returned from getPrice(new PriceFilter("TAX")), while the second would be returned from getPrice(new PriceFilter("TAX", "CALIFORNIA")).

In general, the set of price classifiers used by an e-commerce site are implementation-dependent. However, the out-of-the-box commerce components do make a few assumptions about the existence of the following classifiers:

• "UNIT" (for products and cart entries)
• "LINE" (for cart entries)
• "SHIPPING" (for orders)
• "ORDER" (for orders)

A PriceInfo also supports the retrieval of a formatted string for displaying the price, and a minimum quantity at which the price is valid.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	MIN_QUANTITY

Fields inherited from interface org.apache.sling.api.resource.ValueMap

EMPTY

Constructor Summary

Constructors

Constructor and Description
PriceInfo(java.math.BigDecimal amount, java.util.Currency currency) Deprecated. since 5.6.200; use PriceInfo(java.math.BigDecimal, java.util.Locale) instead.
PriceInfo(java.math.BigDecimal amount, java.util.Locale locale) Create price info with a minimum quantity of one, and the default currency for the given locale.
PriceInfo(java.math.BigDecimal amount, java.util.Locale locale, java.util.Currency currency) Create price info with a minimum quantity of one, and the given currency and locale.

Method Summary

Modifier and Type	Method and Description
java.math.BigDecimal	getAmount() Get the price's value.
java.util.Currency	getCurrency() Get the currency.
java.lang.String	getFormattedString() Get the formatted string.
java.util.Locale	getLocale() Get the locale.
long	getQuantity() Convenience method for retrieving the minimum quantity property.
java.lang.String	toString() Override the standard toString method to return the formatted string.

Methods inherited from class org.apache.sling.api.wrappers.ValueMapDecorator

clear, containsKey, containsValue, entrySet, equals, get, get, get, hashCode, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Field Detail

MIN_QUANTITY

public static final java.lang.String MIN_QUANTITY

See Also:

Constant Field Values

Constructor Detail

PriceInfo

@Deprecated
public PriceInfo(java.math.BigDecimal amount,
                             java.util.Currency currency)

Deprecated. since 5.6.200; use PriceInfo(java.math.BigDecimal, java.util.Locale) instead.

Create price info with a minimum quantity of one.

Parameters:

amount - The actual price value.

currency - The currency.

PriceInfo

public PriceInfo(java.math.BigDecimal amount,
                 java.util.Locale locale)

Create price info with a minimum quantity of one, and the default currency for the given locale.

Parameters:

amount - The actual price value.

locale - The locale.

PriceInfo

public PriceInfo(java.math.BigDecimal amount,
                 java.util.Locale locale,
                 java.util.Currency currency)

Create price info with a minimum quantity of one, and the given currency and locale.

Parameters:

amount - The actual price value.

locale - The locale.

Method Detail

getAmount

public java.math.BigDecimal getAmount()

Get the price's value.

Returns:

getQuantity

public long getQuantity()

Convenience method for retrieving the minimum quantity property. If no quantity property is set, a minimum quantity of 1 is assumed.

Returns:

getLocale

public java.util.Locale getLocale()

Get the locale.

Returns:

getCurrency

public java.util.Currency getCurrency()

Get the currency.

Returns:

getFormattedString

public java.lang.String getFormattedString()

Get the formatted string.

Returns:

toString

public java.lang.String toString()

Override the standard toString method to return the formatted string.

Overrides:

toString in class ValueMapDecorator

Returns: