com.adobe.cq.commerce.api

Interface PlacedOrder

All Known Implementing Classes:

DefaultJcrPlacedOrder, VendorJcrPlacedOrder

@ConsumerType
public interface PlacedOrder

Represents an historical order (ie: one that has already been placed).

Method Summary

Modifier and Type	Method and Description
java.util.List<CommerceSession.CartEntry>	getCartEntries() Return the list of items from a previously-placed order.
java.lang.String	getCartPrice(Predicate filter) Shortcut for getting a formatted string of the first applicable price, according to the filter.
java.util.List<PriceInfo>	getCartPriceInfo(Predicate filter) Get detailed price information.
java.util.Map<java.lang.String,java.lang.Object>	getOrder() Get the order details.
java.lang.String	getOrderId() Get an invariant ID for the order.
java.util.List<PromotionInfo>	getPromotions() Return the list of promotions that were applied to a previously-placed order.
java.util.List<VoucherInfo>	getVoucherInfos() Return the list of vouchers from a previously-placed order.

Method Detail

getOrderId

java.lang.String getOrderId()
                     throws CommerceException

Get an invariant ID for the order.

Returns:

Throws:

CommerceException

getOrder

java.util.Map<java.lang.String,java.lang.Object> getOrder()
                                                   throws CommerceException

Get the order details.

Returns:

A map of properties describing the cart line items and order details.

Throws:

CommerceException

getCartPriceInfo

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

Get detailed price information.

Parameters:

filter - An optional predicate used for filtering the PriceInfos.

Returns:

A list of PriceInfos.

Throws:

CommerceException

See Also:

CommerceSession.getPriceInfo(com.adobe.cq.commerce.api.Product)

getCartPrice

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

Shortcut for getting a formatted string of the first applicable price, according to the filter.

Parameters:

filter - An optional predicate used for filtering the PriceInfos.

Returns:

Formatted price string of first matching price

Throws:

CommerceException

getCartEntries

java.util.List<CommerceSession.CartEntry> getCartEntries()
                                                  throws CommerceException

Return the list of items from a previously-placed order.

Throws:

CommerceException

getPromotions

java.util.List<PromotionInfo> getPromotions()
                                     throws CommerceException

Return the list of promotions that were applied to a previously-placed order.

Throws:

CommerceException

getVoucherInfos

java.util.List<VoucherInfo> getVoucherInfos()
                                     throws CommerceException

Return the list of vouchers from a previously-placed order.

Throws:

CommerceException