de.hybris.platform.cscockpit.services.checkout.impl

Class DefaultCsCheckoutService

java.lang.Object

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

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

de.hybris.platform.cscockpit.services.checkout.impl.DefaultCsCheckoutService

All Implemented Interfaces:

CsCheckoutService, java.io.Serializable

Direct Known Subclasses:

DefaultSubscriptionCsCheckoutService

public class DefaultCsCheckoutService
extends AbstractBusinessService
implements CsCheckoutService

Default impl for CsCheckoutService

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 and Description
DefaultCsCheckoutService()

Method Summary

Modifier and Type	Method and Description
PaymentTransactionEntryModel	authorisePayment(CartModel cart, CardInfo cardInfo, double amount) Authorise payment for the cart or order.
PaymentTransactionEntryModel	authorisePayment(CartModel cart, CreditCardPaymentInfoModel storeCard, java.math.BigDecimal amount, java.lang.String cv2) Authorise payment for the cart.
void	canCreatePayments(CartModel cartModel) Test if payment options can be created against the current cart.
protected java.lang.String	cleanupCardNumber(java.lang.String cardNumber) Cleanup the card number.
protected CreditCardPaymentInfoModel	createSubscription(CartModel cart, CardInfo cardInfo)
OrderModel	doCheckout(CartModel cart) Place an order based on the cart supplied.
java.util.List<DeliveryModeModel>	getAllDeliveryModes(CartModel cart) Get all the supported delivery modes for the cart specified.
protected CommerceCheckoutService	getCommerceCheckoutService()
protected CommonI18NService	getCommonI18NService()
protected CsCardPaymentService	getCsCardPaymentService()
protected CsOrderUnauthorizedTotalStrategy	getCsOrderUnauthorizedTotalStrategy()
protected CustomerAccountService	getCustomerAccountService()
protected DeliveryService	getDeliveryService()
protected KeyGenerator	getOrderCodeGenerator()
protected OrderFulfillmentProcessService	getOrderFulfillmentProcessService()
protected OrderService	getOrderService()
protected AddressModel	getPaymentDeliveryAddress(CartModel cart)
protected java.lang.String	getPaymentProvider()
protected TransactionInfoService	getTransactionInfoService()
double	getUnauthorizedTotal(CartModel cart) Gets the unauthorized total for the cart specified.
java.util.List<PaymentTransactionModel>	getValidPaymentTransactions(CartModel cart) Get the list of payment transactions that have been created for the cart specified.
protected boolean	isDeliveryAddressRequired()
protected boolean	isDeliveryModeRequired()
protected boolean	isPaymentAddressRequired()
protected PaymentTransactionEntryModel	preAuth(CartModel cart, CreditCardPaymentInfoModel creditCardPaymentInfoModel, java.math.BigDecimal amountToAuth, java.lang.String cv2Number)
void	setCommerceCheckoutService(CommerceCheckoutService commerceCheckoutService)
void	setCommonI18NService(CommonI18NService commonI18NService)
void	setCsCardPaymentService(CsCardPaymentService csCardPaymentService)
void	setCsOrderUnauthorizedTotalStrategy(CsOrderUnauthorizedTotalStrategy csOrderUnauthorizedTotalStrategy)
void	setCustomerAccountService(CustomerAccountService customerAccountService)
void	setDeliveryAddressRequired(boolean deliveryAddressRequired)
void	setDeliveryModeRequired(boolean deliveryModeRequired)
void	setDeliveryService(DeliveryService deliveryService)
void	setOrderCodeGenerator(KeyGenerator orderCodeGenerator)
void	setOrderFulfillmentProcessService(OrderFulfillmentProcessService orderFulfillmentProcessService)
void	setOrderService(OrderService orderService)
void	setPaymentAddressRequired(boolean paymentAddressRequired)
void	setTransactionInfoService(TransactionInfoService transactionInfoService)
protected void	validateCartForCheckout(CartModel cart)
protected void	validateCartForCreatePayments(CartModel cart)

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, setTenantScope, writeReplace

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultCsCheckoutService

public DefaultCsCheckoutService()

Method Detail

getOrderService

protected OrderService getOrderService()

setOrderService

public void setOrderService(OrderService orderService)

getOrderCodeGenerator

protected KeyGenerator getOrderCodeGenerator()

setOrderCodeGenerator

public void setOrderCodeGenerator(KeyGenerator orderCodeGenerator)

getCsOrderUnauthorizedTotalStrategy

protected CsOrderUnauthorizedTotalStrategy getCsOrderUnauthorizedTotalStrategy()

setCsOrderUnauthorizedTotalStrategy

public void setCsOrderUnauthorizedTotalStrategy(CsOrderUnauthorizedTotalStrategy csOrderUnauthorizedTotalStrategy)

isDeliveryAddressRequired

protected boolean isDeliveryAddressRequired()

setDeliveryAddressRequired

public void setDeliveryAddressRequired(boolean deliveryAddressRequired)

isDeliveryModeRequired

protected boolean isDeliveryModeRequired()

setDeliveryModeRequired

public void setDeliveryModeRequired(boolean deliveryModeRequired)

isPaymentAddressRequired

protected boolean isPaymentAddressRequired()

setPaymentAddressRequired

public void setPaymentAddressRequired(boolean paymentAddressRequired)

getOrderFulfillmentProcessService

protected OrderFulfillmentProcessService getOrderFulfillmentProcessService()

setOrderFulfillmentProcessService

public void setOrderFulfillmentProcessService(OrderFulfillmentProcessService orderFulfillmentProcessService)

getTransactionInfoService

protected TransactionInfoService getTransactionInfoService()

setTransactionInfoService

public void setTransactionInfoService(TransactionInfoService transactionInfoService)

getDeliveryService

protected DeliveryService getDeliveryService()

setDeliveryService

public void setDeliveryService(DeliveryService deliveryService)

getCommonI18NService

protected CommonI18NService getCommonI18NService()

setCommonI18NService

public void setCommonI18NService(CommonI18NService commonI18NService)

getCommerceCheckoutService

protected CommerceCheckoutService getCommerceCheckoutService()

setCommerceCheckoutService

public void setCommerceCheckoutService(CommerceCheckoutService commerceCheckoutService)

getCustomerAccountService

protected CustomerAccountService getCustomerAccountService()

setCustomerAccountService

public void setCustomerAccountService(CustomerAccountService customerAccountService)

getCsCardPaymentService

protected CsCardPaymentService getCsCardPaymentService()

setCsCardPaymentService

public void setCsCardPaymentService(CsCardPaymentService csCardPaymentService)

doCheckout

public OrderModel doCheckout(CartModel cart)
                      throws ValidationException

Description copied from interface: CsCheckoutService

Place an order based on the cart supplied.

Specified by:

doCheckout in interface CsCheckoutService

Parameters:

cart - the cart

Returns:

the new order

Throws:

ValidationException - thrown if the order cannot be placed

validateCartForCheckout

protected void validateCartForCheckout(CartModel cart)
                                throws ValidationException

Throws:

ValidationException

getUnauthorizedTotal

public double getUnauthorizedTotal(CartModel cart)

Description copied from interface: CsCheckoutService

Gets the unauthorized total for the cart specified. The unauthorized total is the difference between the total price and the currently authorised amount. In the simplest case of a cart with no existing payment transactions the unauthorized total equals the total price. The unauthorized total returned must be in the range zero to total price.

Specified by:

getUnauthorizedTotal in interface CsCheckoutService

Parameters:

cart - the cart

Returns:

the unauthorized total

getValidPaymentTransactions

public java.util.List<PaymentTransactionModel> getValidPaymentTransactions(CartModel cart)

Description copied from interface: CsCheckoutService

Get the list of payment transactions that have been created for the cart specified. The list only includes payment transactions that contain an authorisation that is both successful and valid.

Specified by:

getValidPaymentTransactions in interface CsCheckoutService

Parameters:

cart - the cart

Returns:

the list of valid payment transactions

getAllDeliveryModes

public java.util.List<DeliveryModeModel> getAllDeliveryModes(CartModel cart)

Description copied from interface: CsCheckoutService

Get all the supported delivery modes for the cart specified.

Specified by:

getAllDeliveryModes in interface CsCheckoutService

Parameters:

cart - the cart

Returns:

the list of supported delivery modes

canCreatePayments

public void canCreatePayments(CartModel cartModel)
                       throws ValidationException

Description copied from interface: CsCheckoutService

Test if payment options can be created against the current cart. This method performs validation on the cart to ensure that there are entries in the cart, that the cart total is positive and that there is still some amount remaining to be paid.

Specified by:

canCreatePayments in interface CsCheckoutService

Parameters:

cartModel - The cart

Throws:

ValidationException - Exception thrown if payments cannot be created at this time. The exception includes messages that detail the errors.

authorisePayment

public PaymentTransactionEntryModel authorisePayment(CartModel cart,
                                                     CardInfo cardInfo,
                                                     double amount)
                                              throws PaymentException,
                                                     ValidationException

Description copied from interface: CsCheckoutService

Authorise payment for the cart or order.

Specified by:

authorisePayment in interface CsCheckoutService

Parameters:

cart - the cart

cardInfo - the payment card data

amount - the amount to authorise

Returns:

the authorisation payment transaction entry

Throws:

PaymentException - thrown on error from the payment service

ValidationException - thrown if the card details are invalid

authorisePayment

public PaymentTransactionEntryModel authorisePayment(CartModel cart,
                                                     CreditCardPaymentInfoModel storeCard,
                                                     java.math.BigDecimal amount,
                                                     java.lang.String cv2)
                                              throws PaymentException,
                                                     ValidationException

Description copied from interface: CsCheckoutService

Authorise payment for the cart.

Specified by:

authorisePayment in interface CsCheckoutService

Parameters:

cart - the cart

storeCard - the stored card

amount - the amount to authorise

cv2 - the cv2 number

Returns:

the authorisation payment transaction entry

Throws:

PaymentException - thrown on error from the payment service

ValidationException - thrown if the card details are invalid

getPaymentDeliveryAddress

protected AddressModel getPaymentDeliveryAddress(CartModel cart)

validateCartForCreatePayments

protected void validateCartForCreatePayments(CartModel cart)
                                      throws ValidationException

Throws:

ValidationException

createSubscription

protected CreditCardPaymentInfoModel createSubscription(CartModel cart,
                                                        CardInfo cardInfo)
                                                 throws PaymentException

Throws:

PaymentException

preAuth

protected PaymentTransactionEntryModel preAuth(CartModel cart,
                                               CreditCardPaymentInfoModel creditCardPaymentInfoModel,
                                               java.math.BigDecimal amountToAuth,
                                               java.lang.String cv2Number)
                                        throws PaymentException

Throws:

PaymentException

cleanupCardNumber

protected java.lang.String cleanupCardNumber(java.lang.String cardNumber)

Cleanup the card number. Retain only the numbers from the card number string.

Parameters:

cardNumber - the inputted card number

Returns:

the cleaned card number

getPaymentProvider

protected java.lang.String getPaymentProvider()