Package com.broadleafcommerce.subscriptionoperation.service.modification

Class SubscriptionModificationUtils

java.lang.Object

com.broadleafcommerce.subscriptionoperation.service.modification.SubscriptionModificationUtils

public class SubscriptionModificationUtils
extends Object

Provides utility methods for shared logic for ModifySubscriptionHandlers that doesn't make sense in an abstract class.

Author:

Nathan Moore (nathandmoore)

See Also:

• ModifySubscriptionHandler

Constructor Summary

Constructors

Constructor	Description
SubscriptionModificationUtils(com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected ExistingSubscriptionAdjustmentDetail	buildExistingSubscriptionAdjustmentDetail(@NonNull SubscriptionAdjustment subscriptionAdjustment, @NonNull Subscription subscription)	Builds a ExistingSubscriptionAdjustmentDetail for the given SubscriptionAdjustment.
ExistingSubscriptionDetails	buildExistingSubscriptionDetails(@NonNull SubscriptionWithItems existingSubscription)	Builds a ExistingSubscriptionDetails for the given SubscriptionWithItems.
protected ExistingSubscriptionItemAdjustmentDetail	buildExistingSubscriptionItemAdjustmentDetail(@NonNull SubscriptionItemAdjustment subscriptionItemAdjustment, @NonNull Subscription subscription)	Builds a ExistingSubscriptionItemAdjustmentDetail for the given SubscriptionItemAdjustment.
protected ExistingSubscriptionItemDetail	buildExistingSubscriptionItemDetail(@NonNull SubscriptionItem subscriptionItem, @NonNull Subscription subscription)	Builds a ExistingSubscriptionItemDetail for the given SubscriptionItem.
PriceCartRequest	buildPriceCartRequest(@NonNull Subscription subscription, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)	Build the PriceCartRequest for pricing the cart.
String	generateCartName(@NonNull Subscription subscription, String flowName)	Generates the name for a cart based on the operationFlow triggered and subscription.
protected Instant	getDateXAfterDaysFromCurrentPeriodStartDate(@NonNull Subscription subscription, int daysToAdd)
protected int	getPeriodsUsed(@NonNull Adjustment adjustment, @NonNull Subscription existingSubscription)	Get the number of periods of the Adjustment already used by the existing Subscription.
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected void	populateCommonAdjustmentProperties(@NonNull ExistingAdjustmentDetail existingAdjustmentDetail, @NonNull Adjustment adjustment, @NonNull Subscription existingSubscription)
void	populateExistingSubscriptionDetails(@NonNull CreateCartRequest createCartRequest, @NonNull SubscriptionWithItems existingSubscription)	Populates ExistingSubscriptionDetails onto the CreateCartRequest.
protected void	populateItemChoiceDetailsToAddItemRequest(@NonNull AddItemRequest addItemRequest, @NonNull ItemChoice itemChoice, @NonNull Subscription subscription, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SubscriptionModificationUtils

public SubscriptionModificationUtils(com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

generateCartName

public String generateCartName(@NonNull
 @NonNull Subscription subscription,
 String flowName)

Generates the name for a cart based on the operationFlow triggered and subscription.

Parameters:

subscription - the current subscription

flowName - Name of the modification flow.

Returns:

a unique cart name String

See Also:

• DefaultSubscriptionActionFlow

buildPriceCartRequest

public PriceCartRequest buildPriceCartRequest(@NonNull
 @NonNull Subscription subscription,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

Build the PriceCartRequest for pricing the cart.

Parameters:

subscription - the current subscription

contextInfo - the context info

Returns:

the generated PriceCartRequest

populateExistingSubscriptionDetails

public void populateExistingSubscriptionDetails(@NonNull
 @NonNull CreateCartRequest createCartRequest,
 @NonNull
 @NonNull SubscriptionWithItems existingSubscription)

Populates ExistingSubscriptionDetails onto the CreateCartRequest. This will then be added to the Cart created for the modification request as an attribute.

Parameters:

createCartRequest - The CreateCartRequest.

existingSubscription - The existing SubscriptionWithItems before modifications.

buildExistingSubscriptionDetails

public ExistingSubscriptionDetails buildExistingSubscriptionDetails(@NonNull
 @NonNull SubscriptionWithItems existingSubscription)

Builds a ExistingSubscriptionDetails for the given SubscriptionWithItems. This includes a ExistingSubscriptionItemDetail for each SubscriptionItem.

Parameters:

existingSubscription - The existing SubscriptionWithItems before modifications.

Returns:

A ExistingSubscriptionDetails for the given SubscriptionWithItems.

See Also:

• populateExistingSubscriptionDetails(CreateCartRequest, SubscriptionWithItems)
• buildExistingSubscriptionItemDetail(SubscriptionItem, Subscription)

buildExistingSubscriptionItemDetail

protected ExistingSubscriptionItemDetail buildExistingSubscriptionItemDetail(@NonNull
 @NonNull SubscriptionItem subscriptionItem,
 @NonNull
 @NonNull Subscription subscription)

Builds a ExistingSubscriptionItemDetail for the given SubscriptionItem.

Parameters:

subscriptionItem - The existing SubscriptionItem before its parent has been modified.

subscription - The existing Subscription before it has been modified.

Returns:

A ExistingSubscriptionItemDetail for the given SubscriptionItem.

See Also:

• populateExistingSubscriptionDetails(CreateCartRequest, SubscriptionWithItems)
• buildExistingSubscriptionDetails(SubscriptionWithItems)

buildExistingSubscriptionAdjustmentDetail

protected ExistingSubscriptionAdjustmentDetail buildExistingSubscriptionAdjustmentDetail(@NonNull
 @NonNull SubscriptionAdjustment subscriptionAdjustment,
 @NonNull
 @NonNull Subscription subscription)

Builds a ExistingSubscriptionAdjustmentDetail for the given SubscriptionAdjustment.

Parameters:

subscriptionAdjustment - The existing SubscriptionAdjustment

Returns:

A ExistingSubscriptionAdjustmentDetail for the given SubscriptionAdjustment

buildExistingSubscriptionItemAdjustmentDetail

protected ExistingSubscriptionItemAdjustmentDetail buildExistingSubscriptionItemAdjustmentDetail(@NonNull
 @NonNull SubscriptionItemAdjustment subscriptionItemAdjustment,
 @NonNull
 @NonNull Subscription subscription)

Builds a ExistingSubscriptionItemAdjustmentDetail for the given SubscriptionItemAdjustment.

Parameters:

subscriptionItemAdjustment - The existing SubscriptionItemAdjustment

Returns:

A ExistingSubscriptionItemAdjustmentDetail for the given SubscriptionItemAdjustment

populateCommonAdjustmentProperties

protected void populateCommonAdjustmentProperties(@NonNull
 @NonNull ExistingAdjustmentDetail existingAdjustmentDetail,
 @NonNull
 @NonNull Adjustment adjustment,
 @NonNull
 @NonNull Subscription existingSubscription)

getPeriodsUsed

protected int getPeriodsUsed(@NonNull
 @NonNull Adjustment adjustment,
 @NonNull
 @NonNull Subscription existingSubscription)

Get the number of periods of the Adjustment already used by the existing Subscription.

Parameters:

adjustment - the Adjustment that has already been applied

existingSubscription - the existing Subscription that the adjustment has been applied to

Returns:

the number of periods used by the adjustment

populateItemChoiceDetailsToAddItemRequest

protected void populateItemChoiceDetailsToAddItemRequest(@NonNull
 @NonNull AddItemRequest addItemRequest,
 @NonNull
 @NonNull ItemChoice itemChoice,
 @NonNull
 @NonNull Subscription subscription,
 @Nullable
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getDateXAfterDaysFromCurrentPeriodStartDate

protected Instant getDateXAfterDaysFromCurrentPeriodStartDate(@NonNull
 @NonNull Subscription subscription,
 int daysToAdd)

getTypeFactory

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