Package com.broadleafcommerce.subscriptionoperation.service.modification

Class AbstractGradeChangeSubscriptionModificationHandler

java.lang.Object

com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

All Implemented Interfaces:

ModifySubscriptionHandler

Direct Known Subclasses:

InitiateDowngradeSubscriptionHandler, InitiateUpgradeSubscriptionHandler

public abstract class AbstractGradeChangeSubscriptionModificationHandler
extends AbstractModifySubscriptionHandler

Common parent for InitiateUpgradeSubscriptionHandler and InitiateDowngradeSubscriptionHandler.

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor	Description
AbstractGradeChangeSubscriptionModificationHandler(com.broadleafcommerce.common.extension.TypeFactory typeFactory, SubscriptionModificationUtils subscriptionModificationUtils, CatalogProvider<Product> catalogProvider, CartOperationProvider<com.broadleafcommerce.cart.client.domain.Cart> cartOperationProvider)

Method Summary

Modifier and Type	Method	Description
protected Optional<AddItemRequest>	buildAddItemRequestForAddOn(@NonNull ProductOption addOnOption, @NonNull Subscription subscription, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds a AddItemRequest for any relevant add-ons.
protected CreateCartRequest	buildCreateCartRequest(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected AddItemRequest	buildRootItemRequestWithDependents(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds a AddItemRequest for the root upgrade/downgrade item.
protected int	determineItemQuantity(SubscriptionReferencedItem nextItem, int existingItemQuantity)	Determines the quantity of the SubscriptionReferencedItem to be upgraded or downgraded to based on its min and max thresholds and the existing SubscriptionItem's quantity.
protected CartOperationProvider<com.broadleafcommerce.cart.client.domain.Cart>	getCartOperationProvider()
protected CatalogProvider<Product>	getCatalogProvider()
protected List<AddItemRequest>	getDependentItems(@NonNull SubscriptionReferencedItem nextRootItem, @NonNull Subscription subscription, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets a list of all the required add-ons (dependentCartItems) for the current product.
protected List<AddItemRequest>	getDependentItemsCustom(@NonNull SubscriptionReferencedItem nextRootItem, @NonNull Subscription subscription)	Custom implementation for non-BroadleafProduct instances.
protected ModifySubscriptionResponse	handleInternal(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hookpoint for custom logic specific to a particular modification request.
protected void	hydrateAdditionalContextOntoRequest(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Handles hydrating any additional contextual information onto the ModifySubscriptionRequest that the handler needs.
protected void	hydrateSubscriptionReferencedItems(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hydrate the root item and item to upgrade/downgrade to onto the ModifySubscriptionRequest.
protected boolean	isRequiredAddOn(@NonNull ItemChoice itemChoice)	Determines if the current addOn is a required add-on.
protected void	populateDefaultProductAndOrVariantId(@NonNull ItemChoice itemChoice, @NonNull AddItemRequest addOnRequest)	Populates AddItemRequest.getProductId() and, if applicable, AddItemRequest.getVariantId() based on the type of ItemChoice.
protected SubscriptionReferencedItem	readNewItemReferenced(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieves the new item to upgrade/downgrade to.
protected SubscriptionReferencedItem	readNewSubscriptionItemOfCustomType(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hookpoint for custom item ref types.

Methods inherited from class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

addDependentsToParents, buildAddItemRequest, buildPriceCartRequest, generateCartName, getChildOptions, getFlowName, getPolicyUtils, getRequiredPermissions, getSubscriptionModificationUtils, getTypeFactory, handle, hydrateProductsAndItemChoices, populateCartAttributesOnCreateCartRequest, validateActionType, validateAdditionalPermissionRules, validateBusinessRules, validateCurrentSubscriptionState, validateRequest, validateUserAccessToSubscription

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.subscriptionoperation.service.modification.ModifySubscriptionHandler

canHandle

Constructor Details

AbstractGradeChangeSubscriptionModificationHandler

public AbstractGradeChangeSubscriptionModificationHandler(com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 SubscriptionModificationUtils subscriptionModificationUtils,
 CatalogProvider<Product> catalogProvider,
 CartOperationProvider<com.broadleafcommerce.cart.client.domain.Cart> cartOperationProvider)

Method Details

handleInternal

protected ModifySubscriptionResponse handleInternal(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from class: AbstractModifySubscriptionHandler

Hookpoint for custom logic specific to a particular modification request.

Specified by:

handleInternal in class AbstractModifySubscriptionHandler

Parameters:

request - The incoming request to modify a Subscription

contextInfo - Additional sandbox and multitenant info

Returns:

Whether this handler can handle the ModifySubscriptionRequest.

See Also:

• AbstractModifySubscriptionHandler.handle(ModifySubscriptionRequest, ContextInfo)

hydrateAdditionalContextOntoRequest

protected void hydrateAdditionalContextOntoRequest(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from class: AbstractModifySubscriptionHandler

Handles hydrating any additional contextual information onto the ModifySubscriptionRequest that the handler needs. By default, this does nothing.

Overrides:

hydrateAdditionalContextOntoRequest in class AbstractModifySubscriptionHandler

Parameters:

request - The ModifySubscriptionRequest to hydrate.

contextInfo - Additional sandbox and multitenant info.

buildCreateCartRequest

protected CreateCartRequest buildCreateCartRequest(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Overrides:

buildCreateCartRequest in class AbstractModifySubscriptionHandler

hydrateSubscriptionReferencedItems

protected void hydrateSubscriptionReferencedItems(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Hydrate the root item and item to upgrade/downgrade to onto the ModifySubscriptionRequest.

Parameters:

request - The ModifySubscriptionRequest to hydrate.

contextInfo - Additional sandbox and multitenant info.

See Also:

• hydrateAdditionalContextOntoRequest(ModifySubscriptionRequest, ContextInfo)

readNewItemReferenced

protected SubscriptionReferencedItem readNewItemReferenced(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Retrieves the new item to upgrade/downgrade to.

Parameters:

request - The ModifySubscriptionRequest to hydrate.

contextInfo - Additional sandbox and multitenant info.

Returns:

The new item to upgrade/downgrade to.

See Also:

• hydrateSubscriptionReferencedItems(ModifySubscriptionRequest, ContextInfo)
• readNewSubscriptionItemOfCustomType(ModifySubscriptionRequest, ContextInfo)

readNewSubscriptionItemOfCustomType

protected SubscriptionReferencedItem readNewSubscriptionItemOfCustomType(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Hookpoint for custom item ref types. If the item to upgrade/downgrade to is not a default Broadleaf type, then this method will be invoked to provide it.

Parameters:

request - The ModifySubscriptionRequest to hydrate.

contextInfo - Additional sandbox and multitenant info.

Returns:

The new item to upgrade/downgrade to.

See Also:

• readNewItemReferenced(ModifySubscriptionRequest, ContextInfo)

buildRootItemRequestWithDependents

protected AddItemRequest buildRootItemRequestWithDependents(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds a AddItemRequest for the root upgrade/downgrade item.

If the new product to upgrade/downgrade to has a required add-on, an AddItemRequest is created for the add-on too.

Parameters:

request - The ModifySubscriptionRequest to hydrate. * @param contextInfo Additional sandbox and multitenant info.

contextInfo - Additional sandbox and multitenant info.

Returns:

The AddItemRequest for the new product to upgrade/downgrade to.

determineItemQuantity

protected int determineItemQuantity(SubscriptionReferencedItem nextItem,
 int existingItemQuantity)

Determines the quantity of the SubscriptionReferencedItem to be upgraded or downgraded to based on its min and max thresholds and the existing SubscriptionItem's quantity.

Parameters:

nextItem - The SubscriptionReferencedItem to be upgraded or downgraded to

existingItemQuantity - The existing SubscriptionItem's quantity.

Returns:

The quantity to use for the AddItemRequest.

getDependentItems

protected List<AddItemRequest> getDependentItems(@NonNull
 @NonNull SubscriptionReferencedItem nextRootItem,
 @NonNull
 @NonNull Subscription subscription,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Gets a list of all the required add-ons (dependentCartItems) for the current product.

Parameters:

nextRootItem - The new product to upgrade/downgrade to.

subscription - The current subscription

Returns:

A list of all the required add-ons (dependentCartItems) for the current product.

buildAddItemRequestForAddOn

protected Optional<AddItemRequest> buildAddItemRequestForAddOn(@NonNull
 @NonNull ProductOption addOnOption,
 @NonNull
 @NonNull Subscription subscription,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds a AddItemRequest for any relevant add-ons. By default, this only creates requests for required add-ons.

In Broadleaf, an add-on is represented by a ProductOption of type DefaultProductOptionType.ITEM_CHOICE.

Parameters:

addOnOption - A ProductOption of type DefaultProductOptionType.ITEM_CHOICE.

subscription - The existing Subscription.

Returns:

An AddItemRequest for the add-on.

See Also:

• populateDefaultProductAndOrVariantId(ItemChoice, AddItemRequest)

isRequiredAddOn

protected boolean isRequiredAddOn(@NonNull
 @NonNull ItemChoice itemChoice)

Determines if the current addOn is a required add-on.

Parameters:

itemChoice - The addOn product to be checked if it is required.

Returns:

true if the product is a required add-on otherwise false.

getDependentItemsCustom

protected List<AddItemRequest> getDependentItemsCustom(@NonNull
 @NonNull SubscriptionReferencedItem nextRootItem,
 @NonNull
 @NonNull Subscription subscription)

Custom implementation for non-BroadleafProduct instances.

Parameters:

nextRootItem - The product to upgrade/downgrade to.

subscription - The current subscription

Returns:

A list of addItemRequests for the new product to upgrade/downgrade to.

See Also:

• getDependentItems(SubscriptionReferencedItem, Subscription, ContextInfo)

populateDefaultProductAndOrVariantId

protected void populateDefaultProductAndOrVariantId(@NonNull
 @NonNull ItemChoice itemChoice,
 @NonNull
 @NonNull AddItemRequest addOnRequest)

Populates AddItemRequest.getProductId() and, if applicable, AddItemRequest.getVariantId() based on the type of ItemChoice.

Parameters:

itemChoice - ItemChoice to derive the AddItemRequest properties.

addOnRequest - AddItemRequest to populate

See Also:

• DefaultItemChoiceTargetType
• buildAddItemRequestForAddOn(ProductOption, Subscription, ContextInfo)

getCatalogProvider

protected CatalogProvider<Product> getCatalogProvider()

getCartOperationProvider

protected CartOperationProvider<com.broadleafcommerce.cart.client.domain.Cart> getCartOperationProvider()