Package com.broadleafcommerce.subscriptionoperation.service.modification

Interface ModifySubscriptionHandler

All Known Implementing Classes:

AbstractGradeChangeSubscriptionModificationHandler, AbstractModifySubscriptionHandler, ChangeSubscriptionAutoRenewalHandler, InitiateCancelSubscriptionHandler, InitiateDowngradeSubscriptionHandler, InitiateEditSubscriptionHandler, InitiateUpgradeSubscriptionHandler

public interface ModifySubscriptionHandler

Represents a component responsible for handling business logic related to some type of modification performed upon a Subscription such as upgrade, downgrade, cancel, etc. Each handler should handle a discrete action, see DefaultSubscriptionActionType.

Author:

Nathan Moore (nathandmoore)

See Also:

• DefaultSubscriptionActionType
• SubscriptionOperationService.modifySubscription(ModifySubscriptionRequest, ContextInfo)

Method Summary

Modifier and Type	Method	Description
boolean	canHandle(ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines whether the handler can handle the ModifySubscriptionRequest.
ModifySubscriptionResponse	handle(ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Handles the actual modification process for the ModifySubscriptionRequest, including validating the request payload and the user's permission.

Method Details

canHandle

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

Determines whether the handler can handle the ModifySubscriptionRequest.

Parameters:

request - The incoming request to modify a Subscription

contextInfo - Additional sandbox and multitenant info

Returns:

Whether this handler can handle the ModifySubscriptionRequest.

handle

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

Handles the actual modification process for the ModifySubscriptionRequest, including validating the request payload and the user's permission.

Parameters:

request - The incoming request to modify a Subscription

contextInfo - Additional sandbox and multitenant info

Returns:

The ModifySubscriptionResponse that results from the modification.

Throws:

InsufficientSubscriptionAccessException - if the user does not have access to the subscription

com.broadleafcommerce.common.error.validation.ValidationException - if the request is invalid due to missing or incorrect data