Uses of Class
com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Packages that use ModifySubscriptionRequest

Package	Description
com.broadleafcommerce.subscriptionoperation.service
com.broadleafcommerce.subscriptionoperation.service.exception
com.broadleafcommerce.subscriptionoperation.service.modification
com.broadleafcommerce.subscriptionoperation.web.endpoint

Uses of ModifySubscriptionRequest in com.broadleafcommerce.subscriptionoperation.service

Methods in com.broadleafcommerce.subscriptionoperation.service with parameters of type ModifySubscriptionRequest

Modifier and Type	Method	Description
ModifySubscriptionResponse	DefaultSubscriptionOperationService.modifySubscription(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
ModifySubscriptionResponse	SubscriptionOperationService.modifySubscription(ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Handles modifying Subscriptions based on the allowed actions.

Uses of ModifySubscriptionRequest in com.broadleafcommerce.subscriptionoperation.service.exception

Methods in com.broadleafcommerce.subscriptionoperation.service.exception that return ModifySubscriptionRequest

Modifier and Type	Method	Description
ModifySubscriptionRequest	UnsupportedSubscriptionModificationRequestException.getRequest()

Constructors in com.broadleafcommerce.subscriptionoperation.service.exception with parameters of type ModifySubscriptionRequest

Modifier	Constructor	Description
	UnsupportedSubscriptionModificationRequestException(@NonNull ModifySubscriptionRequest request)

Uses of ModifySubscriptionRequest in com.broadleafcommerce.subscriptionoperation.service.modification

Methods in com.broadleafcommerce.subscriptionoperation.service.modification with parameters of type ModifySubscriptionRequest

Modifier and Type	Method	Description
protected AddItemRequest	AbstractModifySubscriptionHandler.buildAddItemRequest(@NonNull SubscriptionItem subscriptionItem, @NonNull Subscription subscription, @NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds an AddItemRequest from the given subscriptionItem, subscription and the flowName
protected AddItemRequest	InitiateCancelSubscriptionHandler.buildAddItemRequest(@NonNull SubscriptionItem subscriptionItem, @NonNull Subscription subscription, @NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected List<AddItemRequest>	InitiateCancelSubscriptionHandler.buildAddItemRequestsForCancellationFeeProducts(@NonNull ModifySubscriptionRequest request)	Builds a List of AddItemRequest for products containing cancellation-fees.
protected CreateCartRequest	AbstractGradeChangeSubscriptionModificationHandler.buildCreateCartRequest(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected CreateCartRequest	AbstractModifySubscriptionHandler.buildCreateCartRequest(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected CreateCartRequest	InitiateCancelSubscriptionHandler.buildCreateCartRequest(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds a CreateCartRequest from the ModifySubscriptionRequest
protected CreateCartRequest	InitiateEditSubscriptionHandler.buildCreateCartRequest(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds a CreateCartRequest from the ModifySubscriptionRequest
protected <I extends PendingSubscriptionItemAdjustmentRemoval> List<I>	InitiateCancelSubscriptionHandler.buildPendingSubscriptionItemAdjustmentRemovalDetails(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds a list of SubscriptionItemAdjustmentToRemoves representing details of the subscription item adjustments that will be removed as a result of the subscription cancellation.
protected AddItemRequest	AbstractGradeChangeSubscriptionModificationHandler.buildRootItemRequestWithDependents(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds a AddItemRequest for the root upgrade/downgrade item.
boolean	ChangeSubscriptionAutoRenewalHandler.canHandle(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
boolean	InitiateCancelSubscriptionHandler.canHandle(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
boolean	InitiateDowngradeSubscriptionHandler.canHandle(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
boolean	InitiateEditSubscriptionHandler.canHandle(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
boolean	InitiateUpgradeSubscriptionHandler.canHandle(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
boolean	ModifySubscriptionHandler.canHandle(ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines whether the handler can handle the ModifySubscriptionRequest.
protected abstract String[]	AbstractModifySubscriptionHandler.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 String[]	ChangeSubscriptionAutoRenewalHandler.getRequiredPermissions(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected String[]	InitiateCancelSubscriptionHandler.getRequiredPermissions(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected String[]	InitiateDowngradeSubscriptionHandler.getRequiredPermissions(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected String[]	InitiateEditSubscriptionHandler.getRequiredPermissions(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected String[]	InitiateUpgradeSubscriptionHandler.getRequiredPermissions(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
ModifySubscriptionResponse	AbstractModifySubscriptionHandler.handle(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
ModifySubscriptionResponse	ModifySubscriptionHandler.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.
protected ModifySubscriptionResponse	AbstractGradeChangeSubscriptionModificationHandler.handleInternal(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected abstract ModifySubscriptionResponse	AbstractModifySubscriptionHandler.handleInternal(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hookpoint for custom logic specific to a particular modification request.
protected ModifySubscriptionResponse	ChangeSubscriptionAutoRenewalHandler.handleInternal(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected ModifySubscriptionResponse	InitiateCancelSubscriptionHandler.handleInternal(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected ModifySubscriptionResponse	InitiateEditSubscriptionHandler.handleInternal(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	AbstractGradeChangeSubscriptionModificationHandler.hydrateAdditionalContextOntoRequest(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	AbstractModifySubscriptionHandler.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	InitiateCancelSubscriptionHandler.hydrateAdditionalContextOntoRequest(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	InitiateEditSubscriptionHandler.hydrateAdditionalContextOntoRequest(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	AbstractModifySubscriptionHandler.hydrateProductsAndItemChoices(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	AbstractGradeChangeSubscriptionModificationHandler.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	InitiateDowngradeSubscriptionHandler.isCurrentDateBeyondDowngradeAvailabilityDuration(@NonNull ModifySubscriptionRequest request)	Determines whether the current time is beyond the period start date + restrictDowngradeAfterDays.
protected void	AbstractModifySubscriptionHandler.populateCartAttributesOnCreateCartRequest(@NonNull ModifySubscriptionRequest request, @NonNull CreateCartRequest createCartRequest)	Stores additional values in CreateCartRequest.getCartAttributes() that would be used in downstream flows.
protected void	InitiateCancelSubscriptionHandler.populateCartAttributesOnCreateCartRequest(@NonNull ModifySubscriptionRequest request, @NonNull CreateCartRequest createCartRequest)	Stores additional values in CreateCartRequest.getCartAttributes() that would be used in downstream flows.
protected SubscriptionReferencedItem	AbstractGradeChangeSubscriptionModificationHandler.readNewItemReferenced(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieves the new item to upgrade/downgrade to.
protected SubscriptionReferencedItem	AbstractGradeChangeSubscriptionModificationHandler.readNewSubscriptionItemOfCustomType(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hookpoint for custom item ref types.
protected void	InitiateCancelSubscriptionHandler.setNonCatalogItemDetailsOnCancelItem(@NonNull ModifySubscriptionRequest request, @NonNull AddItemRequest cancelItem)	Sets the NonCatalogItemDetails on the cancelItem
protected boolean	ChangeSubscriptionAutoRenewalHandler.shouldStartChangeAutoRenewalWorkflow(@NonNull ModifySubscriptionRequest request, @NonNull Subscription subscription)
protected Subscription	ChangeSubscriptionAutoRenewalHandler.updateSubscriptionAutoRenewal(@NonNull ModifySubscriptionRequest request, @NonNull Subscription subscription, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	AbstractModifySubscriptionHandler.validateActionType(@NonNull ModifySubscriptionRequest request, @NonNull org.springframework.validation.Errors errors, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the requested action against the resolved subscription's available actions.
protected void	AbstractModifySubscriptionHandler.validateAdditionalPermissionRules(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Hook point to supply additional permission validation logic.
protected void	ChangeSubscriptionAutoRenewalHandler.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	ChangeSubscriptionAutoRenewalHandler.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	AbstractModifySubscriptionHandler.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.
protected void	ChangeSubscriptionAutoRenewalHandler.validateBusinessRules(@NonNull ModifySubscriptionRequest request, @NonNull org.springframework.validation.Errors errors, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	InitiateCancelSubscriptionHandler.validateBusinessRules(@NonNull ModifySubscriptionRequest request, @NonNull org.springframework.validation.Errors errors, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	InitiateDowngradeSubscriptionHandler.validateBusinessRules(@NonNull ModifySubscriptionRequest request, @NonNull org.springframework.validation.Errors errors, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	InitiateEditSubscriptionHandler.validateBusinessRules(@NonNull ModifySubscriptionRequest request, @NonNull org.springframework.validation.Errors errors, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	InitiateUpgradeSubscriptionHandler.validateBusinessRules(@NonNull ModifySubscriptionRequest request, @NonNull org.springframework.validation.Errors errors, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	AbstractModifySubscriptionHandler.validateCurrentSubscriptionState(@NonNull ModifySubscriptionRequest request, @NonNull org.springframework.validation.Errors errors, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the current state of the subscription before allowing modification.
protected void	AbstractModifySubscriptionHandler.validateRequest(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the request to modify the subscription.
protected void	AbstractModifySubscriptionHandler.validateUserAccessToSubscription(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Validates the user's access to the subscription.

Uses of ModifySubscriptionRequest in com.broadleafcommerce.subscriptionoperation.web.endpoint

Methods in com.broadleafcommerce.subscriptionoperation.web.endpoint with parameters of type ModifySubscriptionRequest

Modifier and Type	Method	Description
ModifySubscriptionResponse	AccountSubscriptionOperationEndpoint.modifySubscription(String accountId, String subscriptionId, ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
ModifySubscriptionResponse	CustomerSubscriptionOperationEndpoint.modifySubscription(String customerId, String subscriptionId, ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
ModifySubscriptionResponse	SubscriptionOperationEndpoint.modifySubscription(String subscriptionId, ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)