Package de.hybris.platform.order.impl

Class DefaultOrderService

java.lang.Object

de.hybris.platform.servicelayer.internal.service.AbstractService

de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

de.hybris.platform.order.impl.DefaultAbstractOrderService<OrderModel,OrderEntryModel>

de.hybris.platform.order.impl.DefaultOrderService

All Implemented Interfaces:

AbstractOrderService<OrderModel,OrderEntryModel>, OrderService, Serializable, org.springframework.beans.factory.Aware, org.springframework.beans.factory.BeanNameAware, org.springframework.beans.factory.InitializingBean

Direct Known Subclasses:

DefaultAlipayOrderService, DefaultB2BOrderService, DefaultChineseOrderService, DefaultWeChatPayOrderService

public class DefaultOrderService
extends DefaultAbstractOrderService<OrderModel,OrderEntryModel>
implements OrderService

Default implementation of the OrderService.

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

AbstractService.SerializableDTO

Field Summary

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

modelService, sessionService, txManager

Fields inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

tenant

Constructor Summary

Constructors

Constructor	Description
DefaultOrderService()

Method Summary

Modifier and Type	Method	Description
OrderEntryModel	addNewEntry(OrderModel order, ProductModel product, long qty, UnitModel unit, int number, boolean addToPresent)	Adds a new entry to the given order on the required entry number.
AbstractOrderEntryModel	addNewEntry(ComposedTypeModel entryType, OrderModel order, ProductModel product, long qty, UnitModel unit, int number, boolean addToPresent)	Adds a new entry of the given ComposedTypeModel to the given order.
boolean	calculateOrder(AbstractOrderModel order)	Deprecated, for removal: This API element is subject to removal in a future version. since ages
OrderModel	clone(ComposedTypeModel orderType, ComposedTypeModel entryType, AbstractOrderModel original, String code)	Creates new order from given original and change its type and type for entry.
OrderModel	createOrderFromCart(CartModel cart)	Create the order for the given cart.
OrderModel	placeOrder(CartModel cart, AddressModel deliveryAddress, AddressModel paymentAddress, PaymentInfoModel paymentInfo)	Deprecated, for removal: This API element is subject to removal in a future version. since ages
void	setCreateOrderFromCartStrategy(CreateOrderFromCartStrategy submitOrderStrategy)
void	setOrderCalculation(OrderCalculation orderCalculation)	Deprecated, for removal: This API element is subject to removal in a future version. since ages
void	setPlaceOrderStrategy(PlaceOrderStrategy placeOrderStrategy)	Deprecated, for removal: This API element is subject to removal in a future version. since ages
void	setSubmitOrderStrategies(List<SubmitOrderStrategy> submitOrderStrategies)
void	submitOrder(OrderModel order)	Submits an order.

Methods inherited from class de.hybris.platform.order.impl.DefaultAbstractOrderService

addAllGlobalDiscountValues, addAllTotalTaxValues, addEntryAtPosition, addGlobalDiscountValue, addNewEntry, addTotalTaxValue, getAbstractOrderEntryService, getAbstractOrderEntryTypeService, getCloneAbstractOrderStrategy, getCollidingEntry, getEntriesForNumber, getEntriesForProduct, getEntryForNumber, getEntryTypeCode, getGlobalDiscountValue, getOrderDao, getSaveAbstractOrderStrategy, removeGlobalDiscountValue, removeTotalTaxValue, saveOrder, setAbstractOrderEntryService, setAbstractOrderEntryTypeService, setCloneAbstractOrderStrategy, setOrderDao, setSaveAbstractOrderStrategy

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractBusinessService

getModelService, getSessionService, getTxManager, setModelService, setSessionService, setTxManager

Methods inherited from class de.hybris.platform.servicelayer.internal.service.AbstractService

afterPropertiesSet, getCurrentTenant, setBeanName, setCurrentTenant, writeReplace

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.hybris.platform.order.AbstractOrderService

addAllGlobalDiscountValues, addAllTotalTaxValues, addGlobalDiscountValue, addNewEntry, addTotalTaxValue, getEntriesForNumber, getEntriesForProduct, getEntryForNumber, getGlobalDiscountValue, removeGlobalDiscountValue, removeTotalTaxValue, saveOrder

Constructor Details

DefaultOrderService

public DefaultOrderService()

Method Details

createOrderFromCart

public OrderModel createOrderFromCart(CartModel cart)
                               throws InvalidCartException

Description copied from interface: OrderService

Create the order for the given cart. This method focuses on creating an OrderModel instance from the given CartModel instance. The order instance remains unsaved and not calculated.
This method does nothing with the cart member attributes (addresses, paymentInfo). It also leaves the target cart untouched.

If you want to calculate cart or order, use CalculationService.

Specified by:

createOrderFromCart in interface OrderService

Parameters:

cart - the target CartModel

Returns:

a non persisted OrderModel

Throws:

InvalidCartException - if the cart is invalid according to the used CartValidator.

submitOrder

public void submitOrder(OrderModel order)

Description copied from interface: OrderService

Submits an order. Fire list of submit order strategies. Default implementation EventPublishingSubmitOrderStrategy fires SubmitOrderEvent.

Specified by:

submitOrder in interface OrderService

Parameters:

order - Order to submit.

placeOrder

@Deprecated(since="ages",
            forRemoval=true)
public OrderModel placeOrder(CartModel cart,
 AddressModel deliveryAddress,
 AddressModel paymentAddress,
 PaymentInfoModel paymentInfo)
                      throws InvalidCartException

Deprecated, for removal: This API element is subject to removal in a future version.

since ages

Description copied from interface: OrderService

Place the order for the given cart. This means: first the cart is calculated (see OrderService.calculateOrder(AbstractOrderModel) than (if not null) the deliveryAddress and paymentAddress and paymentInfo are stored for the current session user and also to the cart. After this from the cart an OrderModel is created and the cart is removed from the session.

Specified by:

placeOrder in interface OrderService

Parameters:

cart - the CartModel

deliveryAddress - the delivery AddressModel for the current session user. Can be null.

paymentAddress - the payment AddressModel for the current session user. Can be null.

paymentInfo - the PaymentInfoModel for the current session user. Can be null.

Returns:

the OrderModel

Throws:

InvalidCartException

calculateOrder

@Deprecated(since="ages",
            forRemoval=true)
public boolean calculateOrder(AbstractOrderModel order)

Deprecated, for removal: This API element is subject to removal in a future version.

since ages

Description copied from interface: OrderService

Calculates the given order and returns true if each entry and after this the AbstractOrderModel was calculated. Thereby any invalid entry will be automatically removed.

The default implementation delegates to the OrderCalculation.calculate(AbstractOrderModel) strategy. Please check the API doc of your current calculation strategy.

Specified by:

calculateOrder in interface OrderService

Parameters:

order - the AbstractOrderModel

Returns:

false if the order was already calculated.

setPlaceOrderStrategy

@Deprecated(since="ages",
            forRemoval=true)
public void setPlaceOrderStrategy(PlaceOrderStrategy placeOrderStrategy)

Deprecated, for removal: This API element is subject to removal in a future version.

since ages

setOrderCalculation

@Deprecated(since="ages",
            forRemoval=true)
public void setOrderCalculation(OrderCalculation orderCalculation)

Deprecated, for removal: This API element is subject to removal in a future version.

since ages

setCreateOrderFromCartStrategy

public void setCreateOrderFromCartStrategy(CreateOrderFromCartStrategy submitOrderStrategy)

setSubmitOrderStrategies

public void setSubmitOrderStrategies(List<SubmitOrderStrategy> submitOrderStrategies)

clone

public OrderModel clone(ComposedTypeModel orderType,
 ComposedTypeModel entryType,
 AbstractOrderModel original,
 String code)

Description copied from interface: AbstractOrderService

Creates new order from given original and change its type and type for entry. Delegates to the specific CloneAbstractOrderStrategy injected strategy. Resulting order remains not persisted.

Specified by:

clone in interface AbstractOrderService<OrderModel,OrderEntryModel>

Parameters:

orderType - type of result order (OrderModel will be chosen if null is passed)

entryType - type of entry (if null will use service to get proper type)

original - original order

code - code for new order

Returns:

not persisted order model instance.

addNewEntry

public OrderEntryModel addNewEntry(OrderModel order,
 ProductModel product,
 long qty,
 UnitModel unit,
 int number,
 boolean addToPresent)

Description copied from interface: AbstractOrderService

Adds a new entry to the given order on the required entry number. The entry type is recognized basing on AbstractOrderEntryTypeService and the spring configuration behind it. The new entry is neither saved nor calculated. If your new entry has caused entries shuffling you may need to call AbstractOrderService.saveOrder(AbstractOrderModel) method in order to persist the changes.

Specified by:

addNewEntry in interface AbstractOrderService<OrderModel,OrderEntryModel>

Specified by:

addNewEntry in interface OrderService

Overrides:

addNewEntry in class DefaultAbstractOrderService<OrderModel,OrderEntryModel>

Parameters:

order - - target order

product - -product to add, must not be null

qty - - quantity

unit - - must not be null

number - - entry number of the new entry in the order. Entries are indexed starting from 0. Set number to -1 if you want to append the entry as the last one. You can request any non-negative position.

addToPresent - - if true an existing entry with matching product and unit will get its quantity increased; otherwise a new entry is created

Returns:

AbstractOrderEntryModel - newly created order entry

See Also:

• AbstractOrderEntryTypeService.getAbstractOrderEntryType(AbstractOrderModel)

addNewEntry

public AbstractOrderEntryModel addNewEntry(ComposedTypeModel entryType,
 OrderModel order,
 ProductModel product,
 long qty,
 UnitModel unit,
 int number,
 boolean addToPresent)

Description copied from interface: AbstractOrderService

Adds a new entry of the given ComposedTypeModel to the given order. The new entry is neither saved nor calculated. If your new entry has caused entries shuffling you may need to call AbstractOrderService.saveOrder(AbstractOrderModel) method in order to persist the changes.

Specified by:

addNewEntry in interface AbstractOrderService<OrderModel,OrderEntryModel>

Specified by:

addNewEntry in interface OrderService

Overrides:

addNewEntry in class DefaultAbstractOrderService<OrderModel,OrderEntryModel>

Parameters:

entryType - - the requested sub-type AbstractOrderEntry

order - - target order

product - -product to add, must not be null

qty - - quantity

unit - - must not be null

number - - entry number of the new entry in the order. Entries are indexed starting from 0. Set number to -1 if you want to append the entry as the last one. You can request any non-negative position.

addToPresent - - if true an existing entry with matching product and unit will get its quantity increased; otherwise a new entry is created

Returns:

AbstractOrderEntryModel - newly created order entry