Package com.broadleafcommerce.subscriptionoperation.service.modification

Class ChangeSubscriptionAutoRenewalHandler

java.lang.Object

com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

All Implemented Interfaces:

ModifySubscriptionHandler

public class ChangeSubscriptionAutoRenewalHandler
extends AbstractModifySubscriptionHandler
implements ModifySubscriptionHandler

Handles change whether auto-renewal is enabled for a Subscription.

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor	Description
ChangeSubscriptionAutoRenewalHandler(com.broadleafcommerce.common.extension.TypeFactory typeFactory, SubscriptionModificationUtils subscriptionModificationUtils, SubscriptionProvider<SubscriptionWithItems,Subscription,SubscriptionOwnerInfo> subscriptionProvider, org.springframework.context.MessageSource messageSource)

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 org.springframework.context.MessageSource	getMessageSource()
protected Date	getNextStatusChangeDate(@NonNull Subscription subscription)
protected com.broadleafcommerce.data.tracking.core.policy.trackable.TrackablePolicyUtils	getPolicyUtils()
protected SubscriptionCancellationProperties	getProperties()
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 StartChangeAutoRenewalWorkflowService	getStartChangeAutoRenewalWorkflowService()
protected SubscriptionOperationService<SubscriptionWithItems>	getSubOpsService()
protected SubscriptionProvider<SubscriptionWithItems,Subscription,SubscriptionOwnerInfo>	getSubscriptionProvider()
protected ModifySubscriptionResponse	handleInternal(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hookpoint for custom logic specific to a particular modification request.
void	setPolicyUtils(com.broadleafcommerce.data.tracking.core.policy.trackable.TrackablePolicyUtils policyUtils)
void	setProperties(SubscriptionCancellationProperties properties)
void	setStartChangeAutoRenewalWorkflowService(StartChangeAutoRenewalWorkflowService startChangeAutoRenewalWorkflowService)
void	setSubOpsService(SubscriptionOperationService<SubscriptionWithItems> subOpsService)
protected boolean	shouldStartChangeAutoRenewalWorkflow(@NonNull ModifySubscriptionRequest request, @NonNull Subscription subscription)
protected Subscription	updateSubscriptionAutoRenewal(@NonNull ModifySubscriptionRequest request, @NonNull Subscription subscription, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	validateAutoRenewalCanBeDisabled(@NonNull ModifySubscriptionRequest request, @NonNull SubscriptionWithItems swi, @NonNull org.springframework.validation.Errors errors, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates whether auto-renewal can be disabled for a Subscription.
protected void	validateAutoRenewalCanBeEnabled(@NonNull ModifySubscriptionRequest request, @NonNull SubscriptionWithItems swi, @NonNull org.springframework.validation.Errors errors, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates whether auto-renewal can be enabled for a Subscription.
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, buildCreateCartRequest, buildPriceCartRequest, generateCartName, getChildOptions, getSubscriptionModificationUtils, getTypeFactory, handle, hydrateAdditionalContextOntoRequest, 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

ChangeSubscriptionAutoRenewalHandler

public ChangeSubscriptionAutoRenewalHandler(com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 SubscriptionModificationUtils subscriptionModificationUtils,
 SubscriptionProvider<SubscriptionWithItems,Subscription,SubscriptionOwnerInfo> subscriptionProvider,
 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.

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)

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

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.

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

validateAutoRenewalCanBeEnabled

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

Validates whether auto-renewal can be enabled for a Subscription.

Parameters:

request - the ModifySubscriptionRequest being processed

swi - the SubscriptionWithItems being enabled

errors - the Errors object to add validation errors to

contextInfo - the current sandbox and multitenant context

validateAutoRenewalCanBeDisabled

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

Validates whether auto-renewal can be disabled for a Subscription.

Parameters:

request - the ModifySubscriptionRequest being processed

swi - the SubscriptionWithItems being disabled

errors - the Errors object to add validation errors to

contextInfo - the current sandbox and multitenant context

updateSubscriptionAutoRenewal

protected Subscription updateSubscriptionAutoRenewal(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @NonNull
 @NonNull Subscription subscription,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getNextStatusChangeDate

protected Date getNextStatusChangeDate(@NonNull
 @NonNull Subscription subscription)

shouldStartChangeAutoRenewalWorkflow

protected boolean shouldStartChangeAutoRenewalWorkflow(@NonNull
 @NonNull ModifySubscriptionRequest request,
 @NonNull
 @NonNull Subscription subscription)

getSubscriptionProvider

protected SubscriptionProvider<SubscriptionWithItems,Subscription,SubscriptionOwnerInfo> getSubscriptionProvider()

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)

getSubOpsService

protected SubscriptionOperationService<SubscriptionWithItems> getSubOpsService()

setSubOpsService

@Autowired
@Lazy
public void setSubOpsService(SubscriptionOperationService<SubscriptionWithItems> subOpsService)

getProperties

protected SubscriptionCancellationProperties getProperties()

setProperties

@Autowired
public void setProperties(SubscriptionCancellationProperties properties)

setStartChangeAutoRenewalWorkflowService

@Autowired(required=false)
public void setStartChangeAutoRenewalWorkflowService(@Nullable
 StartChangeAutoRenewalWorkflowService startChangeAutoRenewalWorkflowService)

getStartChangeAutoRenewalWorkflowService

@Nullable
protected StartChangeAutoRenewalWorkflowService getStartChangeAutoRenewalWorkflowService()