Package com.broadleafcommerce.subscriptionoperation.service

Class DefaultSubscriptionOperationService<SWI extends SubscriptionWithItems>

java.lang.Object

com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService<SWI>

All Implemented Interfaces:

SubscriptionOperationService<SWI>

public class DefaultSubscriptionOperationService<SWI extends SubscriptionWithItems>
extends Object
implements SubscriptionOperationService<SWI>

Constructor Summary

Constructors

Constructor

Description

DefaultSubscriptionOperationService(SubscriptionProvider<SWI,Subscription,SubscriptionOwnerInfo> subscriptionProvider, SubscriptionValidationService subscriptionValidationService, com.broadleafcommerce.common.extension.TypeFactory typeFactory, List<ModifySubscriptionHandler> modifySubscriptionHandlers, CatalogProvider<Product> catalogProvider, CancellationPolicyProvider<CancellationPolicy> cancellationPolicyProvider, SubscriptionGenerationService<SWI> subscriptionGenerationService, SubscriptionOperationUtils subscriptionOperationUtils, com.broadleafcommerce.orchestration.service.provider.external.WorkflowProvider workflowProvider, SubscriptionOperationServiceProperties subOpsServiceProperties, org.springframework.context.MessageSource messageSource)

Method Summary

Modifier and Type	Method	Description
void	addAdjustment(@NonNull AddAdjustmentRequest addAdjustmentRequest, String subscriptionId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Adds the requested adjustments onto the Subscription that matches the passed ID.
protected void	addUnavailableAction(SWI swi, @NonNull String actionType, @NonNull String reasonMessagePath)
protected Map<String,String>	buildAddAdjustmentWorkflowContext(@NonNull String subscriptionId, @NonNull LockStatus lockStatus, @NonNull AddAdjustmentRequest addAdjustmentRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds the context for the DefaultWorkflowNameConstants.SUBSCRIPTION_CSR_ADD_ADJUSTMENT_WORKFLOW workflow.
protected SubscriptionAction	buildAvailableAction(SWI subscription, @NonNull String actionType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Creates a SubscriptionAction for the actionType and SubscriptionWithItems representing an action that may be taken against the subscription.
protected Map<String,ItemChoice>	buildItemChoiceByChoiceKey(@NonNull Product product, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds a map of choice keys to item choices for all options on the product, including child options.
protected Subscription	buildSubscription(@NonNull SubscriptionCreationRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected List<SubscriptionItem>	buildSubscriptionItems(@NonNull SubscriptionCreationRequest creationRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected SWI	buildSubscriptionWithItems(@NonNull SubscriptionCreationRequest creationRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected Map<String,String>	buildUpdatePriceDataWorkflowContext(@NonNull String priceDataId, @NonNull PriceChangeRequest priceChangeRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds the context for the DefaultWorkflowNameConstants.SUBSCRIPTION_BULK_PRICING_UPDATE_WORKFLOW workflow.
LockStatus	clearLock(String subscriptionId, boolean isRevert)	Forcefully clear a lock on a subscription.
List<SWI>	createSubscriptionFromOrder(@NonNull CreateSubscriptionFromOrderRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds out a SubscriptionWithItems from order details, and calls a provider to persist them in the resource-tier service.
SWI	createSubscriptionWithItems(@NonNull SubscriptionCreationRequest creationRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Builds out a SubscriptionWithItems and calls a provider to persist them in the resource-tier service
LockStatus	createToken(String subscriptionId, String tokenIdentifier)	Create a child lock on a subscription.
protected Set<String>	getAddablePostPurchaseOptions(@NonNull Product product, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets a set of choice keys for the ItemChoices that are allowed to be added post-purchase.
protected Set<String>	getAllCustomerSubscriptionActionTypes()	Gets all the possible action types that can be performed by the customer (not CSR or system).
protected Optional<String>	getCancellationFeeProductIdToFetch(@NonNull CancellationPolicyDetail cancellationPolicyDetail, @NonNull SubscriptionWithItems subscriptionWithItems)	Fetches the Id of the extra (cancellation) fee product.
protected CancellationPolicyProvider<CancellationPolicy>	getCancellationPolicyProvider()
protected CatalogProvider<Product>	getCatalogProvider()
protected List<ProductOption>	getChildOptions(@NonNull ItemChoice itemChoice, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets the child options for the given ItemChoice.
protected Set<SubscriptionItem>	getCurrentAddons(SWI swi, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Gets the current addons for the given DefaultSubscriptionOperationService.
protected SubscriptionReferencedItem	getCustomRootItemReferencedBySubscription(SWI subscription, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Handles getting the SubscriptionReferencedItem for a custom Subscription.getRootItemRefType().
protected String	getLockToken(@NonNull LockStatus lockStatus)
protected String	getMessage(@NonNull String messagePath, Object... args)
protected org.springframework.context.MessageSource	getMessageSource()
protected List<ModifySubscriptionHandler>	getModifySubscriptionHandlers()
protected SubscriptionReferencedItem	getRootItemReferencedBySubscription(SWI subscription, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Retrieves the SubscriptionReferencedItem referenced as the Subscription.getRootItemRef().
protected SubscriptionOperationServiceProperties	getSubOpsServiceProperties()
protected SubscriptionGenerationService<SWI>	getSubscriptionGenerationService()
protected SubscriptionOperationUtils	getSubscriptionOperationUtils()
protected SubscriptionProvider<SWI,Subscription,SubscriptionOwnerInfo>	getSubscriptionProvider()
protected Optional<SubscriptionStatusHandler<SWI>>	getSubscriptionStatusHandler(@NonNull UpdateSubscriptionStatusRequest request, SWI swi, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected List<SubscriptionStatusHandler<SWI>>	getSubscriptionStatusHandlers()
protected SubscriptionValidationService	getSubscriptionValidationService()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected com.broadleafcommerce.orchestration.service.provider.external.WorkflowProvider	getWorkflowProvider()
protected Subscription	handleStatusUpdateRequest(@NonNull UpdateSubscriptionStatusRequest request, SWI swi, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected boolean	hasNewAddonsToAdd(@NonNull Set<SubscriptionItem> currentAddons, @NonNull Set<String> addablePostPurchase, @NonNull Map<String,ItemChoice> itemChoiceByChoiceKey, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines whether new addons can be added post-purchase given the current addons,
protected boolean	isAnyCurrentAddonsEditable(@NonNull Set<SubscriptionItem> currentAddons, @NonNull Map<String,ItemChoice> itemChoiceByChoiceKey, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Determines whether any of the current addons are editable post-purchase.
protected boolean	isCurrentDateBeyondDowngradeAvailabilityDuration(SWI subscriptionWithItems)	Determines whether the current time is beyond the period start date + restrictDowngradeAfterDays.
LockStatus	lockSubscription(String subscriptionId, List<String> reservations)	Attempt to create a lock on a subscription.
ModifySubscriptionResponse	modifySubscription(@NonNull ModifySubscriptionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Handles modifying Subscriptions based on the allowed actions.
protected void	populateCancelAction(SWI swi, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates the action details for the DefaultSubscriptionActionType.CANCEL.
protected void	populateCancelActionInfo(@NonNull SubscriptionWithItems subscription, @NonNull SubscriptionAction action, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates the SubscriptionAction.getActionInfo() for the an DefaultSubscriptionActionType.CANCEL action for the given SubscriptionWithItems.
protected void	populateCancellationFeeProducts(@NonNull SubscriptionWithItems subscriptionWithItems, @NonNull CancellationPolicyDetail cancellationPolicyDetail, @NonNull SubscriptionAction action, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates the extra (cancellation) fee products including the grace fee cancellation product if applicable on the given action from the given CancellationPolicyDetail by fetching them from the Catalog Service.
protected void	populateChangeAutoRenewalAction(SWI swi, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates the action details for the DefaultSubscriptionActionType.CHANGE_AUTO_RENEWAL.
protected void	populateDowngradeAction(SWI swi, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates the action details for the DefaultSubscriptionActionType.DOWNGRADE.
protected void	populateDowngradeActionInfo(@NonNull SubscriptionReferencedItem rootItem, @NonNull SubscriptionAction action, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates the SubscriptionAction.getActionInfo() for the an DOWNGRADE action for the given SubscriptionWithItems.
protected void	populateEditAction(SWI swi, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates the action details for the DefaultSubscriptionActionType.EDIT.
protected void	populateSubscriptionActionAvailability(@NonNull String actionType, SWI subscriptionWithItems, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected void	populateSubscriptionActions(Iterable<SWI> subscriptions, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	populateSubscriptionActions(SWI subscription, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates SubscriptionWithItems.getAvailableActions() and SubscriptionWithItems.getUnavailableReasonsByActionType().
protected void	populateUpgradeAction(SWI swi, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates the action details for the DefaultSubscriptionActionType.UPGRADE.
protected void	populateUpgradeActionInfo(@NonNull SubscriptionReferencedItem rootItem, @NonNull SubscriptionAction action, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Populates the SubscriptionAction.getActionInfo() for the an UPGRADE action for the given SubscriptionWithItems.
SubscriptionActionResponse	readSubscriptionActions(@NonNull SubscriptionActionRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	This method reads subscriptions for a given user type and user id, additionally filtered and paginated by given parameters
SWI	readSubscriptionById(@NonNull String subscriptionId, boolean isSandboxAware, boolean ignoreDeleteFiltering, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	This method reads a subscription for the given id
org.springframework.data.domain.Page<SWI>	readSubscriptionsForUserRefTypeAndUserRef(@NonNull String userRefType, @NonNull String userRef, boolean getActions, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	This method reads subscriptions for a given user type and user id, additionally filtered and paginated by given parameters
SWI	readUserSubscriptionById(@NonNull String userRefType, @NonNull String userRef, @NonNull String subscriptionId, boolean getActions, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	This method attempts to find a SubscriptionWithItems by id which is owned by the user/account
SWI	replaceSubscriptionWithItems(SWI subscriptionWithItems, boolean isSandboxAware, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Handles updating the Subscription's status.
void	setSubscriptionStatusHandlers(List<SubscriptionStatusHandler<SWI>> subscriptionStatusHandlers)
LockStatus	unlockToken(String subscriptionId, String token, boolean propagate)	Unlock a child lock on a subscription.
void	updatePriceData(String priceDataId, PriceChangeRequest priceChangeRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
SWI	updateSubscriptionStatus(@NonNull UpdateSubscriptionStatusRequest request, boolean isSandboxAware, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Handles updating the Subscription's status.

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.SubscriptionOperationService

readSubscriptionById, readSubscriptionById

Constructor Details

DefaultSubscriptionOperationService

public DefaultSubscriptionOperationService(SubscriptionProvider<SWI,Subscription,SubscriptionOwnerInfo> subscriptionProvider,
 SubscriptionValidationService subscriptionValidationService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 List<ModifySubscriptionHandler> modifySubscriptionHandlers,
 CatalogProvider<Product> catalogProvider,
 CancellationPolicyProvider<CancellationPolicy> cancellationPolicyProvider,
 SubscriptionGenerationService<SWI> subscriptionGenerationService,
 SubscriptionOperationUtils subscriptionOperationUtils,
 com.broadleafcommerce.orchestration.service.provider.external.WorkflowProvider workflowProvider,
 SubscriptionOperationServiceProperties subOpsServiceProperties,
 org.springframework.context.MessageSource messageSource)

Method Details

populateSubscriptionActions

public void populateSubscriptionActions(@NonNull
 SWI subscription,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SubscriptionOperationService

Populates SubscriptionWithItems.getAvailableActions() and SubscriptionWithItems.getUnavailableReasonsByActionType().

Specified by:

populateSubscriptionActions in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

subscription - The SubscriptionWithItems to populate.

contextInfo - Additional sandbox and multitenant info.

readSubscriptionActions

public SubscriptionActionResponse readSubscriptionActions(@NonNull
 @NonNull SubscriptionActionRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SubscriptionOperationService

This method reads subscriptions for a given user type and user id, additionally filtered and paginated by given parameters

Specified by:

readSubscriptionActions in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

request - the SubscriptionActionRequest

contextInfo - context information around multi-tenant state

Returns:

Subscriptions with items matching the given criteria

readSubscriptionsForUserRefTypeAndUserRef

public org.springframework.data.domain.Page<SWI> readSubscriptionsForUserRefTypeAndUserRef(@NonNull
 @NonNull String userRefType,
 @NonNull
 @NonNull String userRef,
 boolean getActions,
 @Nullable
 org.springframework.data.domain.Pageable page,
 @Nullable
 cz.jirutka.rsql.parser.ast.Node filters,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SubscriptionOperationService

This method reads subscriptions for a given user type and user id, additionally filtered and paginated by given parameters

Specified by:

readSubscriptionsForUserRefTypeAndUserRef in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

userRefType - user type, see DefaultUserRefTypes

userRef - id of owning user or account

getActions - whether to get available actions for the subscriptions

page - information about which page of results to return from the database.

filters - additional filters to apply in the query. Should be EmptyNode if no additional filters should be applied.

contextInfo - context information around multi-tenant state

Returns:

Subscriptions with items matching the given criteria

readUserSubscriptionById

public SWI readUserSubscriptionById(@NonNull
 @NonNull String userRefType,
 @NonNull
 @NonNull String userRef,
 @NonNull
 @NonNull String subscriptionId,
 boolean getActions,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SubscriptionOperationService

This method attempts to find a SubscriptionWithItems by id which is owned by the user/account

Specified by:

readUserSubscriptionById in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

userRefType - user type, see DefaultUserRefTypes

userRef - id of owning user or account

subscriptionId - The id of the Subscription that is intended to be gathered

getActions - whether to get available actions for the subscription

contextInfo - context information around multi-tenant state

Returns:

Subscriptions with items matching the given criteria

readSubscriptionById

public SWI readSubscriptionById(@NonNull
 @NonNull String subscriptionId,
 boolean isSandboxAware,
 boolean ignoreDeleteFiltering,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SubscriptionOperationService

This method reads a subscription for the given id

Specified by:

readSubscriptionById in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

subscriptionId - The id of the Subscription that is intended to be gathered

isSandboxAware - Whether to look for sandbox records

ignoreDeleteFiltering - Whether to ignore sandbox delete filtering

contextInfo - context information around multi-tenant state

Returns:

a subscription with items identified by the subscription id

createSubscriptionWithItems

public SWI createSubscriptionWithItems(@NonNull
 @NonNull SubscriptionCreationRequest creationRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SubscriptionOperationService

Builds out a SubscriptionWithItems and calls a provider to persist them in the resource-tier service

Specified by:

createSubscriptionWithItems in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

creationRequest - request DTO with necessary fields to build a subscription

contextInfo - context information around multi-tenant state

Returns:

a created subscription with its items

createSubscriptionFromOrder

public List<SWI> createSubscriptionFromOrder(@NonNull
 @NonNull CreateSubscriptionFromOrderRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SubscriptionOperationService

Builds out a SubscriptionWithItems from order details, and calls a provider to persist them in the resource-tier service.

Specified by:

createSubscriptionFromOrder in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

request - request DTO with necessary fields to build a Subscription.

contextInfo - context information around multi-tenant state

Returns:

a created subscription with its items

updateSubscriptionStatus

public SWI updateSubscriptionStatus(@NonNull
 @NonNull UpdateSubscriptionStatusRequest request,
 boolean isSandboxAware,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SubscriptionOperationService

Handles updating the Subscription's status.

Specified by:

updateSubscriptionStatus in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

request - The request to modify a subscription's status.

isSandboxAware - Whether sandboxing should be enabled for the scope of the operation

contextInfo - context information around multi-tenant state

Returns:

The updated SubscriptionWithItems

replaceSubscriptionWithItems

public SWI replaceSubscriptionWithItems(@NonNull
 SWI subscriptionWithItems,
 boolean isSandboxAware,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SubscriptionOperationService

Handles updating the Subscription's status.

Specified by:

replaceSubscriptionWithItems in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

subscriptionWithItems - the SubscriptionWithItems to replace

isSandboxAware - Whether sandboxing should be enabled for the scope of the operation

contextInfo - context information around multi-tenant state

Returns:

The updated SubscriptionWithItems

modifySubscription

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

Description copied from interface: SubscriptionOperationService

Handles modifying Subscriptions based on the allowed actions. By default, this should defer the actual business logic to the appropriate ModifySubscriptionHandler.

Specified by:

modifySubscription in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

request - The request to modify a subscription.

contextInfo - context information around multi-tenant state

Returns:

Details about the result of the action.

lockSubscription

public LockStatus lockSubscription(String subscriptionId,
 @Nullable
 List<String> reservations)

Description copied from interface: SubscriptionOperationService

Attempt to create a lock on a subscription. While a subscription is locked, no other changes can be made to the subscription.

Specified by:

lockSubscription in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

subscriptionId - The subscription to lock

reservations - The list of reservation identifiers (i.e. child locks) to make on the subscription

Returns:

The status of the lock request

clearLock

public LockStatus clearLock(String subscriptionId,
 boolean isRevert)

Description copied from interface: SubscriptionOperationService

Forcefully clear a lock on a subscription. This will release all child locks as well.

Specified by:

clearLock in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

subscriptionId - The subscription to unlock

isRevert - Whether the unlock operation is the result of a revert operation. Optional. Default is true.

Returns:

The status of the lock request

unlockToken

public LockStatus unlockToken(String subscriptionId,
 String token,
 boolean propagate)

Description copied from interface: SubscriptionOperationService

Unlock a child lock on a subscription. If the child lock is the last lock on the subscription, the subscription will be unlocked as well.

Specified by:

unlockToken in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

subscriptionId - The subscription to unlock

token - The token of the child lock to unlock

propagate - Whether to propagate the token unlock to the parent lock (if applicable).

Returns:

The status of the lock request

createToken

public LockStatus createToken(String subscriptionId,
 @Nullable
 String tokenIdentifier)

Description copied from interface: SubscriptionOperationService

Create a child lock on a subscription.

Specified by:

createToken in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

subscriptionId - The subscription identifier

tokenIdentifier - The identifier for the child lock. Optional. Will generate an identifier if null.

Returns:

The status of the lock request

addAdjustment

public void addAdjustment(@NonNull
 @NonNull AddAdjustmentRequest addAdjustmentRequest,
 String subscriptionId,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Description copied from interface: SubscriptionOperationService

Adds the requested adjustments onto the Subscription that matches the passed ID.

Specified by:

addAdjustment in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

Parameters:

addAdjustmentRequest - the request to add adjustments onto a subscription

subscriptionId - the Subscription to add the adjustment to

contextInfo - context information around multi-tenant state

updatePriceData

public void updatePriceData(String priceDataId,
 PriceChangeRequest priceChangeRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Specified by:

updatePriceData in interface SubscriptionOperationService<SWI extends SubscriptionWithItems>

getAllCustomerSubscriptionActionTypes

protected Set<String> getAllCustomerSubscriptionActionTypes()

Gets all the possible action types that can be performed by the customer (not CSR or system).

buildAddAdjustmentWorkflowContext

protected Map<String,String> buildAddAdjustmentWorkflowContext(@NonNull
 @NonNull String subscriptionId,
 @NonNull
 @NonNull LockStatus lockStatus,
 @NonNull
 @NonNull AddAdjustmentRequest addAdjustmentRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds the context for the DefaultWorkflowNameConstants.SUBSCRIPTION_CSR_ADD_ADJUSTMENT_WORKFLOW workflow.

Parameters:

subscriptionId - The ID of the subscription to add the adjustment to

lockStatus - The LockStatus for the subscription

addAdjustmentRequest - The request containing the adjustment to add

contextInfo - Additional multitenant and sandbox info

Returns:

The context for the workflow

getLockToken

protected String getLockToken(@NonNull
 @NonNull LockStatus lockStatus)

buildUpdatePriceDataWorkflowContext

protected Map<String,String> buildUpdatePriceDataWorkflowContext(@NonNull
 @NonNull String priceDataId,
 @NonNull
 @NonNull PriceChangeRequest priceChangeRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds the context for the DefaultWorkflowNameConstants.SUBSCRIPTION_BULK_PRICING_UPDATE_WORKFLOW workflow.

Parameters:

priceDataId - The ID of the price data to update

priceChangeRequest - The request containing the new price data

contextInfo - Additional multitenant and sandbox info

Returns:

The context for the workflow

getSubscriptionStatusHandler

protected Optional<SubscriptionStatusHandler<SWI>> getSubscriptionStatusHandler(@NonNull
 @NonNull UpdateSubscriptionStatusRequest request,
 @NonNull
 SWI swi,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

handleStatusUpdateRequest

protected Subscription handleStatusUpdateRequest(@NonNull
 @NonNull UpdateSubscriptionStatusRequest request,
 @NonNull
 SWI swi,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

populateSubscriptionActions

protected void populateSubscriptionActions(Iterable<SWI> subscriptions,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

populateSubscriptionActionAvailability

protected void populateSubscriptionActionAvailability(@NonNull
 @NonNull String actionType,
 @NonNull
 SWI subscriptionWithItems,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

populateEditAction

protected void populateEditAction(@NonNull
 SWI swi,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Populates the action details for the DefaultSubscriptionActionType.EDIT.

By default, it's always an available action.

Parameters:

swi - The DefaultSubscriptionOperationService to populate the action details for

contextInfo - additional sandbox and multitenant info

populateUpgradeAction

protected void populateUpgradeAction(@NonNull
 SWI swi,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Populates the action details for the DefaultSubscriptionActionType.UPGRADE.

Parameters:

swi - The DefaultSubscriptionOperationService to populate the action details for

contextInfo - additional sandbox and multitenant info

populateDowngradeAction

protected void populateDowngradeAction(@NonNull
 SWI swi,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Populates the action details for the DefaultSubscriptionActionType.DOWNGRADE.

Parameters:

swi - The DefaultSubscriptionOperationService to populate the action details for

contextInfo - additional sandbox and multitenant info

populateCancelAction

protected void populateCancelAction(@NonNull
 SWI swi,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Populates the action details for the DefaultSubscriptionActionType.CANCEL.

Parameters:

swi - SubscriptionWithItems to be potentially acted against.

contextInfo - Additional sandbox and multitenant info

populateChangeAutoRenewalAction

protected void populateChangeAutoRenewalAction(@NonNull
 SWI swi,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Populates the action details for the DefaultSubscriptionActionType.CHANGE_AUTO_RENEWAL.

By default, it's always an available action.

Parameters:

swi - The DefaultSubscriptionOperationService to populate the action details for

contextInfo - additional sandbox and multitenant info

getMessage

protected String getMessage(@NonNull
 @NonNull String messagePath,
 @Nullable
 Object... args)

addUnavailableAction

protected void addUnavailableAction(@NonNull
 SWI swi,
 @NonNull
 @NonNull String actionType,
 @NonNull
 @NonNull String reasonMessagePath)

getAddablePostPurchaseOptions

protected Set<String> getAddablePostPurchaseOptions(@NonNull
 @NonNull Product product,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Gets a set of choice keys for the ItemChoices that are allowed to be added post-purchase.

Parameters:

product - the product to evaluate

contextInfo - additional sandbox and multitenant info

Returns:

a set of choice keys for the ItemChoices that are allowed to be added

getCurrentAddons

protected Set<SubscriptionItem> getCurrentAddons(@NonNull
 SWI swi,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Gets the current addons for the given DefaultSubscriptionOperationService.

Parameters:

swi - the DefaultSubscriptionOperationService to evaluate

contextInfo - additional sandbox and multitenant info

Returns:

the current addons for the given DefaultSubscriptionOperationService

hasNewAddonsToAdd

protected boolean hasNewAddonsToAdd(@NonNull
 @NonNull Set<SubscriptionItem> currentAddons,
 @NonNull
 @NonNull Set<String> addablePostPurchase,
 @NonNull
 @NonNull Map<String,ItemChoice> itemChoiceByChoiceKey,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Determines whether new addons can be added post-purchase given the current addons,

Parameters:

currentAddons - the current addons

addablePostPurchase - the choice keys of addons that can be added post-purchase

itemChoiceByChoiceKey - map of choice keys to item choices for all options on the product

contextInfo - additional sandbox and multitenant info

Returns:

whether new addons can be added post-purchase

isAnyCurrentAddonsEditable

protected boolean isAnyCurrentAddonsEditable(@NonNull
 @NonNull Set<SubscriptionItem> currentAddons,
 @NonNull
 @NonNull Map<String,ItemChoice> itemChoiceByChoiceKey,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Determines whether any of the current addons are editable post-purchase.

Parameters:

currentAddons - the current addons

itemChoiceByChoiceKey - map of choice keys to item choices for all options on the product

contextInfo - additional sandbox and multitenant info

Returns:

whether any of the current addons are editable post-purchase

buildItemChoiceByChoiceKey

protected Map<String,ItemChoice> buildItemChoiceByChoiceKey(@NonNull
 @NonNull Product product,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Builds a map of choice keys to item choices for all options on the product, including child options.

Parameters:

product - the product to evaluate

contextInfo - additional sandbox and multitenant info

Returns:

a map of choice keys to item choices for all options on the product

getChildOptions

protected List<ProductOption> getChildOptions(@NonNull
 @NonNull ItemChoice itemChoice,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Gets the child options for the given ItemChoice.

Parameters:

itemChoice - the item choice to evaluate

contextInfo - additional sandbox and multitenant info

Returns:

the child options for the given ItemChoice

isCurrentDateBeyondDowngradeAvailabilityDuration

protected boolean isCurrentDateBeyondDowngradeAvailabilityDuration(@NonNull
 SWI subscriptionWithItems)

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

Parameters:

subscriptionWithItems - the SubscriptionWithItems object

Returns:

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

buildAvailableAction

protected SubscriptionAction buildAvailableAction(@NonNull
 SWI subscription,
 @NonNull
 @NonNull String actionType,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Creates a SubscriptionAction for the actionType and SubscriptionWithItems representing an action that may be taken against the subscription.

Parameters:

subscription - The SubscriptionWithItems being retrieved that may be acted against.

actionType - The type of action that is allowed for the subscription. See DefaultSubscriptionActionType.

contextInfo - Additional sandbox and multitenant info

Returns:

A SubscriptionAction for the actionType and SubscriptionWithItems representing an action that may be taken against the subscription.

getRootItemReferencedBySubscription

protected SubscriptionReferencedItem getRootItemReferencedBySubscription(@NonNull
 SWI subscription,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Retrieves the SubscriptionReferencedItem referenced as the Subscription.getRootItemRef().

Parameters:

subscription - A SubscriptionWithItems whose root item to fetch.

contextInfo - Additional sandbox and multitenant info

Returns:

The SubscriptionReferencedItem referenced as the Subscription.getRootItemRef().

See Also:

• getCustomRootItemReferencedBySubscription(SubscriptionWithItems, ContextInfo)

getCustomRootItemReferencedBySubscription

protected SubscriptionReferencedItem getCustomRootItemReferencedBySubscription(@NonNull
 SWI subscription,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Handles getting the SubscriptionReferencedItem for a custom Subscription.getRootItemRefType().

Parameters:

subscription - A SubscriptionWithItems whose root item to fetch.

contextInfo - Additional sandbox and multitenant info

Returns:

The SubscriptionReferencedItem referenced as the Subscription.getRootItemRef().

See Also:

• getRootItemReferencedBySubscription(SubscriptionWithItems, ContextInfo)

populateUpgradeActionInfo

protected void populateUpgradeActionInfo(@NonNull
 @NonNull SubscriptionReferencedItem rootItem,
 @NonNull
 @NonNull SubscriptionAction action,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Populates the SubscriptionAction.getActionInfo() for the an UPGRADE action for the given SubscriptionWithItems.

Parameters:

rootItem - The SubscriptionReferencedItem that stores what its upgrade options are.

action - The SubscriptionAction representing the upgrade action.

contextInfo - Additional sandbox and multitenant info

populateDowngradeActionInfo

protected void populateDowngradeActionInfo(@NonNull
 @NonNull SubscriptionReferencedItem rootItem,
 @NonNull
 @NonNull SubscriptionAction action,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Populates the SubscriptionAction.getActionInfo() for the an DOWNGRADE action for the given SubscriptionWithItems.

Parameters:

rootItem - The SubscriptionReferencedItem that stores what its upgrade options are.

action - The SubscriptionAction representing the downgrade action.

contextInfo - Additional sandbox and multitenant info

populateCancelActionInfo

protected void populateCancelActionInfo(@NonNull
 @NonNull SubscriptionWithItems subscription,
 @NonNull
 @NonNull SubscriptionAction action,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Populates the SubscriptionAction.getActionInfo() for the an DefaultSubscriptionActionType.CANCEL action for the given SubscriptionWithItems.

Parameters:

subscription - The SubscriptionWithItems that stores the subscription with its items.

action - The SubscriptionAction representing the cancel action.

contextInfo - Additional sandbox and multitenant info

populateCancellationFeeProducts

protected void populateCancellationFeeProducts(@NonNull
 @NonNull SubscriptionWithItems subscriptionWithItems,
 @NonNull
 @NonNull CancellationPolicyDetail cancellationPolicyDetail,
 @NonNull
 @NonNull SubscriptionAction action,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Populates the extra (cancellation) fee products including the grace fee cancellation product if applicable on the given action from the given CancellationPolicyDetail by fetching them from the Catalog Service.

Parameters:

subscriptionWithItems - The SubscriptionWithItems that stores the subscription with its items.

cancellationPolicyDetail - The CancellationPolicyDetail containing more details about the current subscription's CancellationPolicy

action - The SubscriptionAction representing the cancel action.

contextInfo - Additional sandbox and multitenant info

getCancellationFeeProductIdToFetch

protected Optional<String> getCancellationFeeProductIdToFetch(@NonNull
 @NonNull CancellationPolicyDetail cancellationPolicyDetail,
 @NonNull
 @NonNull SubscriptionWithItems subscriptionWithItems)

Fetches the Id of the extra (cancellation) fee product. It could be the grace fee cancellation product (if applicable) or the cancellation fee product from the given CancellationPolicyDetail.

Parameters:

cancellationPolicyDetail - The CancellationPolicyDetail containing more details about the current subscription's CancellationPolicy

subscriptionWithItems - The SubscriptionWithItems that stores the subscription with its items.

Returns:

Product Id of the cancellation fee product

buildSubscriptionWithItems

protected SWI buildSubscriptionWithItems(@NonNull
 @NonNull SubscriptionCreationRequest creationRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

buildSubscription

protected Subscription buildSubscription(@NonNull
 @NonNull SubscriptionCreationRequest request,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

buildSubscriptionItems

protected List<SubscriptionItem> buildSubscriptionItems(@NonNull
 @NonNull SubscriptionCreationRequest creationRequest,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getSubscriptionProvider

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

getSubscriptionValidationService

protected SubscriptionValidationService getSubscriptionValidationService()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()

getModifySubscriptionHandlers

protected List<ModifySubscriptionHandler> getModifySubscriptionHandlers()

getCatalogProvider

protected CatalogProvider<Product> getCatalogProvider()

getCancellationPolicyProvider

protected CancellationPolicyProvider<CancellationPolicy> getCancellationPolicyProvider()

getSubscriptionGenerationService

protected SubscriptionGenerationService<SWI> getSubscriptionGenerationService()

getSubscriptionOperationUtils

protected SubscriptionOperationUtils getSubscriptionOperationUtils()

getWorkflowProvider

protected com.broadleafcommerce.orchestration.service.provider.external.WorkflowProvider getWorkflowProvider()

getSubOpsServiceProperties

protected SubscriptionOperationServiceProperties getSubOpsServiceProperties()

getMessageSource

protected org.springframework.context.MessageSource getMessageSource()

getSubscriptionStatusHandlers

@Nullable
protected List<SubscriptionStatusHandler<SWI>> getSubscriptionStatusHandlers()

setSubscriptionStatusHandlers

@Autowired(required=false)
public void setSubscriptionStatusHandlers(List<SubscriptionStatusHandler<SWI>> subscriptionStatusHandlers)