Package de.hybris.platform.commerceservices.order

Interface CommerceCheckoutService

All Known Implementing Classes:

DefaultB2BCommerceCheckoutService, DefaultCommerceCheckoutService

public interface CommerceCheckoutService

Service for checkout and place order functionality

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, java.lang.String securityCode, java.lang.String paymentProvider)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
PaymentTransactionEntryModel	authorizePayment(CartModel cartModel, java.lang.String securityCode, java.lang.String paymentProvider, java.math.BigDecimal amount)	Deprecated, for removal: This API element is subject to removal in a future version. Since 5.2.
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.
java.util.List<CountryModel>	getCountries(CountryType countryType)	Get countries.
java.lang.String	getPaymentProvider()	Get the payment provider name
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.
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.
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	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.

Method Detail

setDeliveryAddress

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

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

Since 5.2. Use setDeliveryAddress(de.hybris.platform.commerceservices.service.data.CommerceCheckoutParameter) instead

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)
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. Use setDeliveryAddress(de.hybris.platform.commerceservices.service.data.CommerceCheckoutParameter) instead 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.

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

boolean setDeliveryAddress(CommerceCheckoutParameter parameter)

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.

Parameters:

parameter - A parameter object

Returns:

true if successful

setDeliveryMode

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

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

Since 5.2. Use setDeliveryAddress(de.hybris.platform.commerceservices.service.data.CommerceCheckoutParameter) instead. Sets the given delivery mode on the cart

Parameters:

cartModel - the cart

deliveryModeModel - the delivery mode

Returns:

true if successful

setDeliveryMode

boolean setDeliveryMode(CommerceCheckoutParameter parameter)

Sets the given delivery mode on the cart

Parameters:

parameter - A parameter object for cart and deliverymode

Returns:

true if successful

validateDeliveryMode

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

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

Since 5.2. Use validateDeliveryMode(de.hybris.platform.commerceservices.service.data.CommerceCheckoutParameter) instead 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)

Parameters:

cartModel - the cart

validateDeliveryMode

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)

Parameters:

parameter - The parameter object holding the cart

setPaymentInfo

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

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

Since 5.2. Use setPaymentInfo(de.hybris.platform.commerceservices.service.data.CommerceCheckoutParameter) instead. Sets the given payment info on the cart

Parameters:

cartModel - the cart

paymentInfoModel - the payment details

Returns:

true if successful

setPaymentInfo

boolean setPaymentInfo(CommerceCheckoutParameter parameter)

Sets the given payment info on the cart

Parameters:

parameter - A parameter object for cart and payment details

Returns:

true if successful

authorizePayment

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

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

Since 5.2. Use authorizePayment(de.hybris.platform.commerceservices.service.data.CommerceCheckoutParameter) Authorizes the total amount of the cart

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)
PaymentTransactionEntryModel authorizePayment(CartModel cartModel,
                                              java.lang.String securityCode,
                                              java.lang.String paymentProvider,
                                              java.math.BigDecimal amount)

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

Since 5.2. Use authorizePayment(de.hybris.platform.commerceservices.service.data.CommerceCheckoutParameter) Authorizes specified amount

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

authorizePayment

PaymentTransactionEntryModel authorizePayment(CommerceCheckoutParameter parameter)

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

Parameters:

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

Returns:

A payment transaction entry.

placeOrder

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

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

Since 5.2. Use placeOrder(de.hybris.platform.commerceservices.service.data.CommerceCheckoutParameter) instead Creates an order for the given cart

Parameters:

cartModel - the cart

Returns:

the order that has been created

Throws:

InvalidCartException - if the order cannot be placed

placeOrder

@Deprecated(since="5.2",
            forRemoval=true)
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. Creates an order for the given cart

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

CommerceOrderResult placeOrder(CommerceCheckoutParameter parameter)
                        throws InvalidCartException

Creates an order for the given cart

Parameters:

parameter -

Returns:

the order that has been created

Throws:

InvalidCartException - if the order cannot be placed

getPaymentProvider

java.lang.String getPaymentProvider()

Get the payment provider name

Returns:

the payment provider

removeDeliveryMode

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

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

Since 5.2. Use removeDeliveryMode(de.hybris.platform.commerceservices.service.data.CommerceCheckoutParameter) instead Removes delivery mode from cart. the cart is then calculated via CommerceCartCalculationStrategy.calculateCart(de.hybris.platform.core.model.order.CartModel)

Parameters:

cartModel - the cart

Returns:

true if the deliver mode is removed

removeDeliveryMode

boolean removeDeliveryMode(CommerceCheckoutParameter parameter)

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

Parameters:

parameter - A parameter object holding the cart

Returns:

true if success

calculateCart

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

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

Since 5.2. Use calculateCart(de.hybris.platform.commerceservices.service.data.CommerceCheckoutParameter) instead. Calculates the cartModel if the calculated flag is false.

Parameters:

cartModel - The current user's cartModel

calculateCart

void calculateCart(CommerceCheckoutParameter parameter)

Calculates the cartModel if the calculated flag is false.

Parameters:

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

getCountries

java.util.List<CountryModel> getCountries(CountryType countryType)

Get countries.

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.