org.broadleafcommerce.core.web.processor

Class OnePageCheckoutProcessor

java.lang.Object

org.thymeleaf.processor.AbstractProcessor

org.thymeleaf.processor.element.AbstractElementProcessor

org.thymeleaf.processor.element.AbstractLocalVariableDefinitionElementProcessor

org.broadleafcommerce.core.web.processor.OnePageCheckoutProcessor

All Implemented Interfaces:

Comparable<org.thymeleaf.processor.IProcessor>, org.thymeleaf.processor.IProcessor

public class OnePageCheckoutProcessor
extends org.thymeleaf.processor.element.AbstractLocalVariableDefinitionElementProcessor

This is a Thymeleaf Processor that aids in rendering a dynamic One Page Checkout screen. These sections are driven by the state of the order and whether or not certain integrated payment modules are enabled (e.g. PayPal Express Review Page etc...).

For example, if there are no shippable fulfillment groups on the order, then the shipping section should not be shown. Or, if the user is redirected back from a Third Party Payment gateway to complete the order (e.g. PayPal Express Checkout), then the billing section will not be shown.

Author:

Elbert Bautista (elbertbautista)

Field Summary

Fields

Modifier and Type	Field and Description
protected CountryService	countryService
protected CustomerAddressService	customerAddressService
protected FulfillmentGroupService	fulfillmentGroupService
protected FulfillmentOptionService	fulfillmentOptionService
protected FulfillmentPricingService	fulfillmentPricingService
protected OrderToPaymentRequestDTOService	orderToPaymentRequestDTOService
protected StateService	stateService

Constructor Summary

Constructors

Constructor and Description
OnePageCheckoutProcessor()

Method Summary

Methods

Modifier and Type	Method and Description
protected int	calculateNumShippableFulfillmentGroups()
protected Map<String,Object>	getNewLocalVariables(org.thymeleaf.Arguments arguments, org.thymeleaf.dom.Element element)
int	getPrecedence()
protected boolean	hasPopulatedBillingAddress(Order cart) A helper method used to determine the validity of the payments on the Order
protected boolean	hasPopulatedOrderInfo(Order cart) A helper method used to determine the validity of order info
protected boolean	hasPopulatedShippingAddress(Order cart) A helper method used to determine the validity of the fulfillment groups
protected List<String>	populateExpirationMonths() A helper method used to construct a list of Credit Card Expiration Months Useful for expiration dropdown menus.
protected List<String>	populateExpirationYears() A helper method used to construct a list of Credit Card Expiration Years Useful for expiration dropdown menus.
protected void	populateFulfillmentOptionsAndEstimationOnModel(Map<String,Object> localVars) A helper method to retrieve all fulfillment options for the cart and estimate the cost of applying fulfillment options on the first shippable fulfillment group.
protected void	populateProcessingError(Map<String,Object> localVars) This method is responsible for populating any Payment Procecessing Errors that may have been put as a Redirect Attribute when attempting to checkout.
protected void	populateSectionViewStates(Map<String,Object> localVars) This method is responsible of populating the variables necessary to draw the checkout page.
protected void	prepopulateCheckoutForms(Order cart, OrderInfoForm orderInfoForm, ShippingInfoForm shippingForm, BillingInfoForm billingForm) The Checkout page for Heat Clinic will have the shipping information pre-populated with an address if the fulfillment group has an address and fulfillment option associated with it.
protected boolean	removeHostElement(org.thymeleaf.Arguments arguments, org.thymeleaf.dom.Element element)

Methods inherited from class org.thymeleaf.processor.element.AbstractLocalVariableDefinitionElementProcessor

processElement

Methods inherited from class org.thymeleaf.processor.element.AbstractElementProcessor

doProcess, getMatcher

Methods inherited from class org.thymeleaf.processor.AbstractProcessor

compareTo, getMessage, getMessageForProcessor, getMessageForTemplate, process

Methods inherited from class java.lang.Object

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

Field Detail

stateService

protected StateService stateService

countryService

protected CountryService countryService

customerAddressService

protected CustomerAddressService customerAddressService

fulfillmentGroupService

protected FulfillmentGroupService fulfillmentGroupService

fulfillmentOptionService

protected FulfillmentOptionService fulfillmentOptionService

fulfillmentPricingService

protected FulfillmentPricingService fulfillmentPricingService

orderToPaymentRequestDTOService

protected OrderToPaymentRequestDTOService orderToPaymentRequestDTOService

Constructor Detail

OnePageCheckoutProcessor

public OnePageCheckoutProcessor()

Method Detail

getPrecedence

public int getPrecedence()

Specified by:

getPrecedence in class org.thymeleaf.processor.AbstractProcessor

removeHostElement

protected boolean removeHostElement(org.thymeleaf.Arguments arguments,
                        org.thymeleaf.dom.Element element)

Specified by:

removeHostElement in class org.thymeleaf.processor.element.AbstractLocalVariableDefinitionElementProcessor

getNewLocalVariables

protected Map<String,Object> getNewLocalVariables(org.thymeleaf.Arguments arguments,
                                      org.thymeleaf.dom.Element element)

Specified by:

getNewLocalVariables in class org.thymeleaf.processor.element.AbstractLocalVariableDefinitionElementProcessor

prepopulateCheckoutForms

protected void prepopulateCheckoutForms(Order cart,
                            OrderInfoForm orderInfoForm,
                            ShippingInfoForm shippingForm,
                            BillingInfoForm billingForm)

The Checkout page for Heat Clinic will have the shipping information pre-populated with an address if the fulfillment group has an address and fulfillment option associated with it. It also assumes that if there is only one order payment of type credit card on the order, then the billing address will be pre-populated with that payment.

calculateNumShippableFulfillmentGroups

protected int calculateNumShippableFulfillmentGroups()

populateProcessingError

protected void populateProcessingError(Map<String,Object> localVars)

This method is responsible for populating any Payment Procecessing Errors that may have been put as a Redirect Attribute when attempting to checkout.

Parameters:

localVars -

populateSectionViewStates

protected void populateSectionViewStates(Map<String,Object> localVars)

This method is responsible of populating the variables necessary to draw the checkout page. This logic is highly dependent on your layout. If your layout does not follow the same flow as the HeatClinic demo, you will need to override with your own custom layout implementation

Parameters:

localVars -

populateFulfillmentOptionsAndEstimationOnModel

protected void populateFulfillmentOptionsAndEstimationOnModel(Map<String,Object> localVars)

A helper method to retrieve all fulfillment options for the cart and estimate the cost of applying fulfillment options on the first shippable fulfillment group.

hasPopulatedOrderInfo

protected boolean hasPopulatedOrderInfo(Order cart)

A helper method used to determine the validity of order info

Parameters:

cart -

Returns:

boolean indicating whether or not the order has valid info

hasPopulatedBillingAddress

protected boolean hasPopulatedBillingAddress(Order cart)

A helper method used to determine the validity of the payments on the Order

Parameters:

cart -

Returns:

boolean indicating whether or not the CREDIT_CARD order payment on the order has an address

hasPopulatedShippingAddress

protected boolean hasPopulatedShippingAddress(Order cart)

A helper method used to determine the validity of the fulfillment groups

Parameters:

cart -

Returns:

boolean indicating whether or not the fulfillment groups on the cart have addresses.

populateExpirationMonths

protected List<String> populateExpirationMonths()

A helper method used to construct a list of Credit Card Expiration Months Useful for expiration dropdown menus. Will use locale to determine language if a locale is available.

Returns:

List containing expiration months of the form "01 - January"

populateExpirationYears

protected List<String> populateExpirationYears()

A helper method used to construct a list of Credit Card Expiration Years Useful for expiration dropdown menus.

Returns:

List of the next ten years starting with the current year.