Package com.broadleafcommerce.subscriptionoperation.service.modification

Class InitiateEditSubscriptionHandler

java.lang.Object

com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

All Implemented Interfaces:

ModifySubscriptionHandler

public class InitiateEditSubscriptionHandler
extends AbstractModifySubscriptionHandler
implements ModifySubscriptionHandler

Handles initiating the edit-Subscription flow.

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor	Description
InitiateEditSubscriptionHandler(com.broadleafcommerce.common.extension.TypeFactory typeFactory, SubscriptionModificationUtils subscriptionModificationUtils, CartOperationProvider<com.broadleafcommerce.cart.client.domain.Cart> cartOperationProvider, CatalogProvider<Product> catalogProvider, org.springframework.context.MessageSource messageSource)

Method Summary

Modifier and Type	Method	Description
protected CreateCartRequest	buildCreateCartRequest(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds a CreateCartRequest from the ModifySubscriptionRequest
boolean	canHandle(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines whether the handler can handle the ModifySubscriptionRequest.
protected CartOperationProvider<com.broadleafcommerce.cart.client.domain.Cart>	getCartOperationProvider()
protected CatalogProvider<Product>	getCatalogProvider()
protected String	getFlowName()	Produces the name of the modification flow.
protected org.springframework.context.MessageSource	getMessageSource()
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 ModifySubscriptionResponse	handleInternal(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hookpoint for custom logic specific to a particular modification request.
protected boolean	hasDelayedDowngradeDueAtEndOfCurrentPeriod(@NonNull Subscription subscription)
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.
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.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

InitiateEditSubscriptionHandler

public InitiateEditSubscriptionHandler(com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 SubscriptionModificationUtils subscriptionModificationUtils,
 CartOperationProvider<com.broadleafcommerce.cart.client.domain.Cart> cartOperationProvider,
 CatalogProvider<Product> catalogProvider,
 org.springframework.context.MessageSource messageSource)

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.

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.

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)

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

buildCreateCartRequest

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

Builds a CreateCartRequest from the ModifySubscriptionRequest

Overrides:

buildCreateCartRequest in class AbstractModifySubscriptionHandler

Parameters:

request - the ModifySubscriptionRequest to hydrate

contextInfo - the contextInfo

Returns:

the CreateCartRequest

hasDelayedDowngradeDueAtEndOfCurrentPeriod

protected boolean hasDelayedDowngradeDueAtEndOfCurrentPeriod(@NonNull
 @NonNull Subscription subscription)

getCartOperationProvider

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

getCatalogProvider

protected CatalogProvider<Product> getCatalogProvider()

getMessageSource

protected org.springframework.context.MessageSource getMessageSource()

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)