Package de.hybris.platform.commerceservices.order.impl

Class DefaultCommerceCheckoutService

java.lang.Object

de.hybris.platform.commerceservices.order.impl.DefaultCommerceCheckoutService

All Implemented Interfaces:

CommerceCheckoutService

Direct Known Subclasses:

DefaultB2BCommerceCheckoutService

public class DefaultCommerceCheckoutService
extends Object
implements CommerceCheckoutService

Default implementation of CommerceCheckoutService

Constructor Summary

Constructors

Constructor	Description
DefaultCommerceCheckoutService()

Method Summary

Modifier and Type	Method	Description
PaymentTransactionEntryModel	authorizePayment(CommerceCheckoutParameter parameter)	Authorizes the total amount of the cart if CommerceCheckoutParameter.authorizationAmount is null otherwise the passed in amout is authorized
PaymentTransactionEntryModel	authorizePayment(CartModel cartModel, String securityCode, String paymentProvider)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
PaymentTransactionEntryModel	authorizePayment(CartModel cartModel, String securityCode, String paymentProvider, BigDecimal amount)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
protected BigDecimal	calculateAuthAmount(CartModel cartModel)	Calculate authorization amount.
void	calculateCart(CommerceCheckoutParameter parameter)	Calculates the cartModel if the calculated flag is false.
void	calculateCart(CartModel cartModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
protected BaseSiteService	getBaseSiteService()
protected BaseStoreService	getBaseStoreService()
protected CalculationService	getCalculationService()
protected CommerceCartCalculationStrategy	getCommerceCartCalculationStrategy()
protected CommerceDeliveryAddressStrategy	getCommerceDeliveryAddressStrategy()
protected CommerceDeliveryModeStrategy	getCommerceDeliveryModeStrategy()
protected CommerceDeliveryModeValidationStrategy	getCommerceDeliveryModeValidationStrategy()
protected CommercePaymentAuthorizationStrategy	getCommercePaymentAuthorizationStrategy()
protected CommercePaymentInfoStrategy	getCommercePaymentInfoStrategy()
protected CommercePaymentProviderStrategy	getCommercePaymentProviderStrategy()
protected CommercePlaceOrderStrategy	getCommercePlaceOrderStrategy()
protected CommonI18NService	getCommonI18NService()
List<CountryModel>	getCountries(CountryType countryType)	Get countries.
protected DeliveryService	getDeliveryService()
ExternalTaxesService	getExternalTaxesService()
protected I18NService	getI18nService()
protected ModelService	getModelService()
protected OrderService	getOrderService()
String	getPaymentProvider()	Get the payment provider name
protected PaymentService	getPaymentService()
protected PromotionsService	getPromotionsService()
CommerceOrderResult	placeOrder(CommerceCheckoutParameter parameter)	Creates an order for the given cart
OrderModel	placeOrder(CartModel cartModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
OrderModel	placeOrder(CartModel cartModel, SalesApplication salesApplication)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
boolean	removeDeliveryMode(CommerceCheckoutParameter parameter)	Removes delivery mode from cart.
boolean	removeDeliveryMode(CartModel cartModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
void	setBaseSiteService(BaseSiteService siteService)
void	setBaseStoreService(BaseStoreService service)
void	setCalculationService(CalculationService calculationService)
void	setCommerceCartCalculationStrategy(CommerceCartCalculationStrategy commerceCartCalculationStrategy)
void	setCommerceDeliveryAddressStrategy(CommerceDeliveryAddressStrategy commerceDeliveryAddressStrategy)
void	setCommerceDeliveryModeStrategy(CommerceDeliveryModeStrategy commerceDeliveryModeStrategy)
void	setCommerceDeliveryModeValidationStrategy(CommerceDeliveryModeValidationStrategy commerceDeliveryModeValidationStrategy)
void	setCommercePaymentAuthorizationStrategy(CommercePaymentAuthorizationStrategy commercePaymentAuthorizationStrategy)
void	setCommercePaymentInfoStrategy(CommercePaymentInfoStrategy commercePaymentInfoStrategy)
void	setCommercePaymentProviderStrategy(CommercePaymentProviderStrategy commercePaymentProviderStrategy)
void	setCommercePlaceOrderStrategy(CommercePlaceOrderStrategy commercePlaceOrderStrategy)
void	setCommonI18NService(CommonI18NService commonI18NService)
boolean	setDeliveryAddress(CommerceCheckoutParameter parameter)	Sets the given address as delivery address on the cart and also marks the address as delivery address.
boolean	setDeliveryAddress(CartModel cartModel, AddressModel addressModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
boolean	setDeliveryAddress(CartModel cartModel, AddressModel addressModel, boolean flagAsDeliveryAddress)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
boolean	setDeliveryMode(CommerceCheckoutParameter parameter)	Sets the given delivery mode on the cart
boolean	setDeliveryMode(CartModel cartModel, DeliveryModeModel deliveryModeModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
void	setDeliveryService(DeliveryService deliveryService)
void	setExternalTaxesService(ExternalTaxesService externalTaxesService)
void	setI18nService(I18NService i18nService)
void	setModelService(ModelService modelService)
void	setOrderService(OrderService orderService)
boolean	setPaymentInfo(CommerceCheckoutParameter parameter)	Sets the given payment info on the cart
boolean	setPaymentInfo(CartModel cartModel, PaymentInfoModel paymentInfoModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
void	setPaymentService(PaymentService paymentService)
void	setPromotionsService(PromotionsService promotionsService)
void	validateDeliveryMode(CommerceCheckoutParameter parameter)	Validates the current delivery mode on the cart and clears if not valid the cart is then calculated via CommerceCartCalculationStrategy.calculateCart(de.hybris.platform.core.model.order.CartModel)
void	validateDeliveryMode(CartModel cartModel)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.

Methods inherited from class java.lang.Object

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

Constructor Details

DefaultCommerceCheckoutService

public DefaultCommerceCheckoutService()

Method Details

setDeliveryAddress

@Deprecated(since="5.2",
            forRemoval=true)
public boolean setDeliveryAddress(CartModel cartModel,
 AddressModel addressModel)

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

Since 5.2.

Specified by:

setDeliveryAddress in interface CommerceCheckoutService

Parameters:

cartModel - the cart

addressModel - the address, a null address will cause the delivery address to be removed from the cart.

Returns:

true if successful

setDeliveryAddress

@Deprecated(since="5.2",
            forRemoval=true)
public boolean setDeliveryAddress(CartModel cartModel,
 AddressModel addressModel,
 boolean flagAsDeliveryAddress)

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

Since 5.2.

Specified by:

setDeliveryAddress in interface CommerceCheckoutService

Parameters:

cartModel - the cart

addressModel - the address a null address will cause the delivery address to be removed from the cart.

flagAsDeliveryAddress - true to mark the given address as delivery address

Returns:

true if successful

setDeliveryAddress

public boolean setDeliveryAddress(CommerceCheckoutParameter parameter)

Description copied from interface: CommerceCheckoutService

Sets the given address as delivery address on the cart and also marks the address as delivery address. A null address will cause removal of deliveryAddress from the cart.

Specified by:

setDeliveryAddress in interface CommerceCheckoutService

Parameters:

parameter - A parameter object

Returns:

true if successful

setDeliveryMode

public boolean setDeliveryMode(CommerceCheckoutParameter parameter)

Description copied from interface: CommerceCheckoutService

Sets the given delivery mode on the cart

Specified by:

setDeliveryMode in interface CommerceCheckoutService

Parameters:

parameter - A parameter object for cart and deliverymode

Returns:

true if successful

setDeliveryMode

@Deprecated(since="5.2",
            forRemoval=true)
public boolean setDeliveryMode(CartModel cartModel,
 DeliveryModeModel deliveryModeModel)

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

Since 5.2.

Specified by:

setDeliveryMode in interface CommerceCheckoutService

Parameters:

cartModel - the cart

deliveryModeModel - the delivery mode

Returns:

true if successful

removeDeliveryMode

public boolean removeDeliveryMode(CommerceCheckoutParameter parameter)

Description copied from interface: CommerceCheckoutService

Removes delivery mode from cart. the cart is then calculated via CommerceCartCalculationStrategy.calculateCart(de.hybris.platform.core.model.order.CartModel)

Specified by:

removeDeliveryMode in interface CommerceCheckoutService

Parameters:

parameter - A parameter object holding the cart

Returns:

true if success

removeDeliveryMode

@Deprecated(since="5.2",
            forRemoval=true)
public boolean removeDeliveryMode(CartModel cartModel)

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

Since 5.2.

Specified by:

removeDeliveryMode in interface CommerceCheckoutService

Parameters:

cartModel - the cart

Returns:

true if the deliver mode is removed

calculateCart

public void calculateCart(CommerceCheckoutParameter parameter)

Description copied from interface: CommerceCheckoutService

Calculates the cartModel if the calculated flag is false.

Specified by:

calculateCart in interface CommerceCheckoutService

Parameters:

parameter - The parameter object for the current user's cartModel

calculateCart

@Deprecated(since="5.2",
            forRemoval=true)
public void calculateCart(CartModel cartModel)

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

Since 5.2.

Specified by:

calculateCart in interface CommerceCheckoutService

Parameters:

cartModel - The current user's cartModel

validateDeliveryMode

public void validateDeliveryMode(CommerceCheckoutParameter parameter)

Description copied from interface: CommerceCheckoutService

Validates the current delivery mode on the cart and clears if not valid the cart is then calculated via CommerceCartCalculationStrategy.calculateCart(de.hybris.platform.core.model.order.CartModel)

Specified by:

validateDeliveryMode in interface CommerceCheckoutService

Parameters:

parameter - The parameter object holding the cart

validateDeliveryMode

@Deprecated(since="5.2",
            forRemoval=true)
public void validateDeliveryMode(CartModel cartModel)

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

Since 5.2.

Specified by:

validateDeliveryMode in interface CommerceCheckoutService

Parameters:

cartModel - the cart

setPaymentInfo

public boolean setPaymentInfo(CommerceCheckoutParameter parameter)

Description copied from interface: CommerceCheckoutService

Sets the given payment info on the cart

Specified by:

setPaymentInfo in interface CommerceCheckoutService

Parameters:

parameter - A parameter object for cart and payment details

Returns:

true if successful

setPaymentInfo

@Deprecated(since="5.2",
            forRemoval=true)
public boolean setPaymentInfo(CartModel cartModel,
 PaymentInfoModel paymentInfoModel)

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

Since 5.2.

Specified by:

setPaymentInfo in interface CommerceCheckoutService

Parameters:

cartModel - the cart

paymentInfoModel - the payment details

Returns:

true if successful

authorizePayment

public PaymentTransactionEntryModel authorizePayment(CommerceCheckoutParameter parameter)

Description copied from interface: CommerceCheckoutService

Authorizes the total amount of the cart if CommerceCheckoutParameter.authorizationAmount is null otherwise the passed in amout is authorized

Specified by:

authorizePayment in interface CommerceCheckoutService

Parameters:

parameter - A parameter object holding the cart, security code, payment provider and optionaly authorization amount.

Returns:

A payment transaction entry.

calculateAuthAmount

protected BigDecimal calculateAuthAmount(CartModel cartModel)

Calculate authorization amount.

Parameters:

cartModel - the cart model

Returns:

the big decimal authorization amount

authorizePayment

@Deprecated(since="5.2",
            forRemoval=true)
public PaymentTransactionEntryModel authorizePayment(CartModel cartModel,
 String securityCode,
 String paymentProvider)

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

Since 5.2.

Specified by:

authorizePayment in interface CommerceCheckoutService

Parameters:

cartModel - the cart

securityCode - the cv2 number

paymentProvider - the payment provider that will be used to authorize

Returns:

the payment transaction entry

authorizePayment

@Deprecated(since="5.2",
            forRemoval=true)
public PaymentTransactionEntryModel authorizePayment(CartModel cartModel,
 String securityCode,
 String paymentProvider,
 BigDecimal amount)

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

Since 5.2.

Specified by:

authorizePayment in interface CommerceCheckoutService

Parameters:

cartModel - the cart

securityCode - the cv2 number

paymentProvider - the payment provider that will be used to authorize

amount - the amount to authorize

Returns:

the payment transaction entry

placeOrder

@Deprecated(since="5.2",
            forRemoval=true)
public OrderModel placeOrder(CartModel cartModel,
 SalesApplication salesApplication)
                      throws InvalidCartException

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

Since 5.2.

Specified by:

placeOrder in interface CommerceCheckoutService

Parameters:

cartModel - the cart

salesApplication - the sales application that placed the order

Returns:

the order that has been created

Throws:

InvalidCartException - if the order cannot be placed

placeOrder

@Deprecated(since="5.2",
            forRemoval=true)
public OrderModel placeOrder(CartModel cartModel)
                      throws InvalidCartException

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

Since 5.2.

Specified by:

placeOrder in interface CommerceCheckoutService

Parameters:

cartModel - the cart

Returns:

the order that has been created

Throws:

InvalidCartException - if the order cannot be placed

placeOrder

public CommerceOrderResult placeOrder(CommerceCheckoutParameter parameter)
                               throws InvalidCartException

Description copied from interface: CommerceCheckoutService

Creates an order for the given cart

Specified by:

placeOrder in interface CommerceCheckoutService

Returns:

the order that has been created

Throws:

InvalidCartException - if the order cannot be placed

getPaymentProvider

public String getPaymentProvider()

Description copied from interface: CommerceCheckoutService

Get the payment provider name

Specified by:

getPaymentProvider in interface CommerceCheckoutService

Returns:

the payment provider

getCountries

public List<CountryModel> getCountries(CountryType countryType)

Description copied from interface: CommerceCheckoutService

Get countries.

Specified by:

getCountries in interface CommerceCheckoutService

Parameters:

countryType - If the value of type equals to shipping, then return shipping countries. If the value of type equals to billing, then return billing countries. If the value of type is not given, return all countries.

Returns:

list of countries.

getModelService

protected ModelService getModelService()

setModelService

public void setModelService(ModelService modelService)

getDeliveryService

protected DeliveryService getDeliveryService()

setDeliveryService

public void setDeliveryService(DeliveryService deliveryService)

getI18nService

protected I18NService getI18nService()

setI18nService

public void setI18nService(I18NService i18nService)

getCommonI18NService

protected CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getPaymentService

protected PaymentService getPaymentService()

setPaymentService

public void setPaymentService(PaymentService paymentService)

getOrderService

protected OrderService getOrderService()

setOrderService

public void setOrderService(OrderService orderService)

getBaseSiteService

protected BaseSiteService getBaseSiteService()

setBaseSiteService

public void setBaseSiteService(BaseSiteService siteService)

getBaseStoreService

protected BaseStoreService getBaseStoreService()

setBaseStoreService

public void setBaseStoreService(BaseStoreService service)

getPromotionsService

protected PromotionsService getPromotionsService()

setPromotionsService

public void setPromotionsService(PromotionsService promotionsService)

getCalculationService

protected CalculationService getCalculationService()

setCalculationService

public void setCalculationService(CalculationService calculationService)

getExternalTaxesService

public ExternalTaxesService getExternalTaxesService()

setExternalTaxesService

public void setExternalTaxesService(ExternalTaxesService externalTaxesService)

getCommerceCartCalculationStrategy

protected CommerceCartCalculationStrategy getCommerceCartCalculationStrategy()

setCommerceCartCalculationStrategy

public void setCommerceCartCalculationStrategy(CommerceCartCalculationStrategy commerceCartCalculationStrategy)

getCommercePlaceOrderStrategy

protected CommercePlaceOrderStrategy getCommercePlaceOrderStrategy()

setCommercePlaceOrderStrategy

public void setCommercePlaceOrderStrategy(CommercePlaceOrderStrategy commercePlaceOrderStrategy)

getCommercePaymentAuthorizationStrategy

protected CommercePaymentAuthorizationStrategy getCommercePaymentAuthorizationStrategy()

setCommercePaymentAuthorizationStrategy

public void setCommercePaymentAuthorizationStrategy(CommercePaymentAuthorizationStrategy commercePaymentAuthorizationStrategy)

getCommercePaymentInfoStrategy

protected CommercePaymentInfoStrategy getCommercePaymentInfoStrategy()

setCommercePaymentInfoStrategy

public void setCommercePaymentInfoStrategy(CommercePaymentInfoStrategy commercePaymentInfoStrategy)

getCommerceDeliveryModeValidationStrategy

protected CommerceDeliveryModeValidationStrategy getCommerceDeliveryModeValidationStrategy()

setCommerceDeliveryModeValidationStrategy

public void setCommerceDeliveryModeValidationStrategy(CommerceDeliveryModeValidationStrategy commerceDeliveryModeValidationStrategy)

getCommercePaymentProviderStrategy

protected CommercePaymentProviderStrategy getCommercePaymentProviderStrategy()

setCommercePaymentProviderStrategy

public void setCommercePaymentProviderStrategy(CommercePaymentProviderStrategy commercePaymentProviderStrategy)

getCommerceDeliveryAddressStrategy

protected CommerceDeliveryAddressStrategy getCommerceDeliveryAddressStrategy()

setCommerceDeliveryAddressStrategy

public void setCommerceDeliveryAddressStrategy(CommerceDeliveryAddressStrategy commerceDeliveryAddressStrategy)

getCommerceDeliveryModeStrategy

protected CommerceDeliveryModeStrategy getCommerceDeliveryModeStrategy()

setCommerceDeliveryModeStrategy

public void setCommerceDeliveryModeStrategy(CommerceDeliveryModeStrategy commerceDeliveryModeStrategy)