Package com.broadleafcommerce.cartoperation.service.checkout.workflow.activity

Class CartOfferValidationActivity

java.lang.Object

com.broadleafcommerce.cartoperation.service.checkout.workflow.activity.CartOfferValidationActivity

All Implemented Interfaces:

CheckoutWorkflowActivity

public class CartOfferValidationActivity
extends Object
implements CheckoutWorkflowActivity

This CheckoutWorkflowActivity is responsible for validating that the cart's offers, offer codes, and campaign codes are still valid.

Author:

Skye Pekerti (SkyePekerti)

Constructor Summary

Constructors

Constructor	Description
CartOfferValidationActivity(ExternalOfferProvider offerProvider, CampaignProvider campaignProvider, org.springframework.context.MessageSource messageSource, CartOperationService cartService)

Method Summary

Modifier and Type	Method	Description
CheckoutProcessDto	execute(@NonNull CheckoutProcessDto processDto, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Method responsible for executing some work against the cart that is required for checkout.
protected CampaignProvider	getCampaignProvider()
protected CartOperationService	getCartService()
protected org.springframework.context.MessageSource	getMessageSource()
protected ExternalOfferProvider	getOfferProvider()
protected List<String>	getOfferRefIds(@NonNull com.broadleafcommerce.cart.client.domain.Cart cart)	Gathers the list of offer ids from the cart & cart item's adjustments
protected CartOperationServiceProperties	getProperties()
CheckoutProcessDto	rollback(@NonNull CheckoutProcessDto processDto, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Method responsible for rolling back any work that was done during the execution of the CheckoutWorkflowActivity.execute(CheckoutProcessDto, ContextInfo) method.
void	setProperties(CartOperationServiceProperties properties)
protected void	validateCampaignCodeUsages(@NonNull CheckoutProcessDto processDto, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Deprecated. Deprecated as of 1.8, if using OfferService 2.0, this method is not used
protected void	validateOfferAndOfferCodeUsages(@NonNull CheckoutProcessDto processDto, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validate that the offers and offer codes used in the specified cart are still valid upon checkout.

Methods inherited from class java.lang.Object

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

Constructor Details

CartOfferValidationActivity

public CartOfferValidationActivity(ExternalOfferProvider offerProvider,
 CampaignProvider campaignProvider,
 org.springframework.context.MessageSource messageSource,
 CartOperationService cartService)

Method Details

execute

public CheckoutProcessDto execute(@NonNull
 @NonNull CheckoutProcessDto processDto,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CheckoutWorkflowActivity

Method responsible for executing some work against the cart that is required for checkout. This may include, but is not limited to, cart validation checks, inventory reservations, or payment authorizations.

Specified by:

execute in interface CheckoutWorkflowActivity

Parameters:

processDto - The CheckoutProcessDto that we're attempting to checkout with.

contextInfo - Context information around sandbox and multitenant state.

Returns:

The final state of the CheckoutProcessDto following the execution of the activity.

rollback

public CheckoutProcessDto rollback(@NonNull
 @NonNull CheckoutProcessDto processDto,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: CheckoutWorkflowActivity

Method responsible for rolling back any work that was done during the execution of the CheckoutWorkflowActivity.execute(CheckoutProcessDto, ContextInfo) method.

Specified by:

rollback in interface CheckoutWorkflowActivity

Parameters:

processDto - The CheckoutProcessDto that we were attempting to checkout with, but ran into an exception/error.

contextInfo - Context information around sandbox and multitenant state.

Returns:

The final state of the CheckoutProcessDto following the rollback of the activity.

validateOfferAndOfferCodeUsages

protected void validateOfferAndOfferCodeUsages(@NonNull
 @NonNull CheckoutProcessDto processDto,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Validate that the offers and offer codes used in the specified cart are still valid upon checkout.

Parameters:

processDto - the CheckoutProcessDto that we're attempting to checkout with.

contextInfo - context surrounding sandboxing and multitenant state

getOfferRefIds

protected List<String> getOfferRefIds(@NonNull
 @NonNull com.broadleafcommerce.cart.client.domain.Cart cart)

Gathers the list of offer ids from the cart & cart item's adjustments

Parameters:

cart - the cart that is being validated

Returns:

the list of offer ids from the cart & cart item's adjustments

validateCampaignCodeUsages

@Deprecated
protected void validateCampaignCodeUsages(@NonNull
 @NonNull CheckoutProcessDto processDto,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Deprecated.

Deprecated as of 1.8, if using OfferService 2.0, this method is not used

Validate that the campaign codes used in the specified cart are still valid upon checkout.

Parameters:

processDto - the CheckoutProcessDto that we're attempting to checkout with.

contextInfo - context surrounding sandboxing and multitenant state

getOfferProvider

protected ExternalOfferProvider getOfferProvider()

getCampaignProvider

@Nullable
protected CampaignProvider getCampaignProvider()

getMessageSource

protected org.springframework.context.MessageSource getMessageSource()

getCartService

protected CartOperationService getCartService()

getProperties

protected CartOperationServiceProperties getProperties()

setProperties

@Autowired
public void setProperties(CartOperationServiceProperties properties)