Package com.broadleafcommerce.subscriptionoperation.service.modification

Class InitiateDowngradeSubscriptionHandler

java.lang.Object

com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

com.broadleafcommerce.subscriptionoperation.service.modification.InitiateDowngradeSubscriptionHandler

All Implemented Interfaces:

ModifySubscriptionHandler

public class InitiateDowngradeSubscriptionHandler
extends AbstractGradeChangeSubscriptionModificationHandler
implements ModifySubscriptionHandler

Handles downgrading a Subscription.

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor	Description
InitiateDowngradeSubscriptionHandler(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
boolean	canHandle(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines whether the handler can handle the ModifySubscriptionRequest.
protected String	getFlowName()	Produces the name of the modification flow.
protected com.broadleafcommerce.data.tracking.core.policy.trackable.TrackablePolicyUtils	getPolicyUtils()
protected String[]	getRequiredPermissions(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hook point to supply the permissions required to perform the given SubscriptionAction.
protected boolean	isCurrentDateBeyondDowngradeAvailabilityDuration(@NonNull ModifySubscriptionRequest request)	Determines whether the current time is beyond the period start date + restrictDowngradeAfterDays.
void	setPolicyUtils(com.broadleafcommerce.data.tracking.core.policy.trackable.TrackablePolicyUtils policyUtils)
protected void	validateBusinessRules(@NonNull ModifySubscriptionRequest request, @NonNull org.springframework.validation.Errors errors, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hook point to supply custom business rules for specific action types.

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

buildAddItemRequestForAddOn, buildCreateCartRequest, buildRootItemRequestWithDependents, determineItemQuantity, getCartOperationProvider, getCatalogProvider, getDependentItems, getDependentItemsCustom, handleInternal, hydrateAdditionalContextOntoRequest, hydrateSubscriptionReferencedItems, isRequiredAddOn, populateDefaultProductAndOrVariantId, readNewItemReferenced, readNewSubscriptionItemOfCustomType

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

addDependentsToParents, buildAddItemRequest, buildPriceCartRequest, generateCartName, getChildOptions, getSubscriptionModificationUtils, getTypeFactory, handle, hydrateProductsAndItemChoices, populateCartAttributesOnCreateCartRequest, validateActionType, validateAdditionalPermissionRules, 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

handle

Constructor Details

InitiateDowngradeSubscriptionHandler

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

Method Details

canHandle

public boolean canHandle(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: ModifySubscriptionHandler

Determines whether the handler can handle the ModifySubscriptionRequest.

Specified by:

canHandle in interface ModifySubscriptionHandler

Parameters:

request - The incoming request to modify a Subscription

contextInfo - Additional sandbox and multitenant info

Returns:

Whether this handler can handle the ModifySubscriptionRequest.

getRequiredPermissions

protected String[] getRequiredPermissions(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from class: AbstractModifySubscriptionHandler

Hook point to supply the permissions required to perform the given SubscriptionAction. These may be different depending on the type of user requesting the modification.

Specified by:

getRequiredPermissions in class AbstractModifySubscriptionHandler

Parameters:

request - The ModifySubscriptionRequest with the details related to the modification to make.

contextInfo - the current sandbox and multitenant context

Returns:

The required permissions for the requester to perform the modification.

validateBusinessRules

protected void validateBusinessRules(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @NonNull
 @NonNull org.springframework.validation.Errors errors,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from class: AbstractModifySubscriptionHandler

Hook point to supply custom business rules for specific action types. Called by AbstractModifySubscriptionHandler.validateRequest(ModifySubscriptionRequest, ContextInfo).

Overrides:

validateBusinessRules in class AbstractModifySubscriptionHandler

Parameters:

request - The ModifySubscriptionRequest with the details related to the modification to make.

errors - Object storing validation errors for the `request`

contextInfo - the current sandbox and multitenant context

getFlowName

protected String getFlowName()

Description copied from class: AbstractModifySubscriptionHandler

Produces the name of the modification flow.

Specified by:

getFlowName in class AbstractModifySubscriptionHandler

Returns:

The name of the modification flow.

See Also:

• DefaultSubscriptionActionFlow

isCurrentDateBeyondDowngradeAvailabilityDuration

protected boolean isCurrentDateBeyondDowngradeAvailabilityDuration(@NonNull
 @NonNull ModifySubscriptionRequest request)

Determines whether the current time is beyond the period start date + restrictDowngradeAfterDays.

Parameters:

request - the ModifySubscriptionRequest

Returns:

whether the current time is beyond the period start date + restrictDowngradeAfterDays.

getPolicyUtils

@Nullable
protected com.broadleafcommerce.data.tracking.core.policy.trackable.TrackablePolicyUtils getPolicyUtils()

Specified by:

getPolicyUtils in class AbstractModifySubscriptionHandler

setPolicyUtils

@Autowired(required=false)
public void setPolicyUtils(com.broadleafcommerce.data.tracking.core.policy.trackable.TrackablePolicyUtils policyUtils)