com.adobe.cq.commerce.common

Class VendorJcrPlacedOrder

java.lang.Object

com.adobe.cq.commerce.common.VendorJcrPlacedOrder

All Implemented Interfaces:

PlacedOrder

public class VendorJcrPlacedOrder
extends java.lang.Object
implements PlacedOrder

An editable implementation of a PlacedOrder, for use in order administration. NB: models vendor records in /var/commerce/orders/, not shopper records in ~/commerce/orders/. For (read-only) access to shopper records, see DefaultJcrPlacedOrder.

Constructor Summary

Constructors

Constructor and Description
VendorJcrPlacedOrder(AbstractJcrCommerceService commerceService, java.lang.String orderId, java.util.Locale locale) Instantiate a new, writable PlacedOrder record.

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.
void	updateOrder(java.util.Map<java.lang.String,java.lang.Object> delta, boolean autoSave) Update a number of properties in the order record.

Methods inherited from class java.lang.Object

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

Constructor Detail

VendorJcrPlacedOrder

public VendorJcrPlacedOrder(AbstractJcrCommerceService commerceService,
                            java.lang.String orderId,
                            java.util.Locale locale)

Instantiate a new, writable PlacedOrder record.

Parameters:

commerceService - The owning CommerceService

orderId - An ID uniquely identifying the placed order. Can either be the orderId property, or the path to the order node. (The path is obviously quicker, but the orderId might be used to track the order in external systems, such as fulfillment systems.)

locale -

Method Detail

getOrderId

public java.lang.String getOrderId()
                            throws CommerceException

Description copied from interface: PlacedOrder

Get an invariant ID for the order.

Specified by:

getOrderId in interface PlacedOrder

Returns:

Throws:

CommerceException

getOrder

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

Description copied from interface: PlacedOrder

Get the order details.

Specified by:

getOrder in interface PlacedOrder

Returns:

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

Throws:

CommerceException

updateOrder

public void updateOrder(java.util.Map<java.lang.String,java.lang.Object> delta,
                        boolean autoSave)
                 throws CommerceException

Update a number of properties in the order record. Currently this is a "raw" update; there is no re-calculation involved.

Parameters:

delta - The properties to update. Properties not in this set will NOT be removed; to remove a property include it with a value of null.

autoSave - If true, the current session will be saved after updating the order.

Throws:

CommerceException

getCartPriceInfo

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

Description copied from interface: PlacedOrder

Get detailed price information.

Specified by:

getCartPriceInfo in interface PlacedOrder

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

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

Description copied from interface: PlacedOrder

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

Specified by:

getCartPrice in interface PlacedOrder

Parameters:

filter - An optional predicate used for filtering the PriceInfos.

Returns:

Formatted price string of first matching price

Throws:

CommerceException

getCartEntries

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

Description copied from interface: PlacedOrder

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

Specified by:

getCartEntries in interface PlacedOrder

Throws:

CommerceException

getPromotions

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

Description copied from interface: PlacedOrder

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

Specified by:

getPromotions in interface PlacedOrder

Throws:

CommerceException

getVoucherInfos

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

Description copied from interface: PlacedOrder

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

Specified by:

getVoucherInfos in interface PlacedOrder

Throws:

CommerceException