Index

A B C D E F G H I L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

AbstractExternalProvider - Class in com.broadleafcommerce.subscriptionoperation.service.provider.external

AbstractExternalProvider(WebClient, ObjectMapper, TypeFactory) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.external.AbstractExternalProvider

AbstractGradeChangeSubscriptionModificationHandler - Class in com.broadleafcommerce.subscriptionoperation.service.modification

Common parent for InitiateUpgradeSubscriptionHandler and InitiateDowngradeSubscriptionHandler.

AbstractGradeChangeSubscriptionModificationHandler(TypeFactory, SubscriptionModificationUtils, CatalogProvider<Product>, CartOperationProvider<Cart>) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

AbstractModifySubscriptionHandler - Class in com.broadleafcommerce.subscriptionoperation.service.modification

Handles common operations and logic for concrete handlers.

AbstractModifySubscriptionHandler(TypeFactory, SubscriptionModificationUtils) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

ACCOUNT_SUBSCRIPTION_PERMISSION_ROOT - Static variable in class com.broadleafcommerce.subscriptionoperation.web.endpoint.AccountSubscriptionOperationEndpoint

AccountSubscriptionOperationEndpoint - Class in com.broadleafcommerce.subscriptionoperation.web.endpoint

AccountSubscriptionOperationEndpoint(SubscriptionOperationService<SubscriptionWithItems>, SubscriptionAccessValidationService, TypeFactory) - Constructor for class com.broadleafcommerce.subscriptionoperation.web.endpoint.AccountSubscriptionOperationEndpoint

ACTION_NOT_ALLOWED - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

A generic reason for something like can't change auto-renewal for subscriptions with multi-year terms.

ACTIVE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

Indicates an active subscription

activeSubscriptionStatusHandler() - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration.SubscriptionStatusChangeHandlersConfiguration

ActiveSubscriptionStatusHandler<SWI extends SubscriptionWithItems> - Class in com.broadleafcommerce.subscriptionoperation.service.status

The default handler that validates if the Subscription status can be changed to SubscriptionStatuses.ACTIVE

ActiveSubscriptionStatusHandler() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.status.ActiveSubscriptionStatusHandler

addAdditionalAttribute(String, Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Category

Takes in any additional attributes passed in the request not matching any defined properties.

addAdditionalAttribute(String, Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Takes in any additional attributes passed in the request not matching any defined properties.

addAdditionalAttribute(String, Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

Takes in any additional attributes passed in the request not matching any defined properties.

addAdditionalAttribute(String, Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

Takes in any additional attributes passed in the request not matching any defined properties.

addAdditionalAttribute(String, Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

Takes in any additional attributes passed in the request not matching any defined properties.

addAdditionalHeaders(HttpHeaders) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProvider

addAdjustment(AddAdjustmentRequest, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

addAdjustment(AddAdjustmentRequest, String, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

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

AddAdjustmentRequest - Class in com.broadleafcommerce.subscriptionoperation.domain.offer

A DTO that represents a request to add an offer / offer code onto a Subscription.

AddAdjustmentRequest() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

addAdjustmentToSubscription(String, AddAdjustmentRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

AddAdjustmentWorkflow() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants.AddAdjustmentWorkflow

addAttribute(String, Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

Takes in any additional attributes passed in the request not matching any defined properties.

addAttribute(String, Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Takes in any additional attributes passed in the request not matching any defined properties.

addAttribute(String, Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Takes in any additional attributes passed in the request not matching any defined properties.

addAttribute(String, Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Takes in any additional attributes passed in the request not matching any defined properties.

addDependentsToParents(Map<String, List<String>>, Map<String, AddItemRequest>) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

Adds the link between subscriptionId and its childrenIds to the map containing the AddItemRequest.

AddItemRequest - Class in com.broadleafcommerce.subscriptionoperation.web.domain

A request DTO for adding an item to a cart.

AddItemRequest() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

additionalAttributes(Map<String, String>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus.LockStatusBuilder

Additional information about the lock

addMessagesDefaultBasenames(Set<String>) - Method in class com.broadleafcommerce.subscriptionoperation.i18n.autoconfigure.SubscriptionOperationI18nAutoConfiguration.SubOpsMessagesDefaultBasenameAddingPostProcessor

addOffsetOrPageNumber(MultiValueMap<String, String>, Pageable) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.AbstractExternalProvider

ADDON_QUANTITY_DECREASE_DEADLINE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

The deadline of when an add-on subscription item quantity can be decreased.

ADDON_REMOVAL_DEADLINE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

The deadline of when an add-on subscription item can be removed.

addPriceDataChanges(PriceDataChangeRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

addPriceDataChanges(PriceDataChangeRequest, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Add a price data change to a batch of subscriptions

addUnavailableAction(SWI, String, String) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

Adjustment - Interface in com.broadleafcommerce.subscriptionoperation.domain

Represents a price adjustment (discount) applied from an offer added to a Subscription or SubscriptionItem.

AdjustmentApplicationDateType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.offer.type

Enumerates the types of dates that dictate when an added SubscriptionItemAdjustment is applied onto a SubscriptionItem

ALL - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultPriceChangeScopeType

All accounts

ALL_CUSTOMERS - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.pricing.type.PriceDataAppliesToType

The PriceChangeRequest is applied for all customers

ALLOW_ADDON_REMOVAL_AFTER_PURCHASE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

Whether removal of the add-on subscription item is allowed after the initial purchase.

ALLOW_AUTO_RENEWAL_MODIFICATION - Static variable in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

AMOUNT_OFF - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionAdjustmentType

Take an amount off of the total amount.

ANNUALLY - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionPeriodType

APPLICATION_DATE_TYPE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants.AddAdjustmentWorkflow

APPLICATION_ID - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

APPLY_TO_DEPENDENT_ITEMS - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants.AddAdjustmentWorkflow

authorize(OAuth2AuthorizeRequest) - Method in class com.broadleafcommerce.subscriptionoperation.oauth2.client.web.SynchronizedDelegatingOAuth2AuthorizedClientManager

Deprecated.

AUTO_RENEW - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

A request to automatically renew the subscription

AUTO_RENEW - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.EndOfTermStrategy

Declares that the subscription's terms will be renewed

AUTO_RENEWAL_ENABLED - Static variable in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

B

BASE_URI - Static variable in class com.broadleafcommerce.subscriptionoperation.web.endpoint.AccountSubscriptionOperationEndpoint

BASE_URI - Static variable in class com.broadleafcommerce.subscriptionoperation.web.endpoint.CancellationPolicyOperationEndpoint

BASE_URI - Static variable in class com.broadleafcommerce.subscriptionoperation.web.endpoint.CustomerSubscriptionOperationEndpoint

BASE_URI - Static variable in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

BASE_URI - Static variable in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionPricingEndpoint

beginningOfNextDay(Instant, String) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

BILLING_FREQUENCY_CHANGE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultShortenedPeriodReason

Declares that the subscription's period was shortened due to a change of billing frequency

BLC_ACCOUNT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultUserRefTypes

Describes Broadleaf's Account.

BLC_CUSTOMER - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultUserRefTypes

Describes Broadleaf's Customer.

BLC_ORDER - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionSourceType

Indicates that the subscription source for a subscription is a Broadleaf Order.

BLC_ORDER_ITEM - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionSourceType

Indicates that the subscription source for a subscription is a Broadleaf Order.

BLC_PRODUCT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionItemReferenceType

Default out-of-box value that shows that the item reference points to a Broadleaf Product.

build() - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus.LockStatusBuilder

buildActionPriceDetail(CartItem, CartItem, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildActionPriceDetailForRemovedSubscriptionItem(SubscriptionItem, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildActionPriceDetails(CartItem, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildActionPriceDetailsForDependentCartItems(CartItem, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildActionPriceDetailsForRemovedSubscriptionItems(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildAddAdjustmentWorkflowContext(String, LockStatus, AddAdjustmentRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

Builds the context for the DefaultWorkflowNameConstants.SUBSCRIPTION_CSR_ADD_ADJUSTMENT_WORKFLOW workflow.

buildAddItemRequest(SubscriptionItem, Subscription, ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

Builds an AddItemRequest from the given subscriptionItem, subscription and the flowName

buildAddItemRequest(SubscriptionItem, Subscription, ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

buildAddItemRequestForAddOn(ProductOption, Subscription, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

Builds a AddItemRequest for any relevant add-ons.

buildAddItemRequestsForCancellationFeeProducts(ModifySubscriptionRequest) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

Builds a List of AddItemRequest for products containing cancellation-fees.

buildAvailableAction(SWI, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

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

buildBasicSubscriptionPricingContext(Cart, CartItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildCartItemBySubscriptionIdMap(List<C>) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Builds a Map of <String, CartItem> from the rootItems for quick lookup of cartItem by its subscriptionId.

buildCreateCartRequest(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

buildCreateCartRequest(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

buildCreateCartRequest(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

Builds a CreateCartRequest from the ModifySubscriptionRequest

buildCreateCartRequest(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

Builds a CreateCartRequest from the ModifySubscriptionRequest

buildCustomerRef() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProvider

buildCustomerRefForCSR() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProvider

Builds a CustomerRef specifically for a CSR operating as themselves rather than impersonating a customer or anonymous guest.l

buildDependentSubscriptionItems(Subscription, OrderItem, SubscriptionItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Builds out creation requests for subscription items from dependent order items

buildDueNowItemDetails(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildDueNowPeriodDefinition(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Builds the period definition for the DUE NOW period.

builder() - Static method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

buildEstimatedFuturePayment(Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildEstimatedFuturePayments(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildExistingSubscriptionAdjustmentDetail(SubscriptionAdjustment, Subscription) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.SubscriptionModificationUtils

Builds a ExistingSubscriptionAdjustmentDetail for the given SubscriptionAdjustment.

buildExistingSubscriptionDetails(SubscriptionWithItems) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.SubscriptionModificationUtils

Builds a ExistingSubscriptionDetails for the given SubscriptionWithItems.

buildExistingSubscriptionItemAdjustmentDetail(SubscriptionItemAdjustment, Subscription) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.SubscriptionModificationUtils

Builds a ExistingSubscriptionItemAdjustmentDetail for the given SubscriptionItemAdjustment.

buildExistingSubscriptionItemDetail(SubscriptionItem, Subscription) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.SubscriptionModificationUtils

Builds a ExistingSubscriptionItemDetail for the given SubscriptionItem.

buildFirstFuturePeriodDefinition(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Builds the 1st future period definition, which is the period after DUE NOW.

buildFirstPageable() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultCancellationPolicyService

Builds the initial Pageable to be used in the readAll request.

buildItemAdjustmentPriceDetail(String, String, Integer, Integer, SubscriptionPricingContext) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildItemChoiceByChoiceKey(Product, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

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

buildItemDetailForCartItem(CartItem, CartItem, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildItemDetailForRemovedSubscriptionItem(SubscriptionItem, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildItemDetails(Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildItemDetailsForDependentCartItems(CartItem, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildItemDetailsForRemovedSubscriptionItems(Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildNodeFilters() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultCancellationPolicyService

Builds the Node filters for the CancellationPolicyProvider.readAll(Node, Pageable, ContextInfo) requests.

buildNotFoundException(WebClientResponseException.NotFound) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.AbstractExternalProvider

Builds a not found exception that correlates to the given WebClientResponseException.NotFound exception.

buildPendingSubscriptionItemAdjustmentRemovalDetail(SubscriptionItemAdjustment, SubscriptionItem, Map<String, Subscription>) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

Builds a PendingSubscriptionItemAdjustmentRemoval detail for the given SubscriptionItemAdjustment.

buildPendingSubscriptionItemAdjustmentRemovalDetails(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

Builds a list of SubscriptionItemAdjustmentToRemoves representing details of the subscription item adjustments that will be removed as a result of the subscription cancellation.

buildPendingSubscriptionItemAdjustmentRemovalDetailsForItem(Set<String>, SubscriptionItem, Map<String, Subscription>) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

buildPeriodDefinitions(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

buildPolicyRef(C) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultCancellationPolicyService

Builds the CancellationPolicyRef based on the given CancellationPolicy.

buildPriceCartRequest(Subscription, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

Build the PriceCartRequest for pricing the cart.

buildPriceCartRequest(Subscription, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.SubscriptionModificationUtils

Build the PriceCartRequest for pricing the cart.

buildReadProductsByIdsFilters(Collection<String>) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProvider

Build the RSQL filters in a String form used for reading the products by IDs.

buildRemovedAdjustment(List<? extends Adjustment>) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Builds a RemovedAdjustment for the given Adjustment that was lost due to modifications to an existing Subscription.

buildRootItemRequestWithDependents(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

Builds a AddItemRequest for the root upgrade/downgrade item.

buildSubscription(SubscriptionCreationRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

buildSubscriptionAdjustments(CreateSubscriptionFromOrderRequest, OrderItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Hookpoint for building SubscriptionAdjustments from an Order.

buildSubscriptionItem(Subscription, OrderItem, OrderItem, SubscriptionItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Builds out a request to create a subscription item.

buildSubscriptionItemAdjustment(Subscription, SubscriptionItem, OrderItem, Adjustment) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Builds out a subscription item adjustment from an order or order item adjustment

buildSubscriptionItemAdjustments(Subscription, SubscriptionItem, OrderItem, List<Adjustment>) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Builds subscription item adjustments for item adjustments of type DefaultAdjustmentType.RECURRING_DISCOUNT.

buildSubscriptionItems(Subscription, OrderItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Builds out subscription item creation requests the root order item for the subscription and potential dependent order items.

buildSubscriptionItems(SubscriptionCreationRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

buildSubscriptionPricingContext(Cart, CartItem, SubscriptionWithItems, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Builds out a SubscriptionPricingContext containing all the important contextual information needed to price subscriptions in a Cart.

buildSubscriptionWithItems(CreateSubscriptionFromOrderRequest, OrderItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Builds out a SubscriptionWithItems for a given root OrderItem.

buildSubscriptionWithItems(CreateSubscriptionFromOrderRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Builds SubscriptionsWithItems to be created based on the given Order.

buildSubscriptionWithItems(SubscriptionCreationRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

buildUpdatePriceDataWorkflowContext(String, PriceChangeRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

Builds the context for the DefaultWorkflowNameConstants.SUBSCRIPTION_BULK_PRICING_UPDATE_WORKFLOW workflow.

buildUserSubscriptionSummary(String, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultUserSubscriptionSummaryService

buildUserSubscriptionSummary(String, String, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.UserSubscriptionSummaryService

Reads a UserSubscriptionSummary for a user with a particular userRef, and userRefType.

BULK_PRICE_UPDATE_SUBSCRIPTION_REQUEST_EXCLUDED_SEGMENTS - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

BULK_PRICE_UPDATE_SUBSCRIPTION_REQUEST_INCLUDED_SEGMENTS - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

BULK_PRICE_UPDATE_SUBSCRIPTION_REQUEST_PRICE_CHANGE_EFFECTIVE_TYPE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

BULK_PRICE_UPDATE_SUBSCRIPTION_REQUEST_PRICE_CHANGE_SCOPE_TYPE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

BulkPriceUpdateSubscriptionRequest - Class in com.broadleafcommerce.subscriptionoperation.web.domain

A DTO used to engage bulk update of pricing on all subscriptions identified as in-scope.

BulkPriceUpdateSubscriptionRequest() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

bulkUpdateSubscriptionPricing(BulkPriceUpdateSubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

bulkUpdateSubscriptionPricing(BulkPriceUpdateSubscriptionRequest, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionPricingService

Adds a price data change for all qualifying subscriptions.

bulkUpdateSubscriptionPricing(BulkPriceUpdateSubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionPricingEndpoint

C

calculateCreditedAmountTotal(List<T>, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

For a SubscriptionPriceResponse, determines the amount to credit to the user during a subscription flow.

calculatePriorUnbilledAmountTotal(List<T>, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

For a SubscriptionPriceResponse, determines the amount that has not been billed for the current billing period at the time of the current subscription action.

calculateProratedAmountTotal(List<T>, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

For a SubscriptionPriceResponse, determines the amount owed for the rest of the billing period based on how much of the billing period has elapsed at the time of the subscription action.

canCancelSubscription(SubscriptionWithItems, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

Determines whether the current subscription can be cancelled.

CANCEL - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

A customer-driven request to cancel the subscription

CANCEL - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionType

A customer-driven request to cancel the subscription

CANCEL - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.EndOfTermStrategy

Declares that the subscription will be cancelled

CANCEL_AUTO_RENEWAL - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultCancellationStrategy

If the subscription is auto-renewing, then this will turn off auto-renewal.

canceledSubscriptionStatusHandler() - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration.SubscriptionStatusChangeHandlersConfiguration

CanceledSubscriptionStatusHandler<SWI extends SubscriptionWithItems> - Class in com.broadleafcommerce.subscriptionoperation.service.status

The default handler that validates if the Subscription status can be changed to SubscriptionStatuses.CANCELLED

CanceledSubscriptionStatusHandler() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.status.CanceledSubscriptionStatusHandler

CANCELLATION_FEE_PRODUCT - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionActionConstants

Name of the attribute on SubscriptionAction.getActionInfo() that stores the available cancellation-policy's cancellation-fee product for action type of DefaultSubscriptionActionType.CANCEL if applicable.

CANCELLATION_POLICY - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

The subscription cannot be cancelled because its cancellation-policy does not allow so.

CANCELLATION_POLICY - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartAttributeConstants

Where the CancellationPolicy is stored on the cart.

CANCELLATION_POLICY - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionActionConstants

Name of the attribute on SubscriptionAction.getActionInfo() that stores the available cancellation-policy's Id for action type of DefaultSubscriptionActionType.CANCEL

CANCELLATION_POLICY_ID - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartAttributeConstants.Internal

The Id of the CancellationPolicy for a subscription.

CANCELLATION_POLICY_ID - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

The Id of the CancellationPolicy for a subscription.

CancellationPolicy - Class in com.broadleafcommerce.subscriptionoperation.domain

Represents the cancellation policy for subscriptions.

CancellationPolicy() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

CancellationPolicyDetail - Class in com.broadleafcommerce.subscriptionoperation.domain

Represents the details of a CancellationPolicy.

CancellationPolicyDetail() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

CancellationPolicyOperationEndpoint - Class in com.broadleafcommerce.subscriptionoperation.web.endpoint

Endpoint related to CancellationPolicies

CancellationPolicyOperationEndpoint(CancellationPolicyService<CancellationPolicy>) - Constructor for class com.broadleafcommerce.subscriptionoperation.web.endpoint.CancellationPolicyOperationEndpoint

CancellationPolicyProvider<C extends CancellationPolicy> - Interface in com.broadleafcommerce.subscriptionoperation.service.provider

Provider interfacing with a service or datastore providing catalog entity details for the CancellationPolicy.

CancellationPolicyService<C extends CancellationPolicy> - Interface in com.broadleafcommerce.subscriptionoperation.service

Service to perform business logic related to CancellationPolicies.

CANCELLED - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

Indicates a subscription that has been cancelled

cancelSubscriptionHandler(TypeFactory, SubscriptionModificationUtils, CancellationPolicyProvider<CancellationPolicy>, CartOperationProvider<Cart>, SubscriptionCancellationProperties, SubscriptionOperationUtils, SubscriptionProvider<SubscriptionWithItems, Subscription, SubscriptionOwnerInfo>, SubscriptionOperationServiceProperties) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Category

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionAdjustmentDetail

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemAdjustmentDetail

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChangeRequest

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAction

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.UserSubscriptionSummary

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationJpaProperties

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationProviderProperties

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SSLVerificationProperties

Deprecated.

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProviderProperties

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProviderProperties

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProviderProperties

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOfferProviderProperties

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProviderProperties

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionPricingProperties

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateSubscriptionFromOrderRequest

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyRequest

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyResponse

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionResponse

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.PriceCartRequest

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionRequest

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionResponse

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

canEqual(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.UpdateSubscriptionStatusRequest

canHandle(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

canHandle(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

canHandle(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateDowngradeSubscriptionHandler

canHandle(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

canHandle(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateUpgradeSubscriptionHandler

canHandle(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.status.ActiveSubscriptionStatusHandler

canHandle(ModifySubscriptionRequest, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.modification.ModifySubscriptionHandler

Determines whether the handler can handle the ModifySubscriptionRequest.

canHandle(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.status.CanceledSubscriptionStatusHandler

canHandle(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.status.FulfillmentInProcessSubscriptionStatusHandler

canHandle(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.status.PausedSubscriptionStatusHandler

canHandle(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.status.PendingCancellationSubscriptionStatusHandler

canHandle(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.status.SubscriptionStatusHandler

Determines if this handler can handle the status change.

CART_ATTRIBUTE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultProductOptionType

The user input flow into a global cart-level attribute when added to cart.

CART_ITEM_ATTRIBUTE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultProductOptionType

The user value is intended to flow into an item attribute once this item is added to the cart.

CartAttributeConstants - Class in com.broadleafcommerce.subscriptionoperation.domain.constants

CartAttributeConstants() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.constants.CartAttributeConstants

CartAttributeConstants.Internal - Class in com.broadleafcommerce.subscriptionoperation.domain.constants

CartItemAttributeConstants - Class in com.broadleafcommerce.subscriptionoperation.domain.constants

CartItemAttributeConstants() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants

CartItemAttributeConstants.Internal - Class in com.broadleafcommerce.subscriptionoperation.domain.constants

CartOperationProvider<C extends com.broadleafcommerce.cart.client.domain.Cart> - Interface in com.broadleafcommerce.subscriptionoperation.service.provider

Component responsible for interacting with a Cart Operations provider to act against user carts.

CatalogProvider<P extends Product> - Interface in com.broadleafcommerce.subscriptionoperation.service.provider

Provider interfacing with a service or datastore providing catalog entity details for the Subscription.

Category - Class in com.broadleafcommerce.subscriptionoperation.domain

Categories provide a way to group related Products for merchandising, marketing, and search results.

Category() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.Category

CATEGORY - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceTargetType

The item choice is among Products within a Category.

CHANGE_AUTO_RENEWAL - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

A request to opt-into or out of auto-renewal for the subscription.

CHANGE_AUTO_RENEWAL - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionType

A request to opt-into or out of auto-renewal for the subscription.

changeSubscriptionAutoRenewalHandler(TypeFactory, SubscriptionModificationUtils, SubscriptionProvider<SubscriptionWithItems, Subscription, SubscriptionOwnerInfo>, MessageSource) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

ChangeSubscriptionAutoRenewalHandler - Class in com.broadleafcommerce.subscriptionoperation.service.modification

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

ChangeSubscriptionAutoRenewalHandler(TypeFactory, SubscriptionModificationUtils, SubscriptionProvider<SubscriptionWithItems, Subscription, SubscriptionOwnerInfo>, MessageSource) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

CHOOSE_MULTIPLE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceSelectionType

The customer can choose multiple of the specified target items.

CHOOSE_ONE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceSelectionType

The customer can only choose one of the specified target items.

clearLock(String, boolean) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

clearLock(String, boolean) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

clearLock(String, boolean) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Clear a lock for a subscription

clearLock(String, boolean) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

Forcefully clear a lock on a subscription.

clearLock(String, boolean) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

Forcefully clear a lock on a subscription.

com.broadleafcommerce.subscriptionoperation.autoconfigure - package com.broadleafcommerce.subscriptionoperation.autoconfigure

com.broadleafcommerce.subscriptionoperation.domain - package com.broadleafcommerce.subscriptionoperation.domain

com.broadleafcommerce.subscriptionoperation.domain.constants - package com.broadleafcommerce.subscriptionoperation.domain.constants

com.broadleafcommerce.subscriptionoperation.domain.enums - package com.broadleafcommerce.subscriptionoperation.domain.enums

com.broadleafcommerce.subscriptionoperation.domain.offer - package com.broadleafcommerce.subscriptionoperation.domain.offer

com.broadleafcommerce.subscriptionoperation.domain.offer.type - package com.broadleafcommerce.subscriptionoperation.domain.offer.type

com.broadleafcommerce.subscriptionoperation.domain.pricing - package com.broadleafcommerce.subscriptionoperation.domain.pricing

com.broadleafcommerce.subscriptionoperation.domain.pricing.type - package com.broadleafcommerce.subscriptionoperation.domain.pricing.type

com.broadleafcommerce.subscriptionoperation.exception - package com.broadleafcommerce.subscriptionoperation.exception

com.broadleafcommerce.subscriptionoperation.i18n.autoconfigure - package com.broadleafcommerce.subscriptionoperation.i18n.autoconfigure

com.broadleafcommerce.subscriptionoperation.oauth2.client.endpoint - package com.broadleafcommerce.subscriptionoperation.oauth2.client.endpoint

com.broadleafcommerce.subscriptionoperation.oauth2.client.web - package com.broadleafcommerce.subscriptionoperation.oauth2.client.web

com.broadleafcommerce.subscriptionoperation.provider.jpa.autoconfigure - package com.broadleafcommerce.subscriptionoperation.provider.jpa.autoconfigure

com.broadleafcommerce.subscriptionoperation.provider.jpa.environment - package com.broadleafcommerce.subscriptionoperation.provider.jpa.environment

com.broadleafcommerce.subscriptionoperation.service - package com.broadleafcommerce.subscriptionoperation.service

com.broadleafcommerce.subscriptionoperation.service.autoconfigure - package com.broadleafcommerce.subscriptionoperation.service.autoconfigure

com.broadleafcommerce.subscriptionoperation.service.enums - package com.broadleafcommerce.subscriptionoperation.service.enums

com.broadleafcommerce.subscriptionoperation.service.exception - package com.broadleafcommerce.subscriptionoperation.service.exception

com.broadleafcommerce.subscriptionoperation.service.modification - package com.broadleafcommerce.subscriptionoperation.service.modification

com.broadleafcommerce.subscriptionoperation.service.provider - package com.broadleafcommerce.subscriptionoperation.service.provider

com.broadleafcommerce.subscriptionoperation.service.provider.external - package com.broadleafcommerce.subscriptionoperation.service.provider.external

com.broadleafcommerce.subscriptionoperation.service.provider.page - package com.broadleafcommerce.subscriptionoperation.service.provider.page

com.broadleafcommerce.subscriptionoperation.service.status - package com.broadleafcommerce.subscriptionoperation.service.status

com.broadleafcommerce.subscriptionoperation.web.autoconfigure - package com.broadleafcommerce.subscriptionoperation.web.autoconfigure

com.broadleafcommerce.subscriptionoperation.web.domain - package com.broadleafcommerce.subscriptionoperation.web.domain

com.broadleafcommerce.subscriptionoperation.web.endpoint - package com.broadleafcommerce.subscriptionoperation.web.endpoint

com.broadleafcommerce.subscriptionoperation.web.endpoint.exception - package com.broadleafcommerce.subscriptionoperation.web.endpoint.exception

compareTo(ProductOption) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

create(SWI, boolean, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

create(SWI, boolean, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Persists a subscription alongside its items

create(SWI, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Persists a subscription alongside its items

CREATE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

A request to create a new subscription

createCart(CreateCartRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProvider

createCart(CreateCartRequest, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.CartOperationProvider

Method used to create a new Cart.

CreateCartRequest - Class in com.broadleafcommerce.subscriptionoperation.web.domain

A request DTO used to create a new Cart.

CreateCartRequest() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

created(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus.LockStatusBuilder

The time the lock was created

createNewSubscriptions(CreateSubscriptionFromOrderRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

createNewSubscriptions(CreateSubscriptionFromOrderRequest, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionGenerationService

Given the provided Order and its items, creates one or more Subscription and related items.

createOrReturnIfExists(SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

createOrReturnIfExists(SWI, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Persists a subscription alongside its items.

createSubscription(SubscriptionCreationRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

createSubscriptionFromOrder(CreateSubscriptionFromOrderRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

createSubscriptionFromOrder(CreateSubscriptionFromOrderRequest, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

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

createSubscriptionFromOrder(CreateSubscriptionFromOrderRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

CreateSubscriptionFromOrderRequest - Class in com.broadleafcommerce.subscriptionoperation.web.domain

Represents a request to create one or more Subscriptions based on a given Order and its Fulfillments.

CreateSubscriptionFromOrderRequest() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.CreateSubscriptionFromOrderRequest

createSubscriptionWithItems(SubscriptionCreationRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

createSubscriptionWithItems(SubscriptionCreationRequest, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

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

createToken(String, String) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

createToken(String, String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

createToken(String, String) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Create a reservation token for a child lock

createToken(String, String) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

Create a child lock on a subscription.

createToken(String, String) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

Create a child lock on a subscription.

CREDITED_UNIT_AMOUNT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

For edits, upgrades, and downgrades on a subscription that’s using an DefaultSubscriptionPaymentStrategy.PREPAID payment strategy, the customer has already paid the full amount for this billing cycle at the previous rate.

CREDITED_UNIT_DISCOUNT_AMOUNT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

The subscription item discount per unit to be deducted from the DefaultSubscriptionPriceDetailType.CREDITED_UNIT_AMOUNT.

CSR_ADD_ADJUSTMENT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

A CSR-driven action to add one or more adjustments to the subscription

CURRENT_PERIOD - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.offer.type.AdjustmentApplicationDateType

The SubscriptionItemAdjustment is added immediately onto the SubscriptionItem.

CUSTOMER_REF_HEADER - Static variable in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProvider

Header used to build the CustomerRef for the authenticated user while using a service client to call CartOps.

CUSTOMER_SEGMENTS - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.pricing.type.PriceDataAppliesToType

The PriceChangeRequest is applied for users matching the configured customer segments.

CUSTOMER_SUBSCRIPTION_PERMISSION_ROOT - Static variable in class com.broadleafcommerce.subscriptionoperation.web.endpoint.CustomerSubscriptionOperationEndpoint

CUSTOMER_TIMEZONE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartAttributeConstants.Internal

The customer's timezone.

CustomerProvider<F extends FilteredAccounts> - Interface in com.broadleafcommerce.subscriptionoperation.service.provider

Provider interfacing with a service or datastore providing customer entity details for the Subscription.

CustomerSubscriptionOperationEndpoint - Class in com.broadleafcommerce.subscriptionoperation.web.endpoint

CustomerSubscriptionOperationEndpoint(SubscriptionOperationService<SubscriptionWithItems>, SubscriptionAccessValidationService, TypeFactory) - Constructor for class com.broadleafcommerce.subscriptionoperation.web.endpoint.CustomerSubscriptionOperationEndpoint

D

DAYS - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultTermDurationType

DEFAULT_PAGE_SIZE - Static variable in class com.broadleafcommerce.subscriptionoperation.service.DefaultCancellationPolicyService

DefaultAdjustmentOwnerType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Represents the default values for owning entity types of Subscription Adjustments.

DefaultCancellationChargeStrategy - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

The strategy for charging a cancellation fee when a customer cancels a subscription.

DefaultCancellationPolicyService<C extends CancellationPolicy> - Class in com.broadleafcommerce.subscriptionoperation.service

Default implementation of CancellationPolicyService.

DefaultCancellationPolicyService(CancellationPolicyProvider<C>, RuleEvaluationService, TypeFactory) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.DefaultCancellationPolicyService

DefaultCancellationStrategy - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

The strategy using which a subscription can be cancelled.

DefaultDelayedSubscriptionActionEffectiveType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Describes how the effective date of a delayed subscription action should be determined.

DefaultDelayedSubscriptionActionType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Describes the type of delayed subscription action that will be applied in the future.

DefaultItemChoiceSelectionType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Describes restrictions placed on the customer's ability to select items from the targeted set.

DefaultItemChoiceTargetType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

The possible types of targets a ItemChoice can have.

DefaultPriceChangeEffectiveType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Describes how the effective date of a subscription price change should be determined.

DefaultPriceChangeScopeType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Represents the default types of account scope for which subscription bulk price changes can be applied.

DefaultProductOptionType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Out of the box forms that a ProductOption can take.

DefaultShortenedPeriodReason - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Enum values describing the reason for a subscription's period to be shortened.

DefaultSpecificItemChoiceType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Supported types for SpecificItemChoice.getType()

DefaultStartChangeAutoRenewalWorkflowService - Class in com.broadleafcommerce.subscriptionoperation.service

DefaultStartChangeAutoRenewalWorkflowService(WorkflowProvider) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.DefaultStartChangeAutoRenewalWorkflowService

DefaultSubscriptionAccessValidationService - Class in com.broadleafcommerce.subscriptionoperation.service

Default implementation of SubscriptionAccessValidationService

DefaultSubscriptionAccessValidationService(AuthenticationUtils) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionAccessValidationService

DefaultSubscriptionActionFlow - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Describes the potential actions that can be taken against a subscription.

DefaultSubscriptionActionType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

The default types of actions that can be taken against a Subscription by the user.

DefaultSubscriptionActionUnavailableReasons - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

The default reasons on why an action is unavailable for a Subscription.

DefaultSubscriptionAdjustmentType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

DefaultSubscriptionGenerationService<SWI extends SubscriptionWithItems> - Class in com.broadleafcommerce.subscriptionoperation.service

DefaultSubscriptionGenerationService(SubscriptionProvider<SWI, Subscription, SubscriptionOwnerInfo>, SubscriptionOperationUtils, MessageSource, TypeFactory) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

DefaultSubscriptionItemReferenceType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Enumerates the types of subscription item references.

DefaultSubscriptionNextStatusChangeReason - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

The default reasons for the Subscription.getNextStatusChangeReason().

DefaultSubscriptionOperationService<SWI extends SubscriptionWithItems> - Class in com.broadleafcommerce.subscriptionoperation.service

DefaultSubscriptionOperationService(SubscriptionProvider<SWI, Subscription, SubscriptionOwnerInfo>, SubscriptionValidationService, TypeFactory, List<ModifySubscriptionHandler>, CatalogProvider<Product>, CancellationPolicyProvider<CancellationPolicy>, SubscriptionGenerationService<SWI>, SubscriptionOperationUtils, WorkflowProvider, SubscriptionOperationServiceProperties, MessageSource) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

DefaultSubscriptionOrderHistoryService<O extends com.broadleafcommerce.order.client.domain.Order> - Class in com.broadleafcommerce.subscriptionoperation.service

Default implementation of SubscriptionOrderHistoryService

DefaultSubscriptionOrderHistoryService(SubscriptionProvider<SubscriptionWithItems, Subscription, SubscriptionOwnerInfo>, OrderProvider<O>) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOrderHistoryService

DefaultSubscriptionPaymentStrategy - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Declares that payments made against a subscription are going towards the goods/services rendered in the previous vs current period.

DefaultSubscriptionPeriodType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Enumerates the types of subscription period types.

DefaultSubscriptionPriceDetailType - Enum Class in com.broadleafcommerce.subscriptionoperation.service.enums

Defines the default supported types of prices on a SubscriptionItemPriceDetail or SubscriptionPriceResponse.

DefaultSubscriptionPricingService - Class in com.broadleafcommerce.subscriptionoperation.service

DefaultSubscriptionPricingService(SubscriptionProvider<SubscriptionWithItems, Subscription, SubscriptionOwnerInfo>, TypeFactory, CancellationPolicyProvider<CancellationPolicy>, SubscriptionOperationUtils, SubscriptionPricingProperties, CustomerProvider<FilteredAccounts>, WorkflowProvider) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

DefaultSubscriptionSourceType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Enumerates the types of subscription sources.

DefaultSubscriptionValidationService - Class in com.broadleafcommerce.subscriptionoperation.service

DefaultSubscriptionValidationService(CatalogProvider<Product>) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionValidationService

DefaultTermDurationType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Defines the default term duration types possible for recurring prices.

DefaultUserRefTypes - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

DefaultUserSubscriptionSummaryService<U extends UserSubscriptionSummary,SWI extends SubscriptionWithItems> - Class in com.broadleafcommerce.subscriptionoperation.service

Default implementation of UserSubscriptionSummaryService

DefaultUserSubscriptionSummaryService(TypeFactory, SubscriptionProvider<SWI, Subscription, SubscriptionOwnerInfo>, SubscriptionOperationServiceProperties, SubscriptionModificationUtils) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.DefaultUserSubscriptionSummaryService

DefaultWorkflowNameConstants - Class in com.broadleafcommerce.subscriptionoperation.service.enums

Defines names of workflows used in SubscriptionOperationServices.

delayDateBasedOnAdjustmentsForCustomLengthUnits(String, int, ZonedDateTime, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

DelayedSubscriptionAction - Class in com.broadleafcommerce.subscriptionoperation.domain

Simple object describing a subscription action that should be applied in the future.

DelayedSubscriptionAction() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

determineChargeForPreviouslyDiscountedPeriods(SubscriptionItemAdjustmentPriceDetail, SubscriptionPricingContext, SubscriptionItemAdjustment, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the amount to charge the customer for the previously received discounts in previous periods if CancellationPolicyDetail.isChargeForPreviouslyReceivedDiscountAmounts() is true.

determineChargeForPreviouslyDiscountedPeriodsBeforeCurrentPeriod(SubscriptionPricingContext, SubscriptionItemAdjustment, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the amount to charge the customer for the previously received discounts in previous periods.

determineChargeForPreviouslyDiscountedPeriodsForCurrentPeriod(SubscriptionItemAdjustmentPriceDetail, SubscriptionPricingContext, SubscriptionItemAdjustment, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the amount to charge the customer for the previously received discounts in the current period.

determineCreditedDiscountUnitAmountForCancellationFlow(SubscriptionPricingContext, SubscriptionItemAdjustment, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineCreditedDiscountUnitAmountForCustomCancellationChargeStrategy(SubscriptionPricingContext, SubscriptionItemAdjustment, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineCreditedUnitAmount(SubscriptionPricingContext, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

For a SubscriptionItemPriceDetail, determines the unit amount to credit to the user during a subscription flow.

determineCreditedUnitAmountForCancellationFlow(SubscriptionPricingContext, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the unit amount to credit to the user during a cancellation flow.

determineCreditedUnitAmountForCreateFlow(SubscriptionPricingContext, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the unit amount to credit to the user during a create flow.

determineCreditedUnitAmountForCurrentPeriod(SubscriptionPricingContext, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the amount to credit to the customer based on when in the current billing period a pricing request occurs.

determineCreditedUnitAmountForCurrentPeriodForBillingFrequencyChange(MonetaryAmount, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineCreditedUnitAmountForCustomCancellationChargeStrategy(SubscriptionPricingContext, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Hook point for custom cancellation charge strategies.

determineCreditedUnitAmountForCustomFlow(SubscriptionPricingContext, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Hook point for non-default action flows.

determineCreditedUnitAmountForModificationFlow(SubscriptionPricingContext, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the unit amount to credit to the user during a modification flow (e.g., edit, upgrade, downgrade).

determineCreditedUnitDiscountAmount(SubscriptionItemAdjustment, String, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the unit amount to be discounted from the credited unit amount.

determineCreditedUnitDiscountAmountForCurrentPeriod(SubscriptionPricingContext, SubscriptionItemAdjustment, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the discount amount that should be deducted from the customer's credited amount based on when in the current billing period a pricing request occurs.

determineCreditedUnitDiscountAmountForCustomFlow(SubscriptionPricingContext, SubscriptionItemAdjustment, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineCreditedUnitDiscountAmountForModificationFlow(SubscriptionPricingContext, SubscriptionItemAdjustment, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineDiscountForRemainderOfTerm(SubscriptionItemAdjustmentPriceDetail, SubscriptionPricingContext, SubscriptionItemAdjustment, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the discounts to be applied to the remainder of the terms charge if you are being charged for the remainder of the terms, unless full price is charged for the remainder of terms.

determineDiscountForRemainderOfTermCurrentPeriod(SubscriptionItemAdjustmentPriceDetail, SubscriptionPricingContext, SubscriptionItemAdjustment, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the discounts to be applied to the remainder of the terms charge for the current period if you are being charged for the remainder of the terms, unless full price is charged for the remainder of terms.

determineDiscountForRemainderOfTermFuturePeriods(SubscriptionPricingContext, SubscriptionItemAdjustment, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the discounts to be applied to the remainder of the terms charge if you are being charged for the remainder of the terms, unless full price is charged for the remainder of terms.

determineEndOfTermsDate(Order, OrderItem, Instant, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Determines the end of terms date for a subscription based on the order and order item.

determineEndOfTermsDate(Instant, String, int, String) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

determineEndOfTermsDateForCustomDurationType(Instant, String, int) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

determineFulfillmentWorkflow(CreateSubscriptionFromOrderRequest, OrderItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Identifies the subscription's fulfillment workflow.

determineItemPaymentStrategy(OrderItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Determines the SubscriptionCreationRequest.getPaymentStrategy() for a subscription.

determineItemQuantity(SubscriptionReferencedItem, int) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

Determines the quantity of the SubscriptionReferencedItem to be upgraded or downgraded to based on its min and max thresholds and the existing SubscriptionItem's quantity.

determineNextBillDateForExistingSubscription(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the next bill date for an existing subscription, which is unchanged from the SubscriptionPricingContext.getExistingSubscription()'s Subscription.getNextBillDate().

determineNextBillDateForNewSubscription(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the next bill date for a newly signed up subscription, which is the subscription action date / signup date + 1 period.

determineNextPeriod(OrderItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Determines the Subscription.getNextPeriod() for a subscription.

determineNumberOfDaysInFullPeriod(Instant, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

determinePeriodEndDate(PeriodDefinition, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determinePeriodsLeftToReceiveDiscount(SubscriptionPricingContext, SubscriptionItemAdjustment, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the number of periods left to receive discount for calculating the remainder of terms discount for future periods.

determinePeriodStartDate(Instant, Instant, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determinePricePerDay(MonetaryAmount, PeriodDefinition, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the price per day for the given PeriodDefinition.

determinePricePerDayForCurrentPeriod(MonetaryAmount, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the price per day for the current period.

determinePriorUnbilledDiscountUnitAmountForCancellationFlow(SubscriptionPricingContext, SubscriptionItemAdjustment, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the discount amount that should be deducted from the customer's prior unbilled amount for immediate cancellation scenario.

determinePriorUnbilledDiscountUnitAmountForCurrentPeriod(SubscriptionPricingContext, SubscriptionItemAdjustment, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the discount amount that should be deducted from the customer's prior unbilled amount for the current period.

determinePriorUnbilledDiscountUnitAmountForCustomCancellationStrategy(SubscriptionPricingContext, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determinePriorUnbilledUnitAmount(SubscriptionPricingContext, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

For a SubscriptionItemPriceDetail, determines the unit amount that has not been billed for the current billing period at the time of the current subscription action.

determinePriorUnbilledUnitAmountForCancellationFlow(SubscriptionPricingContext, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the unit amount that has not been billed for the current billing period during a cancellation flow.

determinePriorUnbilledUnitAmountForCreateFlow(SubscriptionPricingContext, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the unit amount that has not been billed for the current billing period during a create flow.

determinePriorUnbilledUnitAmountForCurrentPeriod(SubscriptionPricingContext, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the prior unbilled unit amount for the current billing period.

determinePriorUnbilledUnitAmountForCustomCancellationStrategy(SubscriptionPricingContext, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Hook point for custom cancellation strategy values.

determinePriorUnbilledUnitAmountForCustomFlow(SubscriptionPricingContext, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Hook point for non-default action flows.

determinePriorUnbilledUnitAmountForImmediateCancellation(SubscriptionPricingContext, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the prior unbilled amount to charge the customer for an DefaultCancellationStrategy.IMMEDIATE cancellation.

determinePriorUnbilledUnitAmountForModificationFlow(SubscriptionPricingContext, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the unit amount that has not been billed for the current billing period during a modification flow (e.g., edit, upgrade, or downgrade).

determinePriorUnbilledUnitDiscountAmount(SubscriptionItemAdjustment, String, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determinePriorUnbilledUnitDiscountAmountForCustomFlow(SubscriptionPricingContext, SubscriptionItemAdjustment, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determinePriorUnbilledUnitDiscountAmountForModificationFlow(SubscriptionPricingContext, SubscriptionItemAdjustment, String, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineProratedAmount(MonetaryAmount, PeriodDefinition, SubscriptionPricingContext, long, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineProratedAmountBetweenActionAndNextBillDate(CartItem, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineProratedAmountBetweenActionAndNextBillDate(MonetaryAmount, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the prorated amount between the action date and the next bill date for a given MonetaryAmount.

determineProratedAmountBetweenPeriodStartAndActionDate(MonetaryAmount, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the prorated amount between the period start date and action date for a given MonetaryAmount.

determineProratedAmountForCurrentPeriod(MonetaryAmount, SubscriptionPricingContext, long, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineProratedAmountFromOldPeriodStartDateToActionDateForBillingFrequencyChange(MonetaryAmount, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the prorated amount for the period between the original period start date to the action date for when the billing frequency changes.

determineProratedUnitAmount(CartItem, CartItem, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

For a SubscriptionItemPriceDetail, determines the amount owed for the rest of the billing period based on how much of the billing period has elapsed at the time of the subscription action.

determineProratedUnitAmountForCancellationFlow(CartItem, SubscriptionPricingContext, CartItem, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the prorated amount for a subscription cart item for a cancellation flow.

determineProratedUnitAmountForCreateFlow(CartItem, CartItem, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineProratedUnitAmountForCustomCancellationStrategy(CartItem, SubscriptionPricingContext, CartItem, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Hook point for custom cancellation strategy values.

determineProratedUnitAmountForCustomFlow(CartItem, SubscriptionPricingContext, CartItem, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Hook point to handle determining the prorated unit amount for an item during a non-default action flow.

determineProratedUnitAmountForImmediateCancellation(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the prorated unit amount during an immediate cancellation request.

determineProratedUnitAmountForModificationFlow(CartItem, CartItem, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the prorated unit amount for a subscription cart item for a modification flow (edit, upgrade, or downgrade).

determineProratedUnitDiscountAmount(CartItem, Adjustment, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineProratedUnitDiscountAmountForCancellationFlow(CartItem, SubscriptionPricingContext, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the prorated discount amount for a subscription cart item for a cancellation flow.

determineProratedUnitDiscountAmountForCreateFlow(Adjustment, CartItem, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineProratedUnitDiscountAmountForCustomFlow(CartItem, SubscriptionPricingContext, Integer, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineProratedUnitDiscountAmountForModificationFlow(Adjustment, CartItem, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineRemovedAdjustments(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines which Adjustments have been removed due to modifications to an existing Subscription.

determineStartDateOfNextPeriod(Instant, String, int, boolean, Instant, String) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

Determines the Instant when the billing period subsequent to the given periodStartDate begins.

determineStartingSubscriptionStatus(CreateSubscriptionFromOrderRequest, OrderItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Hook point to determine the starting status of a subscription.

determineStartOfTermsDate(CartItem, String, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineStartOfTermsDate(Order, OrderItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Determines the date the terms start for the subscription if there are terms.

determineUnbilledDiscountUnitAmountForCurrentPeriodDuringCancellationForCustomChargeStrategy(SubscriptionPricingContext, SubscriptionItemAdjustment, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineUnbilledUnitAmountForCurrentPeriodDuringCancellation(SubscriptionPricingContext, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the amount to bill the customer for the current period in which a cancellation request is received.

determineUnbilledUnitAmountForCurrentPeriodDuringCancellationForCustomChargeStrategy(SubscriptionPricingContext, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Hook point for custom charge strategies when inside a grace period to determine the unbilled unit amount for the current period.

determineUnbilledUnitDiscountAmountForCurrentPeriodDuringCancellation(SubscriptionPricingContext, SubscriptionItemAdjustment, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

determineUnitAmountToChargeForRemainderOfTermCurrentPeriod(SubscriptionPricingContext, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the unit amount (non-discounted) to charge the customer for the current period when they cancel their subscription before the end of the term and when the cancellation strategy is DefaultCancellationStrategy.IMMEDIATE and CancellationPolicyDetail.isChargeForRemainderOfTerms().

determineUnitAmountToChargeForRemainderOfTermFuturePeriods(SubscriptionPricingContext, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the remaining amount (non-discounted) to charge the customer when they cancel their subscription before the end of the term and when the cancellation strategy is DefaultCancellationStrategy.IMMEDIATE.

DISABLED_AUTO_RENEWAL - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionNextStatusChangeReason

The Subscription's auto renewal is disabled.

DOWNGRADE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

A request to downgrade the subscription's level of service

DOWNGRADE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionType

A request to downgrade the subscription's level of service

DOWNGRADE_OPTIONS_ATTR - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionActionConstants

Name of the attribute on SubscriptionAction.getActionInfo() that stores the available downgrade options for a Subscription for action type of DefaultSubscriptionActionType.DOWNGRADE.

DOWNGRADE_WINDOW_PASSED - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

Downgrade is possible for this subscription, but the number of days before which a downgrade is allowed has passed.

E

EDIT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

A request to edit the subscription's configuration

EDIT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionType

A request to edit the subscription's configuration

EnabledGranularOrFlex() - Constructor for class com.broadleafcommerce.subscriptionoperation.provider.jpa.autoconfigure.SubscriptionOperationJpaAutoConfiguration.EnabledGranularOrFlex

END_OF_TERMS - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultShortenedPeriodReason

Declares that the subscription's period was shortened by reaching the Subscription.getEndOfTermDate()

EndOfTermStrategy - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

The strategies by which a subscription's end of term can be configured.

ENTITY_NOT_FOUND - Static variable in class com.broadleafcommerce.subscriptionoperation.service.provider.external.AbstractExternalProvider

The ApiError.getType() that indicates entity is not found.

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Category

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionAdjustmentDetail

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemAdjustmentDetail

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChangeRequest

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAction

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.UserSubscriptionSummary

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationJpaProperties

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationProviderProperties

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SSLVerificationProperties

Deprecated.

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProviderProperties

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProviderProperties

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProviderProperties

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOfferProviderProperties

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProviderProperties

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionPricingProperties

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateSubscriptionFromOrderRequest

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyRequest

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyResponse

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionResponse

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.PriceCartRequest

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionRequest

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionResponse

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

equals(Object) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.UpdateSubscriptionStatusRequest

ERROR - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

Indicates a subscription with an error state

EstimatedFuturePayment - Class in com.broadleafcommerce.subscriptionoperation.domain

Describes the timing & amount of future subscription payments.

EstimatedFuturePayment() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

executeRequest(Supplier<T>) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.AbstractExternalProvider

Executes a request with default Web Client error handling.

EXISTING_SUBSCRIPTION_DETAILS - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartAttributeConstants

Where the ExistingSubscriptionDetails are stored on the cart.

EXISTING_SUBSCRIPTION_ID - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

The id of an existing subscription.

EXISTING_SUBSCRIPTION_ITEM_ID - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

The id of an existing subscription item.

ExistingAdjustmentDetail - Class in com.broadleafcommerce.subscriptionoperation.domain

Contains details describing an existing adjustment when entering a modify-subscription flow such as for edit, upgrade, or downgrade.

ExistingAdjustmentDetail() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

ExistingSubscriptionAdjustmentDetail - Class in com.broadleafcommerce.subscriptionoperation.domain

Contains details describing an existing SubscriptionAdjustment when entering a modify-subscription flow such as for edit, upgrade, or downgrade.

ExistingSubscriptionAdjustmentDetail() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionAdjustmentDetail

ExistingSubscriptionDetails - Class in com.broadleafcommerce.subscriptionoperation.domain

Contains details describing an existing Subscription when entering a modify-subscription flow such as for edit, upgrade, or downgrade.

ExistingSubscriptionDetails() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

ExistingSubscriptionItemAdjustmentDetail - Class in com.broadleafcommerce.subscriptionoperation.domain

Contains details describing an existing SubscriptionItemAdjustment when entering a modify-subscription flow such as for edit, upgrade, or downgrade.

ExistingSubscriptionItemAdjustmentDetail() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemAdjustmentDetail

ExistingSubscriptionItemDetail - Class in com.broadleafcommerce.subscriptionoperation.domain

Contains details describing an existing SubscriptionItem when entering a modify-subscription flow such as for edit, upgrade, or downgrade.

ExistingSubscriptionItemDetail() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

expandPermissionRootsToPermissions(String[], OperationType) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionAccessValidationService

Constructs a map of <permissionRoot, [possiblePermissions]> for all the permissionRoot passed into the permissionRoots for the given OperationType.

expires(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus.LockStatusBuilder

The time the lock will expire

ExternalCancellationPolicyProvider<C extends CancellationPolicy> - Class in com.broadleafcommerce.subscriptionoperation.service.provider.external

ExternalCancellationPolicyProvider(WebClient, ObjectMapper, TypeFactory, ExternalCancellationPolicyProviderProperties) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProvider

ExternalCancellationPolicyProviderProperties - Class in com.broadleafcommerce.subscriptionoperation.service.provider.external

Configuration properties for the ExternalCancellationPolicyProvider.

ExternalCancellationPolicyProviderProperties() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProviderProperties

ExternalCartOperationProvider<C extends com.broadleafcommerce.cart.client.domain.Cart> - Class in com.broadleafcommerce.subscriptionoperation.service.provider.external

Default implementation of CartOperationProvider for interacting with an external service.

ExternalCartOperationProvider(WebClient, ObjectMapper, TypeFactory, ExternalCartOperationProviderProperties, AuthenticationUtils) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProvider

ExternalCartOperationProviderProperties - Class in com.broadleafcommerce.subscriptionoperation.service.provider.external

ExternalCartOperationProviderProperties() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProviderProperties

ExternalCatalogProvider<P extends Product> - Class in com.broadleafcommerce.subscriptionoperation.service.provider.external

ExternalCatalogProvider(WebClient, ObjectMapper, TypeFactory, ExternalCatalogProviderProperties) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProvider

ExternalCatalogProviderProperties - Class in com.broadleafcommerce.subscriptionoperation.service.provider.external

ExternalCatalogProviderProperties() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProviderProperties

ExternalCustomerProvider<F extends FilteredAccounts> - Class in com.broadleafcommerce.subscriptionoperation.service.provider.external

ExternalCustomerProvider(WebClient, ObjectMapper, TypeFactory, ExternalCustomerProviderProperties) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProvider

ExternalCustomerProviderProperties - Class in com.broadleafcommerce.subscriptionoperation.service.provider.external

ExternalCustomerProviderProperties() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProviderProperties

ExternalOfferProviderProperties - Class in com.broadleafcommerce.subscriptionoperation.service.provider.external

ExternalOfferProviderProperties() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOfferProviderProperties

ExternalOrderProvider<O extends com.broadleafcommerce.order.client.domain.Order> - Class in com.broadleafcommerce.subscriptionoperation.service.provider.external

Default implementation of OrderProvider.

ExternalOrderProvider(WebClient, ObjectMapper, TypeFactory, ExternalOrderProviderProperties) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProvider

ExternalOrderProviderProperties - Class in com.broadleafcommerce.subscriptionoperation.service.provider.external

Configuration properties for the ExternalOrderProvider.

ExternalOrderProviderProperties() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProviderProperties

ExternalSubscriptionProperties - Class in com.broadleafcommerce.subscriptionoperation.service.provider.external

ExternalSubscriptionProperties() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

ExternalSubscriptionProvider<SWI extends SubscriptionWithItems,S extends Subscription,SO extends SubscriptionOwnerInfo> - Class in com.broadleafcommerce.subscriptionoperation.service.provider.external

ExternalSubscriptionProvider(WebClient, ObjectMapper, TypeFactory, ExternalSubscriptionProperties) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

F

FilteredAccounts - Class in com.broadleafcommerce.subscriptionoperation.domain

Filtered, valid accounts based on a list of candidate accounts narrowed by inclusion and exclusion customer segments.

FilteredAccounts() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

FilteredAccounts(Set<String>, Set<String>, Set<String>, Set<String>, Map<String, Object>) - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

Creates a new FilteredAccounts instance.

filterSubscriptionOwnerInfosBySegments(BulkPriceUpdateSubscriptionRequest, List<SubscriptionOwnerInfo>, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Filters the SubscriptionOwnerInfo in the given Page by the segments in the given BulkPriceUpdateSubscriptionRequest.

FIXED_PRICE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionAdjustmentType

Replace the amount with a fixed price.

flattenDependentCartItems(List<CartItem>, CartItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Flattens the dependents and sub-dependents etc.

FULFILLMENT_IN_PROCESS - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

Indicates that the subscription sign-up or modification is being fulfilled.

FULFILLMENT_WORKFLOW - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

Describes the workflow used to fulfill the cart item

fulfillmentInProcessSubscriptionStatusHandler() - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration.SubscriptionStatusChangeHandlersConfiguration

FulfillmentInProcessSubscriptionStatusHandler<SWI extends SubscriptionWithItems> - Class in com.broadleafcommerce.subscriptionoperation.service.status

The default handler that validates if the Subscription status can be changed to SubscriptionStatuses.FULFILLMENT_IN_PROCESS

FulfillmentInProcessSubscriptionStatusHandler() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.status.FulfillmentInProcessSubscriptionStatusHandler

G

generateCartName(Subscription) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

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

generateCartName(Subscription, String) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.SubscriptionModificationUtils

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

getAccessibleSubscriptions(String[], Collection<SWI>, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionAccessValidationService

getAccessibleSubscriptions(String[], Page<SWI>, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionAccessValidationService

getAccessibleSubscriptions(String[], Collection<SWI>, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionAccessValidationService

Filters a Collection of the subscriptionWithItems and returns those subscriptions that are accessible to the current user (customer or account).

getAccessibleSubscriptions(String[], Page<SWI>, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionAccessValidationService

Filters a Page of the subscriptionWithItems and returns those subscriptions that are accessible to the current user (customer or account).

getAccounts() - Method in class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

The filtered set of accounts that are valid based on the inclusion and exclusion segments.

getAction() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The action to be performed on the specified Subscription.

getActionDateAtBeginningOfDay() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

getActionEffectiveType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The descriptor of when the price change should take effect.

getActionFlow() - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The original action flow that led to the creation of this delayed action.

getActionInfo() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAction

A map that may contain additional information about the action.

getActionPriceDetails() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

A collection of SubscriptionActionPriceDetail objects describing the price before & after the action for each item.

getActionType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The type of delayed action that is to be performed.

getActionType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAction

The type of action.

getActiveEndDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

When this Variant should no longer be active.

getActiveStartDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

When this Variant should start to become active.

getActiveSubscriptions() - Method in class com.broadleafcommerce.subscriptionoperation.domain.UserSubscriptionSummary

ExistingSubscriptionDetails of the active subscriptions purchased by the user.

getActiveSubscriptionStatuses() - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationServiceProperties

List of subscription statuses that are considered as active subscription statuses.

getAddablePostPurchaseOptions(Product, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

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

getAddItemRequests() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

The initial AddItemRequests to populate the cart.

getAdditionalAttribute() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Category

Return any additional attributes passed in the request not matching any defined properties.

getAdditionalAttribute() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Return any additional attributes passed in the request not matching any defined properties.

getAdditionalAttribute() - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

Return any additional attributes passed in the request not matching any defined properties.

getAdditionalAttribute() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

Return any additional attributes passed in the request not matching any defined properties.

getAdditionalAttribute() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

Return any additional attributes passed in the request not matching any defined properties.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Category

Map holding any additional attributes passed in the request not matching any defined properties.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Map holding any additional attributes passed in the request not matching any defined properties.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

Additional information about the lock

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

Miscellaneous attributes that can be set on this item.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

Map holding any additional attributes passed in the request not matching any defined properties.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

Map holding any additional attributes passed in the request not matching any defined properties.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Miscellaneous attributes that can be set to this request in order to inform business logic

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Miscellaneous attributes that can be added to the response in order to provide more information.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Miscellaneous attributes that can be added to the context in order to provide more information.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

Map holding any additional attributes passed in the request not matching any defined properties.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

Miscellaneous attributes that can be set to this request in order to inform business logic for adding a CartItem.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateSubscriptionFromOrderRequest

Miscellaneous attributes that can be set to this request in order to inform business logic for adding a Subscription.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyRequest

Miscellaneous attributes that can be added to the response in order to provide more information.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyResponse

Miscellaneous attributes that can be added to the response in order to provide more information.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Miscellaneous attributes that can be set to this request in order to inform business logic

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Miscellaneous attributes that can be set to this request in order to inform business logic for adding a Subscription.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Miscellaneous attributes that can be set to this request in order to inform business logic for adding a SubscriptionItem.

getAdditionalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.UpdateSubscriptionStatusRequest

Miscellaneous attributes that can be set to this request to inform business logic

getAdditionalFields() - Method in class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

getAdditionalFields() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

getAdditionalProperties() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

Any additional information related to the price change.

getAddOnChoiceKey(OrderItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Determines the value to store at SubscriptionItem.getAddOnKey().

getAddOnKey() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

getAddOnKey() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

If this item was the result of an add-on, then this stores the key of the add-on in the context of its parent.

getAddOnKey() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

If this item was the result of an add-on, then this stores the key of the add-on in the context of its parent.

getAdjustmentAmount() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

Adjustment amount applied to the unit price of the target item.

getAdjustmentAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The amount of the adjustment that will be removed.

getAdjustmentAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getAdjustmentAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getAdjustmentAmount(T, String, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Gets the adjustment amount from the given SubscriptionItemAdjustmentPriceDetail and priceDetailType.

getAdjustmentAmountTotal() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

Cumulative total of all instances of an Adjustment.

getAdjustmentCartLabel() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

Friendly label to display in the cart or to a customer in general instead of the Adjustment.getAdjustmentName().

getAdjustmentCartLabel() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The cart label of the adjustment that will be removed.

getAdjustmentCartLabel() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

getAdjustmentCartLabel() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getAdjustmentCartLabel() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getAdjustmentCodeRef() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

A reference to the Offer Code (if any).

getAdjustmentCodeRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

getAdjustmentCodeRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getAdjustmentCodeRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getAdjustmentCurrency() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The currency of the adjustment that will be removed.

getAdjustmentDescription() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

A description of what benefits the adjustment provides to a customer.

getAdjustmentDescription() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The description of the adjustment that will be removed.

getAdjustmentDescription() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

getAdjustmentDescription() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getAdjustmentDescription() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getAdjustmentDiscountFactor() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

The discount factor by which to discount a target.

getAdjustmentDiscountFactor() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getAdjustmentDiscountFactor() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getAdjustmentDiscountMethodType() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

Determines the method used to apply the discount.

getAdjustmentDiscountMethodType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getAdjustmentDiscountMethodType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getAdjustmentName() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

Name of the adjustment applied.

getAdjustmentName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

getAdjustmentName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The name of the adjustment that will be removed.

getAdjustmentName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

getAdjustmentName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getAdjustmentName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getAdjustmentPriceDetails() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

getAdjustmentPriceDetailsByAdjustmentRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The map of SubscriptionItemAdjustmentPriceDetail by adjustment reference, containing the details about how the discount affects the prorated unit amount, credited amount, and prior unbilled amount.

getAdjustmentProrationType() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

Determines how an adjustment's discount amount is distributed across the adjustment's related item types.

getAdjustmentProrationType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

getAdjustmentProrationType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getAdjustmentProrationType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getAdjustmentQuantity() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

The quantity of the target item's units the adjustment applies to.

getAdjustmentQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getAdjustmentQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The quantity of the item impacted by the adjustment after the subscription modification.

getAdjustmentRef() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

Reference to the promotion or offer that drives this adjustment

getAdjustmentRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

getAdjustmentRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The reference of the adjustment that will be removed.

getAdjustmentRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

getAdjustmentRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getAdjustmentRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getAdjustmentRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

getAdjustmentUnitAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

The unit discount of an Adjustment.

getAfterRecurringPrice() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

The price after the change

getAfterRecurringPrice() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

The PriceData recurringPrice after the price change.

getAllCustomerSubscriptionActionTypes() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

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

getAllowedActionsBySubscriptionStatus() - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationServiceProperties

List of allowed subscription actions for each subscription status.

getAllowedActionsBySubscriptionStatus(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationServiceProperties

getAlternateUserRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Alternate reference to the user.

getAlternateUserRef() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Alternate reference to the user.

getAlternateUserRefType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Type of the alternative user reference

getAlternateUserRefType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Type of the alternative user reference

getAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

Amount due on the payment schedule date.

getAmountDueNow() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Amount due today, which is typically captured immediately.

getAmountGetter(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Based on the provided DefaultSubscriptionPriceDetailType, identifies the relevant getter on the SubscriptionItemPriceDetail.

getAmountWithDependentItems(T, String, List<T>, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getApplicablePeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The period number on which the delayed action is due.

getApplicationDateType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

Indicates when the adjustment should be applied onto the subscription.

getApplicationDateType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

Indicates when the price data should be applied onto the subscription.

getApplicationId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

The application associated with the subscription

getAppliesTo() - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

Whether the Price Data applies to all customers or identifies users to via customer segments.

getArchiveReason() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Why this item was archived

getAttribute() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

Return any additional attributes passed in the request not matching any defined properties.

getAttribute() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Return any additional attributes passed in the request not matching any defined properties.

getAttribute() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Return any additional attributes passed in the request not matching any defined properties.

getAttribute() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Return any additional attributes passed in the request not matching any defined properties.

getAttribute(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

getAttribute(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The additional attributes.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

The additional attributes.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

Any additional attributes used to describe the delayed action

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

Additional attributes to include.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

Additional attributes to include.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

Additional attributes to include.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Miscellaneous attributes for this tag.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

Additional, miscellaneous attributes.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

Map holding any additional attributes passed in the request not matching any defined properties.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

Miscellaneous attributes for this tag.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

Additional information to include with this removal DTO.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Miscellaneous attributes for this subscription.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

Miscellaneous attributes for this subscription item adjustment.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Map holding any additional attributes passed in the request not matching any defined properties.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Map holding any additional attributes passed in the request not matching any defined properties.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

Any additional attributes used to describe the period

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Map holding any additional attributes passed in the request not matching any defined properties.

getAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.UserSubscriptionSummary

Additional attributes to include.

getAuthenticationUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionAccessValidationService

getAuthenticationUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProvider

getAvailableActions() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

The available SubscriptionActions that may be possible for this subscription.

getAvailableActions() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionResponse

The available SubscriptionActions that may be possible for this subscription.

getBaseLockUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

getBaseType() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

getBaseUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProvider

Gets the base URI common to all requests this provider will make.

getBaseUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProvider

Gets the base URI common to all requests this provider will make.

getBaseUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProvider

Gets the base URI common to all requests this provider will make.

getBaseUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProvider

Gets the base URI common to all requests this provider will make.

getBaseUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProvider

Gets the base URI common to all requests this provider will make.

getBaseUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

Gets the base URI to read subscriptions.

getBeforeRecurringPrice() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

The price before the change

getBeforeRecurringPrice() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

The PriceData recurringPrice before the price change.

getBeginPeriod() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

Number of the billing period this adjustment starts being active

getBeginPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

getBeginPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

getBeginPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getBeginPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getBillDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

The date on which the customer is expected to be billed.

getBillDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

The date on which the customer is expected to be billed.

getBillDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

The bill date of the period

getBillingFrequency() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Deprecated.

in favor of Subscription.periodType & Subscription.periodFrequency

getBillingFrequency() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Deprecated.

in favor of SubscriptionCreationRequest.periodType & SubscriptionCreationRequest.periodFrequency

getBulkUpdateBatchSize() - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionPricingProperties

The batch size to use when performing bulk pricing updates for subscriptions.

getCampaignTrackingId() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

The campaign tracking id (if any) for this adjustment.

getCampaignTrackingId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

getCampaignTrackingId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getCampaignTrackingId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getCancellationChargeStrategy() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

getCancellationFeeProductId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

The product id that holds the cancellation fee.

getCancellationFeeProductIds(SubscriptionWithItems, CancellationPolicyDetail) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

Fetches the Ids of the extra (cancellation) fee products including the grace fee cancellation product (if applicable) from the given CancellationPolicyDetail.

getCancellationFeeProductIdToFetch(CancellationPolicyDetail, SubscriptionWithItems) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

Fetches the Id of the extra (cancellation) fee product.

getCancellationPoliciesPath() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProviderProperties

The base uri path to the cancellation policy endpoint

getCancellationPolicy() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The full CancellationPolicy for the SubscriptionPricingContext.subscriptionRootItem if any.

getCancellationPolicy() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

Describes details for access & charges in the current period in which the cancellation of this subscription is being requested/executed.

getCancellationPolicy() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Describes details for access & charges in the current period in which the cancellation of this subscription is being requested/executed.

getCancellationPolicyDetail() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The relevant CancellationPolicyDetail for the SubscriptionPricingContext.paymentStrategy from the SubscriptionPricingContext.cancellationPolicy.

getCancellationPolicyDetail() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Describes details of the applicable cancellation policy for this subscription.

getCancellationPolicyDetail(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

Gets the appropriate CancellationPolicyDetail based on the payment strategy used.

getCancellationPolicyDetailAndValidate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

getCancellationPolicyOptionally() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

getCancellationPolicyProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultCancellationPolicyService

getCancellationPolicyProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getCancellationPolicyProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getCancellationPolicyProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

getCancellationPolicyRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

A reference of the CancellationPolicy that governs how this subscription would be cancelled.

getCancellationPolicyService() - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.CancellationPolicyOperationEndpoint

getCancellationStrategy() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

The strategy to use when cancelling a subscription, e.g.

getCancellationStrategy() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

getCandidateAccounts() - Method in class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

The set of requested candidate accounts that were filtered.

getCart() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The Cart containing subscriptions.

getCart() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionResponse

getCartAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

Attributes that should be copied to the Cart.getAttributes() for this request.

getCartAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

Miscellaneous attributes that should be copied to Cart.getAttributes()

getCartInternalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

Miscellaneous internal attributes for this item.

getCartItemId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

Reference to the subscription CartItem.

getCartItemId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Reference to the subscription CartItem.

getCartItems() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyRequest

The cart items to identify the cancellation policies for.

getCartItemWithDependentItems(CartItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getCartOperationProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

getCartOperationProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

getCartOperationProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

getCartType() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProvider

Gets the type reference for a page generator of item list items.

getCartUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProviderProperties

The URI to endpoints managing a specific cart.

getCatalogProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getCatalogProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionValidationService

getCatalogProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

getCatalogProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

getCategory() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The Category which the choice will be chosen from by the customer if the ItemChoice.targetType is DefaultItemChoiceTargetType.CATEGORY.

getChargeForPreviouslyReceivedDiscountedPeriods() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Gathers the charge for previously received discounted periods based on the cancellation policy.

getChargeStrategy() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

The strategy to use when charging a customer for cancelling a subscription, e.g.

getChildOptions(ItemChoice) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

getChildOptions(ItemChoice, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

Gets the child options for the given ItemChoice.

getChoiceKey() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The key used during the validation of cart item's configuration to relate this ItemChoice to one of the cart item's dependent items.

getCodeUsed() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

The code used (if any) that triggered the application of the adjustment for this adjustment.

getCodeUsed() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

getCodeUsed() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getCodeUsed() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getContextState() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

A subset of Tracking information to expose the context state for this object.

getContextState() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

A subset of Tracking information to expose the context state for this object.

getContextState() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

A subset of Tracking information to expose the context state for this object.

getContextState() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

A subset of Tracking information to expose the context state for this object.

getContextState() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

A subset of Tracking information to expose the context state for this object.

getContextState() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

A subset of Tracking information to expose the context state for this object.

getContextState() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

A subset of Tracking information to expose the context state for this object.

getContextState() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

A subset of Tracking information to expose the context state for this object.

getCost() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Can be used in display or as apart of more complex pricing algorithms

getCreated() - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

The time the lock was created

getCreatedDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Date this subscription was created.

getCreatedDate(Order) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

getCreditedAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

For edits, upgrades, and downgrades, the system has partial credits to the prorated amount that the customer already paid.

getCreditedAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Gathers the credited portion of the item subtotal, which is based on the SubscriptionItemPriceDetail.getCreditedUnitAmount().

getCreditedAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

For edits, upgrades, and downgrades on a subscription that’s using an DefaultSubscriptionPaymentStrategy.PREPAID payment strategy, the customer has already paid the full amount for this billing cycle at the previous rate.

getCreditedDiscountAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Gathers the credited discount amount, which is the total discount offered on the credited price.

getCreditedUnitAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

For edits, upgrades, and downgrades on a subscription that’s using an DefaultSubscriptionPaymentStrategy.PREPAID payment strategy, the customer has already paid the full amount for this billing cycle at the previous rate.

getCreditedUnitDiscountAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The subscription item discount per unit to be deducted from the SubscriptionItemPriceDetail.getCreditedUnitAmount().

getCurrency() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

Currency for all of the prices on this product

getCurrency() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Currency of this subscription

getCurrency() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Currency of this subscription

getCurrency() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Currency of this subscription

getCurrency() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The CurrencyUnit of the item to be added to the Cart.

getCurrency() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.PriceCartRequest

The currency to price the cart against.

getCurrency() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Currency of this subscription

getCurrencyConversionDetail() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

Represents the details of the exchange rate used to convert a MonetaryAmount from one currency to another.

getCurrencyConversionDetail() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Represents the details of the exchange rate used to convert a MonetaryAmount from one currency to another.

getCurrentAddons(SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

Gets the current addons for the given DefaultSubscriptionOperationService.

getCurrentPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

The subscription's current period

getCurrentPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Gets the current period for this subscription by comparing Instant.now() and each SubscriptionPeriod's timeframe.

getCurrentPeriodDefinition() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

getCurrentPeriodDefinition() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Gets the current subscription period definition.

getCurrentSubscriptionAdjustments(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Gets all the current or new subscription Adjustments from the current Cart and CartItem.

getCurrentSubscriptionPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Gets the current subscription period number.

getCustomerProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getCustomersUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProviderProperties

The base uri path to the customer endpoint

getCustomerTimezone() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The customer's timezone.

getCustomerTimezone() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The customer's timezone.

getCustomerTimezone() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

The customer's timezone, which gets stored in Cart.getInternalAttributes() to be used by downstream services.

getCustomerTimeZone(Cart) - Static method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionDateUtils

Gets the customer timezone from the given Cart if specified.

getCustomerTimeZone(Order) - Static method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionDateUtils

Gets the customer timezone from the given Order if specified.

getCustomRootItemReferencedBySubscription(SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

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

getDatasource() - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationJpaProperties

getDateXAfterDaysFromCurrentPeriodStartDate(Subscription, int) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.SubscriptionModificationUtils

getDaysBetweenPeriodStartAndActionDate(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getDefaultPrice() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

The default price that should be used if there is not a Variant.salePrice set.

getDefaultProduct() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The default product that can be used when driving customer selections if the ItemChoice.targetType is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS.

getDefaultProductInCategory() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The default product that can be used when driving customer selections if the ItemChoice.targetType is DefaultItemChoiceTargetType.CATEGORY.

getDefaultSWIPageSize() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultUserSubscriptionSummaryService

Returns the default page size for gathering SubscriptionWithItems

getDefaultSWIPageSize() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

Returns the default page size for gathering SubscriptionWithItems

getDefaultVariant() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The default variant that can be used when driving customer selections if the ItemChoice.targetType is DefaultItemChoiceTargetType.SPECIFIC_VARIANTS.

getDelayedActions() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

List of delayed actions for this subscription.

getDelayedActions() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

List of delayed actions for this subscription.

getDelayedDateBasedOnFreeTrial(Instant, List<Adjustment>, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

Delays the given Instant based on the free trial Adjustment, if any.

getDelegating() - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationJpaProperties

getDependentCartItems() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

A list of additional AddItemRequests that should be processed as dependent items of the resulting parent item of this current AddItemRequest.

getDependentItems(SubscriptionReferencedItem, Subscription, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

Gets a list of all the required add-ons (dependentCartItems) for the current product.

getDependentItems(T, List<T>) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getDependentItemsCustom(SubscriptionReferencedItem, Subscription) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

Custom implementation for non-BroadleafProduct instances.

getDescription() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The description of the policy.

getDescription() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Description of the Variant that can include HTML in implementations where a WYSIWYG editor manages this field.

getDiscountAmountGetter(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getDiscountType() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

Defines the type of the discount, e.g., free trial, order discount, future credit, etc.

getDiscountType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

getDiscountType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

getDiscountType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getDiscountType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getDisplayOrder() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

The ordering of this option in relation to other options on the page.

getDowngradeOptionReferences() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

getDowngradeOptionReferences() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.SubscriptionReferencedItem

List of references (usually IDs) to items that this can downgrade to.

getDowngradeProductIds() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

The list of ids of the product that this product can downgrade to.

getDueNowItemDetails() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

A list of SubscriptionPriceItemDetails describing the individual item prices that contributed to the overall SubscriptionPriceResponse.getAmountDueNow().

getDueNowQuantityOverride() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

An item's quantity override value used for "due now" price calculations where the item's quantity decreased due to the subscription action.

getEffectiveQuantityForPricing() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Gathers the item's quantity, considering the SubscriptionItemPriceDetail.getDueNowQuantityOverride() if it's non-null.

getEffectiveQuantityForPricing(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Different prices use different item quantities in their calculations.

getEndOfPreviousDay(Instant, String) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

getEndOfTermDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The end of term date for this subscription.

getEndOfTermDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The date at which the subscription's terms will expire.

getEndOfTermDate() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

The end of term date for this subscription.

getEndPeriod() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

Number of the billing period this adjustment stops.

getEndPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

getEndPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

getEndPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getEndPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getEstimatedFuturePaymentCount(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the number of future billing periods to estimate.

getEstimatedFuturePayments() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

A collection of EstimatedFuturePayment objects describing the timing & amount of future subscription payments.

getExceptionHandlerUtils() - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.exception.SubscriptionOperationExceptionAdvisor

getExcludedSegments() - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

List of excluded customer segments — overrides the PriceChangeRequest.appliesTo and PriceChangeRequest.includedSegments values to exclude users based on these customer segments.

getExcludedSegments() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

The segments that identify the accounts whose subscriptions should be excluded from those identified by BulkPriceUpdateSubscriptionRequest.includedSegments.

getExcludeSegmentIds() - Method in class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

The set of accounts that were excluded from the final result.

getExistingAdjustmentDetails() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

getExistingDiscountTotal(SubscriptionPricingContext, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Gets the existing discount total for the given SubscriptionItem.

getExistingFullSubscriptionPeriodUnitDiscountAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The existing, un-prorated unit discount amount prior to the subscription modification.

getExistingItemAdjustmentDetails() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

getExistingItemAdjustmentQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The quantity of the item impacted by the adjustment prior to the subscription modification.

getExistingItemDetails() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

ExistingSubscriptionItemDetail for each SubscriptionItem on the existing Subscription.

getExistingProratedUnitAmountBetweenActionAndNextBillDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Similar to SubscriptionItemPriceDetail.getProratedUnitAmountBetweenActionAndNextBillDate(), this is the SubscriptionItemAdjustmentPriceDetail.existingFullSubscriptionPeriodUnitDiscountAmount prorated for the period between the action date and the next bill date and the regardless of the subscription action being taken or the payment strategy.

getExistingProratedUnitAmountBetweenPeriodStartAndActionDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Similar to SubscriptionItemPriceDetail.getProratedUnitAmountBetweenPeriodStartAndActionDate(), this is the SubscriptionItemAdjustmentPriceDetail.existingFullSubscriptionPeriodUnitDiscountAmount prorated for the period between the period start date and the action date and the regardless of the subscription action being taken or the payment strategy.

getExistingSubscription() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The existing Subscription if any.

getExistingSubscriptionAdjustments(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Gets all the existing Adjustments from the existing Subscription and its items.

getExistingSubscriptionId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

getExistingSubscriptionItem(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

getExistingSubscriptionItemById() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The existing Subscription if any.

getExistingSubscriptionItemId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The existing subscription item's id prior the subscription action (e.g.

getExistingSubscriptionItemId(CartItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getExistingSubscriptionItemQuantities() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Map of SubscriptionItem.getId() to the existing SubscriptionItem's quantity.

getExistingSubscriptionItemQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The existing subscription item's quantity prior the subscription action (e.g.

getExistingSubscriptionItemQuantity(CartItem, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getExistingSubscriptionItemQuantity(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

getExistingSubscriptionItems() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

getExistingSubscriptionItemSubtotal(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

getExistingSubscriptionItemUnitPrice() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The existing subscription item's unit price prior the subscription action (e.g.

getExistingSubscriptionItemUnitPrice(CartItem, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getExistingSubscriptionItemUnitPrice(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

getExistingSubscriptionItemUnitPrices() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Map of SubscriptionItem.getId() to the existing SubscriptionItem's unit price.

getExistingSubscriptions(List<C>, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getExpirationDate() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

DefaultCartTypes.QUOTE carts can have an expiration date.

getExpires() - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

The time the lock will expire

getExternalId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

This is an arbitrary ID, typically assigned by or used by 1st or 3rd party systems that are not Broadleaf.

getExternalWorkflowProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultStartChangeAutoRenewalWorkflowService

getFlow() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Describes the subscription action flow that is being executed.

getFlow() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Describes the subscription action flow that is being executed.

getFlowName() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

Produces the name of the modification flow.

getFlowName() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

getFlowName() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

getFlowName() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateDowngradeSubscriptionHandler

getFlowName() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

getFlowName() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateUpgradeSubscriptionHandler

getFormerSubscriptions() - Method in class com.broadleafcommerce.subscriptionoperation.domain.UserSubscriptionSummary

ExistingSubscriptionDetails of the former subscriptions purchased by the user.

getFormerSubscriptionStatuses() - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationServiceProperties

List of subscription statuses that are considered as former subscription statuses.

getFreeTrialEndDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

The end date of the free trial for this subscription, if applicable, null if none applied.

getFreeTrialEndDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

getFreeTrialEndDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The end date of the free trial for this subscription, if applicable, null if none applied.

getFreeTrialEndDate(Instant, List<Adjustment>, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

Determines the free trial's end date based on the free trial start date & the free trial adjustment.

getFreeTrialLength() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

If Adjustment.getDiscountType() is FREE_TRIAL, then this defines the free trial's length.

getFreeTrialLength() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

getFreeTrialLength() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getFreeTrialLength() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getFreeTrialLengthUnits() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

If Adjustment.getDiscountType() is FREE_TRIAL, then this defines the units for Adjustment.getFreeTrialLength().

getFreeTrialLengthUnits() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

getFreeTrialLengthUnits() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getFreeTrialLengthUnits() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getFriendlyMessage() - Method in exception com.broadleafcommerce.subscriptionoperation.service.exception.IllegalSubscriptionPricingStateException

Message to return to the caller that is more suitable for display purposes.

getFulfillments() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateSubscriptionFromOrderRequest

The Fulfillments created for the CreateSubscriptionFromOrderRequest.order.

getFulfillmentWorkflow() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

A reference to the workflow used to fulfill the creation of, & modifications to, this subscription.

getFullSubscriptionPeriodUnitAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The unit price of the item (price of one) for the length of a full subscription period.

getFullSubscriptionPeriodUnitDiscountAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The unit adjustment amount for this event item for the length of a full subscription period.

getFullUpFrontUnitAmount(CartItem, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getGracePeriodCancellationFeeProductId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

The product id that holds the cancellation fee for the grace period.

getGracePeriodCancellationStrategy() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

The cancellation strategy to use during the grace period.

getGracePeriodChargeStrategy() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

The charge strategy to use during the grace period.

getGracePeriodDurationInDays() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

Duration of the initial grace period in days.

getHeaders(ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.AbstractExternalProvider

Builds the headers to be passed along with the request to the provider.

getHttpServletRequest() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProvider

getId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The id of the policy.

getId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

getId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

An identifying label for this change.

getId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

getId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

The id of the product.

getId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

getId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

getId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

getId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getId() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.SubscriptionReferencedItem

The ID used by the system to identify this item.

getId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

The unique identifier for this variant.

getIncludedSegments() - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

List of included customer segments.

getIncludedSegments() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

The segments that identify the accounts whose subscriptions should be updated.

getIncludeSegmentIds() - Method in class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

The set of accounts that were included in the final result.

getInternalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Miscellaneous internal attributes for this subscription.

getInternalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Miscellaneous internal attributes for this subscription item.

getInventoryCheckStrategy() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Describes when the variant's inventory should be checked for availability.

getInventoryReservationStrategy() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Describes when the variant's inventory should be reserved.

getItemAdjustmentQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

If it's an item adjustment, it represents the quantity this adjustment applies to.

getItemAdjustmentQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

The quantity of the SubscriptionItem the adjustment applies to.

getItemAdjustmentQuantity(T, String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The effective quantity of the items that are receiving the adjustment/discount.

getItemAdjustmentQuantity(T, String) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines the quantity to be used for the given SubscriptionItemAdjustmentPriceDetail total discount calculation.

getItemAttributeChoices() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

Attribute choices that should be copied to CartItem.getAttributeChoices() for this request.

getItemAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

Miscellaneous attributes that should be copied to the CartItem.getAttributes() for this request.

getItemChoice() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

Configuration for the DefaultProductOptionType.ITEM_CHOICE.

getItemChoice(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

getItemChoiceByChoiceKey() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Mapping of add-on choice keys to add-ons.

getItemChoiceKey() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

If this AddItemRequest is one within AddItemRequest.getDependentCartItems(), this is the key to use to relate to this CartItem to a configured product item choice.

getItemCreationRequests() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

getItemDetails() - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

A list of SubscriptionPriceItemDetails describing the individual item prices that contributed to the overall EstimatedFuturePayment.getAmount().

getItemDetails() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Additional details about the item

getItemInternalAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

Miscellaneous internal attributes that should be copied to the CartItem.getInternalAttributes() for this request.

getItemName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

The name of the non-catalog-item.

getItemName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

Name of the item identified by SubscriptionActionPriceDetail.getItemRefType() & SubscriptionActionPriceDetail.getItemRef().

getItemName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Item name

getItemName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Name of the item identified by SubscriptionItemPriceDetail.getItemRefType() & SubscriptionItemPriceDetail.getItemRef().

getItemName() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Item name

getItemQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

getItemQuantity(T, String) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getItemRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

getItemRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

Reference to the id of the item represented by this object.

getItemRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Reference to the id of the item represented by this object.

getItemRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Reference to the id of the item represented by this object.

getItemRef() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Reference to the item ID

getItemRefType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

getItemRefType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

Type of item that this object represents.

getItemRefType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Type of item that this object represents.

getItemRefType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Type of item that this object represents.

getItemRefType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Type of item that this object represents

getItemSku() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

getItemSku() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

SKU of the item represented by this object.

getItemSourceRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

This field shows the identifier of the process or user action this subscription item originated.

getItemSourceType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

This field shows from which process or user action this subscription item originated.

getItemSubtotal() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Gathers the itemSubtotal, which is equal to SubscriptionItemPriceDetail.getProratedAmount() + SubscriptionItemPriceDetail.getPriorUnbilledAmount() - SubscriptionItemPriceDetail.getCreditedAmount().

getItemType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The type of this item (e.g.

getItemUnitPrice() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Unit price of the item (price of a single unit)

getItemUnitPrice() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Unit price of the item (price of a single unit)

getJpa() - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationJpaProperties

getLabel() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

The label shown to customers when displaying this option.

getLastBillingBatchId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The batch id of the last billing job run for this subscription

getLastBillingOperationStatus() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The most current status of the last billing event for this subscription

getLastBillingSuccessDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Last date this that the Billing Job succeeded billing this subscription

getLiquibase() - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationJpaProperties

getListType() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

getLocale() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.PriceCartRequest

The locale to price the cart against.

getLockId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

The ID of the lock

getLocksPath() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

getLockToken(LockStatus) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getManageCartsUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProviderProperties

The base uri path to the manage cart endpoint.

getMapper() - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.exception.SubscriptionOperationExceptionAdvisor

getMaximumQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The maximum amount of this item that a customer can purchase at a time.

getMaximumThreshold() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

The maximum count of this product that must be added in a cart.

getMaximumThreshold() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.SubscriptionReferencedItem

The maximum count of this item that must be added in a cart.

getMaximumThreshold() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

The maximum count of this variant can be added in a cart.

getMaxNumberOfActiveSubscriptions() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

The max number of active subscriptions that can be created for this product.

getMaxNumberOfActiveSubscriptions() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.SubscriptionReferencedItem

The max number of active subscriptions that can be created for this item.

getMerchandisingContext() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The value that should be mapped to CartItem.getMerchandisingContext().

getMessage(String, Object...) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getMessagePath() - Method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

getMessagePath() - Method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionNextStatusChangeReason

getMessageSource() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

getMessageSource() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getMessageSource() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

getMessageSource() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

getMinimumQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The minimum amount of the item that a customer must purchase.

getMinimumThreshold() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

The minimum count of this product that must be added in a cart.

getMinimumThreshold() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.SubscriptionReferencedItem

The minimum count of this item that must be added in a cart.

getMinimumThreshold() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

The minimum count of this variant that must be added in a cart.

getModifySubscriptionHandlers() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getMonthsInCustomPeriodType(String, int) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

Hook point for handling custom DefaultSubscriptionPeriodType values.

getMonthsInPeriod(String, int) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

Determines the number of months in a billing period.

getMonthsUntilEndOfTerm(Instant, Instant, String) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

Determines the number of months until the end of the subscription's term.

getName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The name of the policy.

getName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

Name of this product.

getName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Name of this subscription

getName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

The name of this particular variant of the product.

getName() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

Allows optionally setting a cart name.

getName() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Name of this subscription

getNameOverride() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

When displaying this choice to a customer, an optional override for the display the customer should see.

getNewItemRef() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Reference to the id (productId) of the item to upgrade or downgrade to.

getNewItemRefType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Type of newItemRef that this item is to be upgraded or downgraded to.

getNextBillDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Next date this subscription will be billed

getNextBillDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Describes the next time that the customer will be billed.

getNextBillDate() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Next date this subscription will be billed

getNextPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The next period this subscription will cover.

getNextRootItem() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The hydrated item identified by ModifySubscriptionRequest.newItemRefType and ModifySubscriptionRequest.newItemRef which the subscription will be upgraded or downgraded to.

getNextStatusChangeDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Date when the next status should begin

getNextStatusChangeDate() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Date when the next status should begin

getNextStatusChangeDate(Subscription) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

getNextStatusChangeReason() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Reason for the update to the next status

getNextStatusChangeReason() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Reason for the update to the next status

getNextSubscription() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

If this subscription was upgraded or downgraded, holds the reference to the subscription replacing this one

getNonCatalogItemDetails() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

Details of the item not present in a catalog.

getNumberOfDaysInFullPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

If a period is shortened (typically by the Subscription.getEndOfTermDate() occurring before the end of the period), then this value will describe the number of days in the full period - i.e.

getNumberOfDaysInFullPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

If a period is shortened (typically by the Subscription.getEndOfTermDate() occurring before the end of the period), then this value will describe the number of days in the full period - i.e.

getNumberOfDaysInShortenedPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

If a period is shortened (typically by the Subscription.getEndOfTermDate() occurring before the end of the period), then this value will describe the number of days in the shortened period.

getNumberOfDaysInShortenedPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

If a period is shortened (typically by the Subscription.getEndOfTermDate() occurring before the end of the period), then this value will describe the number of days in the shortened period.

getNumberOfPeriodsLeftInTerm() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The number of billing periods left in a term beyond the current period, if there are terms.

getNumberOfPeriodsLeftInTerm(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

getNumberOfPeriodsLeftInTerm(String, int, Instant, Instant, Instant, String) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

Determines the number of billing periods left after the current that are outstanding.

getNumberOfPeriodsLeftInTerm(Instant, SubscriptionPricingContext) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

Determines the number of billing periods left after the current that are outstanding.

getObjectMapper() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.AbstractExternalProvider

getOfferRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

The ID that refers to the offer / offer code being added.

getOfferRefType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

The type of adjustment to be added.

getOffersUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOfferProviderProperties

The base uri path to the offers endpoint

getOptions() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

Drives additional information that the customer should enter when purchasing this product.

getOptionValues() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Helper to make this particular variant uniquely identifiable across multiple variants for the same product.

getOrder() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateSubscriptionFromOrderRequest

The source order to use to create one or more Subscriptions.

getOrderFulfillmentId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The id of the fulfillment that led to the creation of this delayed action.

getOrderId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The id of the order that led to the creation of this delayed action.

getOrderProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOrderHistoryService

getOrderUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProviderProperties

The URI path for basic singular order retrieval.

getOriginalSubscriptionItemQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The original quantity of the SubscriptionItem.

getOverrideChangeContainer() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

getOverridePrice() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The price of this choice.

getOwnerId() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

Identifier for the subscription entity that owns this adjustment, e.g., the Subscription ID.

getOwnerId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getOwnerId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getOwnerType() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

The type of subscription entity that owns this adjustment, e.g., DefaultAdjustmentOwnerType.SUBSCRIPTION.

getOwnerType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getOwnerType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getPage() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.page.ResponsePageGenerator

getPageSize() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultCancellationPolicyService

getPageType() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProvider

getPageType() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProvider

Gets the type reference for a page generator of item list items.

getPageType() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

Gets the type reference for a page generator of item list items.

getParentExistingQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The item's parent existing quantity prior to the subscription action (e.g.

getParentItemQuantity(CartItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getParentItemRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

Reference of the parent subscription item's backing item if this is a child subscription item.

getParentItemRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Reference of the parent subscription item's backing item if this is a child subscription item

getParentItemRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Reference of the parent subscription item's backing item if this is a child subscription item

getParentItemRef() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Reference to the item underlying the parent subscription item if this is a child subscription item

getParentItemRefType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

Type of the parent subscription item's backing item if this is a child subscription item.

getParentItemRefType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Type of the parent subscription item's backing item if this is a child subscription item

getParentItemRefType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Type of the parent subscription item's backing item if this is a child subscription item

getParentItemRefType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Type of the parent subscription item's backing item if this is a child subscription item

getParentQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The item's parent quantity following the subscription action (e.g.

getPaymentStrategy() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

Declares that payments made against a subscription are going towards the goods/services rendered in the previous vs current period.

getPaymentStrategy() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Declares that payments made against a subscription are going towards the goods/services rendered in the previous vs current period.

getPaymentStrategy() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The payment strategy of the subscription, e.g.

getPaymentStrategy() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Declares that payments made against a subscription are going towards the goods/services rendered in the previous vs current period.

getPaymentStrategy() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

Declares that payments made against a subscription are going towards the goods/services rendered in the previous vs current period.

getPaymentStrategy() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Declares that payments made against a subscription are going towards the goods/services rendered in the previous vs current period.

getPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

The period number

getPeriodDefinition(int) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

getPeriodDefinition(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

getPeriodDefinition(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Gets the period definition for this subscription by comparing the given Instant and each SubscriptionPeriod's timeframe.

getPeriodDefinitions() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Describes upcoming subscription billing periods, including the start date, end date, & when the customer will be billed.

getPeriodEndDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

The date describing the end of the billing period that is being billed for.

getPeriodEndDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

The date describing the end of the billing period that is being billed for.

getPeriodEndDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

The end date of the period

getPeriodFrequency() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

The frequency with which the recurring price should be charged., e.g., a value of 1 combined with ExistingSubscriptionDetails.periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.

getPeriodFrequency() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The frequency with which the recurring price should be charged., e.g., a value of 1 combined with Subscription.periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.

getPeriodFrequency() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The frequency with which the recurring price should be charged., e.g., a value of 1 combined with SubscriptionPriceResponse.periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.

getPeriodFrequency() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The frequency with which the recurring price should be charged., e.g., a value of 1 combined with SubscriptionPricingContext.periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.

getPeriodFrequency() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

The frequency with which the recurring price should be charged., e.g., a value of 1 combined with SubscriptionCreationRequest.periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.

getPeriodNumber() - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

The period number of the billing period.

getPeriodNumber() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

The period number of the billing period.

getPeriods() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

List tracking the Subscription's periods.

getPeriodsAlreadyUsed() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

Represents the number of periods this adjustment has already been used.

getPeriodStartDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

The date describing the beginning of the billing period that is being billed for.

getPeriodStartDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

The date describing the beginning of the billing period that is being billed for.

getPeriodStartDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

The start date of the period

getPeriodStartDateAfterFreeTrialEnd(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

Gets the start date of the next period after the free trial ends.

getPeriodsUsed(Adjustment, Subscription) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.SubscriptionModificationUtils

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

getPeriodType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

The period type for the price, e.g.

getPeriodType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The period type for the price, e.g.

getPeriodType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The period type for the price, e.g.

getPeriodType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The period type for the price, e.g.

getPeriodType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

The period type for the price, e.g.

getPolicyByCartItemId() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyResponse

A map of CartItem.getId() to the matching CancellationPolicyRef.

getPolicyRules() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The rules of the policy that are used to matching items.

getPolicyUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionValidationService

getPolicyUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

getPolicyUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

getPolicyUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

getPolicyUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateDowngradeSubscriptionHandler

getPolicyUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

getPolicyUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateUpgradeSubscriptionHandler

getPostActionSubtotal() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

The subscription item subtotal after to the action being taken, reflecting the typical recurring price for the item.

getPostActionSubtotal() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The subscription subtotal after to the action being taken, reflecting the typical recurring price for the subscription.

getPostpaidPolicyDetail() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The policy details for items that are using the DefaultSubscriptionPaymentStrategy.POSTPAID strategy.

getPreActionSubtotal() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

The subscription item subtotal prior to the action being taken, reflecting the typical recurring price for the item.

getPreActionSubtotal() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The subscription subtotal prior to the action being taken, reflecting the typical recurring price for the subscription.

getPreferredPaymentAccountId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

References an identifier of a PaymentAccount that is considered preferred for this subscription.

getPreferredPaymentAccountId() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

References an identifier of a BillingServices PaymentAccount that is considered preferred for this subscription.

getPrepaidPolicyDetail() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The policy details for items that are using the DefaultSubscriptionPaymentStrategy.PREPAID strategy.

getPrice() - Method in class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

The price of the non-catalog-item.

getPrice() - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

The one-time price.

getPriceCartRequest() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

The initial PriceCartRequest to price the cart.

getPriceChangeEffectiveDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

The date and time when the price data change is to be taken into effect.

getPriceChangeEffectiveDate() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

The effective date of the price change.

getPriceChangeEffectiveType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

The descriptor of when the price change should take effect.

getPriceChangeEffectiveType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

Describes how the effective date of a subscription price change should be determined.

getPriceChangeScopeType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

Represents the default types of customer scope for which subscription bulk price changes can be applied.

getPriceDataChange() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChangeRequest

getPriceDataChanges() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

List of price data changes for this subscription

getPriceDataId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

The ID of the price data that is changed

getPriceDataId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

The id of the price data associated with this item.

getPriceDataId() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

The id of the updated price data tied to one or more subscriptions.

getPriceExpirationDateUTC() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Gathers the expiration date of the subscription's prices.

getPriceListId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

The contextId of the parent price list.

getPriceListId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

The id of the price list associated with this item.

getPricingKey() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

System-wide unique identifier to configure specific pricing for the choice.

getPricingKey() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

System-wide unique identifier to configure specific pricing for the choice.

getPricingProperties() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getPriorBillDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The bill date for the previous period

getPriority() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The priority of the policy/

getPriorPeriodFrequency() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The frequency with which the recurring price should be charged., e.g., a value of 1 combined with SubscriptionPricingContext.periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.

getPriorPeriodType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The period type for the price, e.g.

getPriorUnbilledAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

Prior to an upgrade, downgrade, or edit, the system may have prior unbilled charges that will be part of the next invoice.

getPriorUnbilledAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Gathers the prior unbilled portion of the item subtotal, which is based on the SubscriptionItemPriceDetail.getPriorUnbilledUnitAmount().

getPriorUnbilledAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Prior to an edit, upgrade, or downgrade on a subscription that’s using a Postpaid payment strategy, the system will have prior unbilled charges that will be part of the next invoice.

getPriorUnbilledDiscountAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Gathers the prior unbilled discount amount, which is the total discount offered on the prior unbilled price.

getPriorUnbilledUnitAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Prior to an edit, upgrade, or downgrade on a subscription that’s using a Postpaid payment strategy, the system will have prior unbilled charges that will be part of the next invoice.

getPriorUnbilledUnitDiscountAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The subscription item discount per unit to be deducted from the SubscriptionItemPriceDetail.getPriorUnbilledUnitAmount().

getProduct() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

If the SpecificItemChoice.type is DefaultSpecificItemChoiceType.PRODUCT this holds the product for this choice

getProduct() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The Product of the root SubscriptionItem.

getProductId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

The link to the product that this variant is a part of

getProductId() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The id of the product for this add item request.

getProducts() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Category

The first page of Products belonging to the category.

getProductsUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProviderProperties

The base uri path to the products endpoint

getProductUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProviderProperties

The base uri path to the products endpoint

getProperties() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

getProperties() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProvider

getProperties() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProvider

getProperties() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProvider

getProperties() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProvider

getProperties() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProvider

getProperties() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

getProratedAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

Prorated amount for this item (for new, this would match the amount)

getProratedAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Gathers the prorated portion of the item subtotal, which is based on the SubscriptionItemPriceDetail.getProratedUnitAmount().

getProratedAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The subscription price, prorated relative to the next invoice date.

getProratedDiscountAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Gathers the prorated discount amount, which is the total discount offered on the prorated price which is prorated relative to the next invoice date.

getProratedUnitAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The subscription item price per unit, prorated relative to the next invoice date.

getProratedUnitAmountBetweenActionAndNextBillDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Similar to SubscriptionItemPriceDetail.getProratedUnitAmountBetweenActionAndNextBillDate(), this is the SubscriptionItemAdjustmentPriceDetail.fullSubscriptionPeriodUnitDiscountAmount prorated for the period between the action date and the next bill date after subscription action, regardless of the subscription action being taken or the payment strategy.

getProratedUnitAmountBetweenActionAndNextBillDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The subscription item price per unit prorated for the period between the action date and the next invoice date regardless of the subscription action being taken or the payment strategy.

getProratedUnitAmountBetweenPeriodStartAndActionDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Similar to SubscriptionItemPriceDetail.getProratedUnitAmountBetweenPeriodStartAndActionDate(), this is the SubscriptionItemAdjustmentPriceDetail.fullSubscriptionPeriodUnitDiscountAmount prorated for the period between the period start date and the action date after subscription action, regardless of the subscription action being taken or the payment strategy.

getProratedUnitAmountBetweenPeriodStartAndActionDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The subscription item price per unit prorated for the period between the period start date and the action date and the regardless of the subscription action being taken or the payment strategy.

getProratedUnitDiscountAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Similar to SubscriptionItemPriceDetail.getProratedUnitAmount(), this is the original discount amount prorated relative to the next invoice date.

getProvider() - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationProviderProperties

getQualifierDetails() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

A list of OfferItemDetails representing the qualifier items where this adjustment was from.

getQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Quantity purchased.

getQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The item's quantity following the subscription action (e.g.

getQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The quantity of this item to be added to the Cart.

getQuantity() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Quantity purchased

getReadOfferUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOfferProviderProperties

The uri path to the endpoint that reads an offer based on the passed ID

getReason() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The reason for modifying the subscription.

getReasonCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

A system code used to identify the reason for the removal of the adjustment.

getReasonMessage() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

A message to the customer specifying why the adjustment is being removed.

getReceivedException() - Method in exception com.broadleafcommerce.subscriptionoperation.exception.ProviderApiException

The received error.

getRecurringPeriodFrequency() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The frequency of the recurring period, e.g., if this is 1 and AddItemRequest.recurringPeriodType is MONTHLY, then the recurring price should be charged every 1 month.

getRecurringPeriodType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The period type for the recurring price, e.g.

getRecurringPrice() - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

The amount of the recurring price.

getReference() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

An idempotency key that can be used to identify repeated requests

getRemainderOfTermsDiscountAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Gathers the remainder of terms discount amount, which is the total discount offered on the remainder of terms price.

getRemainderOfTermsUnitAmount() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The unit amount to charge for the remainder of terms if the remainder of terms is being charged.

getRemainingReservations() - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

The quantity of reservations remaining for the lock

getRemovedAdjustments() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The list of Adjustments being removed with additional contextual information.

getRemovedAdjustments() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The list of Adjustments being removed due to the proposed changes.

getRemovedSubscriptionItems() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

List of SubscriptionItems that are not on the cart.

getRequest() - Method in exception com.broadleafcommerce.subscriptionoperation.service.exception.UnsupportedSubscriptionModificationRequestException

getRequestAttributes() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionRequest

Additional request attributes.

getRequestedStatus() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.UpdateSubscriptionStatusRequest

The new status that's being requested.

getRequiredPermissions(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

Hook point to supply the permissions required to perform the given SubscriptionAction.

getRequiredPermissions(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

getRequiredPermissions(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

getRequiredPermissions(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateDowngradeSubscriptionHandler

getRequiredPermissions(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

getRequiredPermissions(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateUpgradeSubscriptionHandler

getReservationTokens() - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

The tokens associated with each of the optional child locks.

getRestrictDowngradeAfterDays() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

The number of days after which a downgrade is not allowed, until the window re-opens at the next billing cycle.

getRestrictDowngradeAfterDays() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.SubscriptionReferencedItem

The number of days after which a downgrade is not allowed, until the window re-opens at the next billing cycle.

getRestrictedTargets(String[], ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionAccessValidationService

Gets a Set of subscriptionIDs that the currently authenticated user is allowed to access if the user has restricted authorities with the restriction type of "SUBSCRIPTION".

getRestrictQtyDecreaseAfterDays() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The number of days after which a quantity decrease is not allowed until the window re-opens at the next billing cycle.

getRestrictRemovalAfterDays() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The number of days after which an item can't be removed from the subscription, until the window re-opens at the next billing cycle.

getResumeDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Date this subscription will or did continue.

getRootCartItemId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Reference to the root subscription CartItem

getRootItem() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

The item referenced by Subscription.getRootItemRef().

getRootItem() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The hydrated original root item of the subscription to be modified.

getRootItemRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Reference to the item id for which this subscription was provision

getRootItemRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Reference to the id of the item represented by this object.

getRootItemRef() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Reference to the item id for which this subscription was provision

getRootItemReferencedBySubscription(SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

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

getRootItemRefType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Type of the item for which this subscription was provisioned

getRootItemRefType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Type of item that this object represents.

getRootItemRefType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Type of the item for which this subscription was provisioned

getRootSubscriptionItemId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

ID of the root SubscriptionItem.

getRuleEvaluationService() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultCancellationPolicyService

getSalePrice() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Indicates that this product is on sale.

getSearchOnOption() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

If the product option is of type DefaultProductOptionType.VARIANT_DISTINGUISHING, this allows searching based on this product option.

getSecondarySourceRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The secondary source to reference, e.g, an Order Item on an Order.

getSecondarySourceRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

The secondary source to reference, e.g, an Order Item on an Order.

getSecondarySourceRef() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

The secondary source to reference, e.g, an Order Item on an Order.

getSecondarySourceType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The type of the secondary source to reference, e.g, an Order Item on an Order.

getSecondarySourceType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

The type of the secondary source to reference, e.g, an Order Item on an Order.

getSecondarySourceType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

The type of the secondary source to reference, e.g, an Order Item on an Order.

getSegmentsUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProviderProperties

The base uri path to the customer endpoint

getSelectionType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Describes restrictions placed on the customer's ability to select items from the targeted set.

getServiceClient() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProvider

getServiceClient() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProviderProperties

The service client to use when calling billing services.

getServiceClient() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProvider

Gets the name of the authorized client for this service making the call.

getServiceClient() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProviderProperties

The service client to use when calling an external service.

getServiceClient() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProvider

getServiceClient() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProviderProperties

The service client to use when calling catalog services.

getServiceClient() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProvider

getServiceClient() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProviderProperties

The service client to use when calling customer services.

getServiceClient() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOfferProviderProperties

The service client to use when calling offer/promotion services.

getServiceClient() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProvider

getServiceClient() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProviderProperties

The service client to use when calling Order services.

getServiceClient() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

The service client to use when calling billing services.

getServiceClient() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

getShortenedPeriodReason() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

Describes the reason that the period was shortened.

getShortenedPeriodReason() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

Describes the reason that the period was shortened.

getSiteIdentifier() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Multi-tenancy support

getSku() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Sku code for this particular variant.

getSku() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The SKU code for the item (e.g., Product or Variant).

getSpecificChoices() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

If the ItemChoice.targetType is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS or DefaultItemChoiceTargetType.SPECIFIC_VARIANTS this holds the manually-curated options that the customer can choose from.

getSpecificItemChoice() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

If the ItemChoice.targetType is DefaultItemChoiceTargetType.SPECIFIC_PRODUCT or DefaultItemChoiceTargetType.SPECIFIC_VARIANT this holds the manually selected option that the customer can choose to add on.

getStartChangeAutoRenewalWorkflowService() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

getStartOfTermDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The start of term date for this subscription.

getStartOfTermDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The date at which the subscription's terms will begin.

getState() - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

The current state of the lock

getStatusesToReadForSubscriptionSummary() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultUserSubscriptionSummaryService

Creates a list consisting of the active and former subscription statuses for reading the UserSubscriptionSummary

getSubOpsService() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

getSubOpsServiceProperties() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getSubOpsServiceProperties() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultUserSubscriptionSummaryService

getSubOpsServiceProperties() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

getSubscription() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

getSubscriptionAccessValidationService() - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.AccountSubscriptionOperationEndpoint

getSubscriptionAccessValidationService() - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.CustomerSubscriptionOperationEndpoint

getSubscriptionActionDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The timestamp at which the subscription action was taken.

getSubscriptionActionDate() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The timestamp at which the subscription action was taken.

getSubscriptionActionFlow(Cart, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getSubscriptionAdjustments() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Adjustments for this subscription.

getSubscriptionAdjustments() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Adjustments for this subscription.

getSubscriptionAdjustmentType() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

Type of adjustment that this adds

getSubscriptionAdjustmentType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

getSubscriptionAdjustmentType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

getSubscriptionAdjustmentType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

getSubscriptionCancellationProperties() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

getSubscriptionGenerationService() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getSubscriptionId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The id of delayed action's related subscription.

getSubscriptionId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionAdjustmentDetail

Id of the Subscription.

getSubscriptionId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

getSubscriptionId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

The subscription ID that the lock is associated with

getSubscriptionId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

The ID of the Subscription to add the offer to.

getSubscriptionId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The id of the subscription of which the adjustment going to be removed belongs to.

getSubscriptionId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

Reference to the Subscription whose price this adjusts

getSubscriptionId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Reference the subscription for this item

getSubscriptionId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

Identifier for the subscription

getSubscriptionId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

getSubscriptionId() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The id of the subscription to modify.

getSubscriptionId() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionRequest

The id of the subscription to get the available actions for.

getSubscriptionId() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.UpdateSubscriptionStatusRequest

The id of the subscription to modify.

getSubscriptionItemAdjustmentId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The id of the subscription item adjustment that will actually be removed.

getSubscriptionItemAdjustmentRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Reference to the SubscriptionItemAdjustment

getSubscriptionItemAdjustments() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Adjustments for this subscription.

getSubscriptionItemAdjustments() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Adjustments for this subscription.

getSubscriptionItemId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemAdjustmentDetail

Id of the SubscriptionItem.

getSubscriptionItemId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

getSubscriptionItemId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The id of the subscription item of which the adjustment going to be removed belongs to.

getSubscriptionItemId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

Reference to the SubscriptionItem whose price this adjusts

getSubscriptionItemName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The id of the subscription item of which the adjustment going to be removed belongs to.

getSubscriptionItemQuantity(OrderItem, SubscriptionItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Scales the dependent item's quantity based on the parent item.

getSubscriptionItems() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

getSubscriptionModificationUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultUserSubscriptionSummaryService

getSubscriptionModificationUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

getSubscriptionName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The id of the subscription of which the adjustment going to be removed belongs to.

getSubscriptionNextStatus() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Next status for this subscription

getSubscriptionNextStatus() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Next status for this subscription

getSubscriptionOperationService() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionValidationService

getSubscriptionOperationService() - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.AccountSubscriptionOperationEndpoint

getSubscriptionOperationService() - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.CustomerSubscriptionOperationEndpoint

getSubscriptionOperationService() - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

getSubscriptionOperationUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

getSubscriptionOperationUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getSubscriptionOperationUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getSubscriptionOperationUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

getSubscriptionOrderHistoryService() - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOrderHistoryEndpoint

getSubscriptionOwnerInfoPageType() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

Gets the type reference for a page generator of SubscriptionOwnerInfo.

getSubscriptionPaymentStrategy(CartItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getSubscriptionPriceDataBaseUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

Gets the base URI to read subscription price data.

getSubscriptionPriceDataPath() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

The base uri path to the subscription price data endpoint

getSubscriptionPricingService() - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionPricingEndpoint

getSubscriptionProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

getSubscriptionProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getSubscriptionProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOrderHistoryService

getSubscriptionProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getSubscriptionProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultUserSubscriptionSummaryService

getSubscriptionProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

getSubscriptionProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

getSubscriptionRootItem() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The CartItem representing the root SubscriptionItem.

getSubscriptionsByApplication() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChangeRequest

getSubscriptionSource() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

This field shows from which process or user action this subscription originated.

getSubscriptionSource() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

This field shows from which process or user action this subscription originated.

getSubscriptionSourceRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

This field shows the identifier of the process or user action this subscription originated.

getSubscriptionSourceRef() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

This field shows the identifier of the process or user action this subscription originated.

getSubscriptionsPath() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

The base uri path to the subscription endpoint

getSubscriptionStatus() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Current status of this subscription

getSubscriptionStatus() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Current status of this subscription

getSubscriptionStatusHandler(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getSubscriptionStatusHandlers() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getSubscriptionValidationService() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getSubscriptionWithItems() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Holds the SubscriptionWithItems referenced by ModifySubscriptionRequest.subscriptionId.

getSubscriptionWithItems() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionResponse

getSubscriptionWithItemsBaseUri() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

Gets the base URI to read subscription with items.

getSubscriptionWithItemsByCartItemMap(List<C>, Map<String, C>, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Builds a Map of <CartItem, SubscriptionWithItems> from the rootItems and cartItemBySubscriptionId for quick lookup of subscription by its cartItem.

getSubscriptionWithItemsPageSize() - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationServiceProperties

the default page size for gathering SubscriptionWithItems from BillingServices

getSubscriptionWithItemsPath() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

The base uri path to the subscription with items endpoint

getTargetType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Identifies the type of items that a customer can choose from, whether specific products, specific variants, or products from a specific category.

getTaxCategory() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Tax category of the item

getTaxCategory() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Tax category of the item

getTaxCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

The tax code for this variant.

getTaxNexus() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Comma-separated nexus codes

getTermDurationLength() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The length of the terms, e.g., if this is 36 and Subscription.termDurationType is MONTHS, then the user should be billed for 36 months.

getTermDurationLength() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The length of the term duration selected for the item, if any.

getTermDurationLength() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

The length of the terms, e.g., if this is 36 and SubscriptionCreationRequest.termDurationType is MONTHS, then the user should be billed for 36 months.

getTermDurationType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The term duration type, e.g.

getTermDurationType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The type of the term duration selected for the item, if any.

getTermDurationType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

The term duration type, e.g.

getTokenResponse(OAuth2ClientCredentialsGrantRequest) - Method in class com.broadleafcommerce.subscriptionoperation.oauth2.client.endpoint.OAuth2ClientCredentialsAccessTokenResponseClient

Deprecated.

getTrackablePolicyUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionAccessValidationService

getType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

Controls both how the customer should be inputting values to fill out this option as well as storage of where the value will go once added to the cart.

getType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

Whether or not this item holds a product or a variant that the customer can select from

getType() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProvider

getType() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

getType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

Allows optionally setting the type of cart to be created.

getTypeFactory() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultCancellationPolicyService

getTypeFactory() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

getTypeFactory() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getTypeFactory() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getTypeFactory() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultUserSubscriptionSummaryService

getTypeFactory() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

getTypeFactory() - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.SubscriptionModificationUtils

getTypeFactory() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.AbstractExternalProvider

getTypeFactory() - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.AccountSubscriptionOperationEndpoint

getTypeFactory() - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.CustomerSubscriptionOperationEndpoint

getTypicalRecurringUnitAmount(CartItem, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getUnavailableReasonsByActionType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

The unavailable SubscriptionActionTypes along with unavailable reasons for this subscription.

getUnavailableReasonsByActionType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionResponse

The unavailable SubscriptionActionTypes along with unavailable reasons for this subscription.

getUnitChargeForPreviouslyDiscountedPeriods() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The unit discount amount to charge for previously discounted periods.

getUnitDiscountAmountForRemainderOfTerms() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The unit discount amount that is to be applied for the remainder of terms if the remainder of terms is being charged.

getUpc() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Universal product code that defines this particular variant of the product

getUpgradeOptionReferences() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

getUpgradeOptionReferences() - Method in interface com.broadleafcommerce.subscriptionoperation.domain.SubscriptionReferencedItem

List of references (usually IDs) to items that this can upgrade to.

getUpgradeProductIds() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

The list of ids of the product that this product can upgrade to.

getUrl() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProviderProperties

The base url for an external service holding cancellation policies.

getUrl() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProviderProperties

The base url for an external cart operation service.

getUrl() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProviderProperties

The base url for an external service holding products.

getUrl() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProviderProperties

The base url for an external service concerning customers.

getUrl() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOfferProviderProperties

The base url for an external service concerning offers.

getUrl() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProviderProperties

The base url for an external order service.

getUrl() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

The base url for an external service holding subscriptions.

getUsagePrice() - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

The amount of the usage price.

getUserRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Reference to the user to whom this subscription belongs

getUserRef() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

Reference to the user to whom this subscription belongs

getUserRef() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The reference to the user requesting to perform the modification.

getUserRef() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionRequest

The reference to the user making the request.

getUserRef() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Reference to the user to whom this subscription belongs

getUserRefType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Type of user owning this subscription

getUserRefType() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

Type of user owning this subscription.

getUserRefType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The type of user requesting to preform the modification.

getUserRefType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionRequest

The type of the user making the request.

getUserRefType() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Type of user owning this subscription

getUserSubscriptionSummaryService() - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

getVariant() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

If the SpecificItemChoice.type is DefaultSpecificItemChoiceType.VARIANT this holds the variant for this choice

getVariantId() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The id of the variant for this add item request.

getVariantParentProductId() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

This field contains the id of the parent product of the specified SpecificItemChoice.variant if the type is DefaultSpecificItemChoiceType.VARIANT.

getVersion() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The version of this subscription.

getVersion() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The version of the cart being modified.

getWebClient() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.AbstractExternalProvider

getWorkflowName() - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The name of the workflow that created this delayed action.

getWorkflowName(Subscription) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultStartChangeAutoRenewalWorkflowService

getWorkflowProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

getWorkflowProvider() - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

getZoneId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Returns the ZoneId for the given customer timezone string.

getZoneId(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

Returns the ZoneId for the given customer timezone string.

GRACE_PERIOD_CANCELLATION_FEE_PRODUCT - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionActionConstants

Name of the attribute on SubscriptionAction.getActionInfo() that stores the available cancellation-policy's grace-period cancellation-fee product for action type of DefaultSubscriptionActionType.CANCEL if applicable.

H

handle(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

handle(ModifySubscriptionRequest, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.modification.ModifySubscriptionHandler

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

handleIllegalResponseException(IllegalResponseException, WebRequest) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.exception.SubscriptionOperationExceptionAdvisor

handleIllegalSubscriptionPricingStateException(IllegalSubscriptionPricingStateException, WebRequest) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.exception.SubscriptionOperationExceptionAdvisor

handleInternal(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

handleInternal(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

Hookpoint for custom logic specific to a particular modification request.

handleInternal(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

handleInternal(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

handleInternal(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

handleInvalidSubscriptionAccessException(InsufficientSubscriptionAccessException, WebRequest) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.exception.SubscriptionOperationExceptionAdvisor

handleInvalidSubscriptionCreationRequestException(InvalidSubscriptionCreationRequestException, WebRequest) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.exception.SubscriptionOperationExceptionAdvisor

handleProviderApiError(ProviderApiException, WebRequest) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.exception.SubscriptionOperationExceptionAdvisor

handleStatusUpdateRequest(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

handleSubscriptionLockException(SubscriptionLockException, WebRequest) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.exception.SubscriptionOperationExceptionAdvisor

handleUnsupportedSubscriptionModificationRequestException(UnsupportedSubscriptionModificationRequestException, WebRequest) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.exception.SubscriptionOperationExceptionAdvisor

hasBillingFrequencyChange() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

hasBillingFrequencyChange(Subscription, CartItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines if the billing frequency has changed between the existing subscription and the subscription root item.

hasDelayedDowngradeDueAtEndOfCurrentPeriod(Subscription) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

hasFreeTrial() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Determines if the subscription has a free trial still applied.

hasFreeTrial(CartItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Category

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionAdjustmentDetail

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemAdjustmentDetail

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChangeRequest

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAction

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.UserSubscriptionSummary

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationJpaProperties

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationProviderProperties

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SSLVerificationProperties

Deprecated.

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProviderProperties

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProviderProperties

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProviderProperties

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOfferProviderProperties

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProviderProperties

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionPricingProperties

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateSubscriptionFromOrderRequest

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyRequest

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyResponse

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionResponse

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.PriceCartRequest

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionRequest

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionResponse

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

hashCode() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.UpdateSubscriptionStatusRequest

hasMatchingBillingFrequency(RecurringPriceDetail, SubscriptionPricingContext) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

hasNewAddonsToAdd(Set<SubscriptionItem>, Set<String>, Map<String, ItemChoice>, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

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

hasTerm() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

hasTerms(OrderItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Checks the OrderItem for terms.

hydrateAdditionalContextOntoRequest(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

hydrateAdditionalContextOntoRequest(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

Handles hydrating any additional contextual information onto the ModifySubscriptionRequest that the handler needs.

hydrateAdditionalContextOntoRequest(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

hydrateAdditionalContextOntoRequest(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

hydrateCancellationPoliciesForCartItems(Cart, Collection<T>, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Retrieves all of the CancellationPolicies for the root subscription items for a cancellation flow and hydrates them onto the CartItem in their CartItem.getInternalAttributes() as CartItemAttributeConstants.Internal.HYDRATED_CANCELLATION_POLICY.

HYDRATED_CANCELLATION_POLICY - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

Hydrated CancellationPolicy based on the CartItem.getCancellationPolicyRef().

hydrateProductsAndItemChoices(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

hydrateSubscriptionReferencedItems(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

Hydrate the root item and item to upgrade/downgrade to onto the ModifySubscriptionRequest.

I

ID_IN_QUERY_PARAM - Static variable in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProvider

identifyCancellationPolicy(IdentifyCancellationPolicyRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultCancellationPolicyService

identifyCancellationPolicy(List<C>, CartItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultCancellationPolicyService

Identifies the matching cancellation policy for the given cart item.

identifyCancellationPolicy(IdentifyCancellationPolicyRequest, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.CancellationPolicyService

Identifies the CancellationPolicy for the given IdentifyCancellationPolicyRequest.

identifyCancellationPolicy(IdentifyCancellationPolicyRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.CancellationPolicyOperationEndpoint

IdentifyCancellationPolicyRequest - Class in com.broadleafcommerce.subscriptionoperation.web.domain

Request DTO containing the CartItems to identify the cancellation policies for.

IdentifyCancellationPolicyRequest() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyRequest

IdentifyCancellationPolicyResponse - Class in com.broadleafcommerce.subscriptionoperation.web.domain

Response DTO describing the result of identifying the cancellation policies for the CartItems

IdentifyCancellationPolicyResponse() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyResponse

identifyRemovedSubscriptionItems(SubscriptionPricingContext, SubscriptionWithItems, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

identifySubscriptionRootItems(Cart, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines which CartItems on the Cart are root SubscriptionItems.

identifySubscriptionRootItems(CreateSubscriptionFromOrderRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Identifies the root OrderItems for which to build separate Subscriptions.

identifySubscriptionRootItemsAsStream(Cart, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

IllegalResponseException - Exception in com.broadleafcommerce.subscriptionoperation.service.exception

Exception thrown when an API call received an invalid response.

IllegalResponseException(String) - Constructor for exception com.broadleafcommerce.subscriptionoperation.service.exception.IllegalResponseException

IllegalSubscriptionPricingStateException - Exception in com.broadleafcommerce.subscriptionoperation.service.exception

Thrown when the system state is not valid for a subscription pricing request.

IllegalSubscriptionPricingStateException(String) - Constructor for exception com.broadleafcommerce.subscriptionoperation.service.exception.IllegalSubscriptionPricingStateException

IllegalSubscriptionPricingStateException(String, String) - Constructor for exception com.broadleafcommerce.subscriptionoperation.service.exception.IllegalSubscriptionPricingStateException

Creates a new exception, allowing distinct messages to be returned to the caller for display vs logged for debugging.

IllegalSubscriptionPricingStateException(String, String, Throwable) - Constructor for exception com.broadleafcommerce.subscriptionoperation.service.exception.IllegalSubscriptionPricingStateException

Creates a new exception, allowing distinct messages to be returned to the caller for display vs logged for debugging.

IllegalSubscriptionPricingStateException(String, Throwable) - Constructor for exception com.broadleafcommerce.subscriptionoperation.service.exception.IllegalSubscriptionPricingStateException

IMMEDIATE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultCancellationStrategy

Cancel the subscription immediately

INCLUDES_EXTRA_FEES - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartAttributeConstants

Stores the computed value of whether the extra fees would be levied/charged on cancelling the subscription.

INCORRECT_STATE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

The subscription is in an incorrect state for the given action.

InitiateCancelSubscriptionHandler - Class in com.broadleafcommerce.subscriptionoperation.service.modification

Handles initiating a Subscription cancellation flow.

InitiateCancelSubscriptionHandler(TypeFactory, SubscriptionModificationUtils, CancellationPolicyProvider<CancellationPolicy>, CartOperationProvider<Cart>, SubscriptionCancellationProperties, SubscriptionOperationUtils, SubscriptionProvider<SubscriptionWithItems, Subscription, SubscriptionOwnerInfo>, SubscriptionOperationServiceProperties) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

initiateDowngradeSubscriptionHandler(TypeFactory, SubscriptionModificationUtils, CatalogProvider<Product>, CartOperationProvider<Cart>) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

InitiateDowngradeSubscriptionHandler - Class in com.broadleafcommerce.subscriptionoperation.service.modification

Handles downgrading a Subscription.

InitiateDowngradeSubscriptionHandler(TypeFactory, SubscriptionModificationUtils, CatalogProvider<Product>, CartOperationProvider<Cart>) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateDowngradeSubscriptionHandler

initiateEditSubscriptionHandler(TypeFactory, SubscriptionModificationUtils, CartOperationProvider<Cart>, CatalogProvider<Product>, MessageSource) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

InitiateEditSubscriptionHandler - Class in com.broadleafcommerce.subscriptionoperation.service.modification

Handles initiating the edit-Subscription flow.

InitiateEditSubscriptionHandler(TypeFactory, SubscriptionModificationUtils, CartOperationProvider<Cart>, CatalogProvider<Product>, MessageSource) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

initiateUpgradeSubscriptionHandler(TypeFactory, SubscriptionModificationUtils, CatalogProvider<Product>, CartOperationProvider<Cart>) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

InitiateUpgradeSubscriptionHandler - Class in com.broadleafcommerce.subscriptionoperation.service.modification

Handles upgrading a Subscription.

InitiateUpgradeSubscriptionHandler(TypeFactory, SubscriptionModificationUtils, CatalogProvider<Product>, CartOperationProvider<Cart>) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateUpgradeSubscriptionHandler

INSUFFICIENT_PERMISSIONS - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

The user doesn't have sufficient permissions to perform the action against this subscription.

InsufficientSubscriptionAccessException - Exception in com.broadleafcommerce.subscriptionoperation.service.exception

Exception denoting that the user does not have sufficient access to the subscription.

InsufficientSubscriptionAccessException(String) - Constructor for exception com.broadleafcommerce.subscriptionoperation.service.exception.InsufficientSubscriptionAccessException

Internal() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.constants.CartAttributeConstants.Internal

Internal() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

Internal() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionAttributeConstants.Internal

InvalidSubscriptionCreationRequestException - Exception in com.broadleafcommerce.subscriptionoperation.service.exception

Exception denoting that the request to create a subscription was invalid

InvalidSubscriptionCreationRequestException(String) - Constructor for exception com.broadleafcommerce.subscriptionoperation.service.exception.InvalidSubscriptionCreationRequestException

InvalidSubscriptionModificationRequestException - Exception in com.broadleafcommerce.subscriptionoperation.service.exception

Exception denoting that the request to modify a subscription was invalid

InvalidSubscriptionModificationRequestException(String) - Constructor for exception com.broadleafcommerce.subscriptionoperation.service.exception.InvalidSubscriptionModificationRequestException

InvalidSubscriptionStatusChangeRequestException - Exception in com.broadleafcommerce.subscriptionoperation.service.exception

Exception denoting that the request to change a subscription's status was invalid

InvalidSubscriptionStatusChangeRequestException(String) - Constructor for exception com.broadleafcommerce.subscriptionoperation.service.exception.InvalidSubscriptionStatusChangeRequestException

INVENTORY_TYPE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

The following internal attributes are temporary storage locations for fulfillment related information to be used for populating a FulfillmentItem.

IS_BROADLEAF_SUBSCRIPTION - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

The value of Product#isSubscription().

IS_CANCELLATION_REQUEST - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

Whether this is a cancellation request for a subscription item.

IS_IN_GRACE_PERIOD - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartAttributeConstants

Stores the computed value of whether the subscription is in grace period.

IS_SEPARATE_FROM_PRIMARY_ITEM - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

Describes if a given subscription item should be split into its own subscription

isActionDuringFreeTrial() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Determines whether the action being performed is within the free trial timeframe, only relevant for subscription modification flows when free trial is involved.

isActionNotAllowed(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

isActive() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Inactive variants are by default NOT searchable, NOT browseable, and NOT purchaseable.

isActive(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

isAdjustmentApplicableForPeriod(int, Integer, SubscriptionPricingContext, Integer) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines whether the given adjustment is applicable for the given period.

isAdjustmentApplicableForPeriod(SubscriptionItemAdjustment, SubscriptionPricingContext, Integer) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

isAdjustmentApplicableForPeriod(Adjustment, SubscriptionPricingContext, Integer) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

isAllCustomers(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.pricing.type.PriceDataAppliesToType

isAllowAddAfterInitialPurchase() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Whether the customer is allowed to add an optional item after initial purchase.

isAllowAutoRenewalModification() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

This flag indicates whether this subscription's auto-renewability can be modified after declaration on the subscription.

isAllowCancellation() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

Whether the customer can cancel their service before the end of the agreement.

isAllowChangingBillingFrequency() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

Whether the billing frequency can be changed after initial purchase.

isAllowEditAfterInitialPurchase() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Whether edit is allowed after initial purchase.

isAllowQtyEditAfterInitialPurchase() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Whether quantity can be edited after initial purchase.

isAllowQtyEditAfterInitialPurchase() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

Whether quantity can be edited after initial purchase.

isAllowRemoveAfterInitialPurchase() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Whether the customer is allowed to remove an optional item after initial purchase.

isAmountOff(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionAdjustmentType

isAnnually(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionPeriodType

isAnyCurrentAddonsEditable(Set<SubscriptionItem>, Map<String, ItemChoice>, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

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

isAnyModification(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

Determines whether the given value of flow fits one of the default modification flow types, e.g., DefaultSubscriptionActionFlow.EDIT, DefaultSubscriptionActionFlow.UPGRADE, or DefaultSubscriptionActionFlow.DOWNGRADE.

isApplicableForThisPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Whether this adjustment is applicable for the period that this detail is built for.

isApplyToDependentItems() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

Indicates whether the Offer should also be applied to the dependent items.

isArchived() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Whether this item is archived

isAutoRenew(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

isAutoRenew(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.EndOfTermStrategy

isAutoRenewalEnabled() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Whether this subscription automatically renews at the end of the current subscription term.

isAutoRenewalEnabled() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The value to change Subscription.isAutoRenewalEnabled() to.

isAutoRenewalEnabled() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Whether this subscription automatically renews at the end of the current subscription term.

isBillingFrequencyChange(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultShortenedPeriodReason

isBroadleafAccount(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultUserRefTypes

isBroadleafCustomer(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultUserRefTypes

isBroadleafOrder(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionSourceType

isBroadleafOrderItem(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionSourceType

isBroadleafProduct(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionItemReferenceType

isCancel(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

isCancel(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionType

isCancel(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.EndOfTermStrategy

isCancelAutoRenewal(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultCancellationStrategy

isCancelled(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

isCartAttributeProductOption(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultProductOptionType

isCartItemAttributeProductOption(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultProductOptionType

isCategory(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceTargetType

isChangeAutoRenewal(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

isChangeAutoRenewal(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionType

isChargeback() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Whether this subscription is being cancelled due to a chargeback

isChargeForPreviouslyReceivedDiscountAmounts() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

Whether the customer would be charged for any discounts he/she received before cancelling the subscription.

isChargeForRemainderOfTerms() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

Whether the customer would be charged for the remainder of the term despite cancelling the subscription.

isChargeFullPriceForRemainderOfTerms() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

Whether the customer would be charged the full price for the remainder of the term despite cancelling the subscription.

isChildLock() - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

Whether the lock is a child lock

isChildLock(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus.LockStatusBuilder

Whether the lock is a child lock

isChooseMultiple(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceSelectionType

isChooseOne(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceSelectionType

isCreate(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

isCreditedUnitAmount(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

isCreditedUnitDiscountAmount(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

isCsrAddAdjustment(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

isCurrentDateBeyondDowngradeAvailabilityDuration(ModifySubscriptionRequest) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateDowngradeSubscriptionHandler

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

isCurrentDateBeyondDowngradeAvailabilityDuration(SWI) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

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

isCurrentPeriod(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Determines whether the given period number is the current subscription period.

isCurrentPeriod(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.offer.type.AdjustmentApplicationDateType

isCustomerSegments(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.pricing.type.PriceDataAppliesToType

isDays(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultTermDurationType

isDecreaseInQuantity(Integer, Integer) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

isDisableAutoRenewal(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionNextStatusChangeReason

isDisabled() - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SSLVerificationProperties

Deprecated.

Dictates whether SSL verification should be disabled.

isDiscountable() - Method in class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

Whether this non-catalog item can receive discounts.

isDiscountable() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Whether or not this variant can participate in offers or promotions

isDiscountAllowed() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Dictates whether or not discounts are allowed to be applied to this choice.

isDiscountAllowed() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

Dictates whether or not discounts are allowed to be applied to this add-on.

isDiscountAllowedForCancellationCharge() - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionCancellationProperties

Whether a discount amount can be applied to the cancellation charge.

isDowngrade(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

isDowngrade(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionType

isDowngradeWindowPassed(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

isEdit(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

isEdit(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionType

isEndOfTerms(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultShortenedPeriodReason

isEntityNotFound(ResponseEntity<ApiError>) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.AbstractExternalProvider

Determines if the given ResponseEntity indicates entity not found.

isError(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

isFirstPeriod(Integer, SubscriptionPricingContext) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines whether the given period is the first period based on the given SubscriptionPricingContext.

isFixedPrice(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionAdjustmentType

isFreeTrial() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

Whether this period represents a free trial period.

isFreeTrialExpired() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Determines whether an existing free trial was expired.

isFreeTrialLost() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Determines whether an existing free trial was lost, different from expired, due to the subscription modification.

isFulfillmentInProcess(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

isGracePeriodRecursEachBillingPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

Whether the grace period repeats after each billing period.

isGracePeriodSupported() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

Whether grace period properties are enabled.

isHasPostPurchaseEditRules() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Whether this has post purchase edit rules.

isImmediate(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultCancellationStrategy

isImmediateCancellation() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Should this subscription be cancelled immediately?

isIncorrectState(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

isInsufficientPermissions(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

isItemChoiceProductOption(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultProductOptionType

isLocked(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.LockState

isMonthly(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionPeriodType

isMonths(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultTermDurationType

isNeedGrantEntitlements() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Whether the system has outstanding entitlements to grant on this subscription

isNeedGrantEntitlements() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Whether the system has outstanding entitlements to grant for this subscription

isNextBillDate(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultDelayedSubscriptionActionEffectiveType

isNextBillDate(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultPriceChangeEffectiveType

isNextBillDate(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.offer.type.AdjustmentApplicationDateType

isNextBillDate(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.pricing.type.PriceDataApplicationDateType

isNoCharge(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultCancellationChargeStrategy

isNoDowngradeAvailable(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

isNoUpgradeAvailable(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

isOnline() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Whether or not this variant should be visible at all in the store.

isOnSale() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

An item is on sale if both Variant.getDefaultPrice() and Variant.getSalePrice() are both set

isPaused(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

isPendingCancellation(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

isPendingFulfillment(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

isPercentOff(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionAdjustmentType

isPostpaid(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionPaymentStrategy

isPrepaid(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionPaymentStrategy

isPrepaidDowngrade(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultDelayedSubscriptionActionType

isPrepaidItemRemoval(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultDelayedSubscriptionActionType

isPrepaidItemUpdate(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultDelayedSubscriptionActionType

isPriceChange(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

isPriorUnbilledUnitAmount(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

isPriorUnbilledUnitDiscountAmount(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

isProrated(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultCancellationChargeStrategy

isProratedUnitAmount(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

isProratedUnitDiscountAmount(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

isQuarterly(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionPeriodType

isRedemptionCode(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionSourceType

isRejected(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.LockState

isRemainderOfTermsUnitAmount(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

isRemainderOfTermsUnitDiscountAmount(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

isReplaceExisting() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

Indicates whether this request should replace all other adjustments on the subscription.

isRequiredAddOn(ItemChoice) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

Determines if the current addOn is a required add-on.

isRequiresDirectReference() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

Whether the policy requires direct reference via Product or PriceData references.

isSeparateFromPrimaryItem() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Whether this is a sub-item on the main subscription or a separate item.

isSeparateFromPrimaryItem(CartItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

isSeparateFromPrimaryItem(OrderItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

isShortenedPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

isShortenedPeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

isSpecificItem(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceTargetType

Checks if the selection is DefaultItemChoiceTargetType.SPECIFIC_PRODUCT or DefaultItemChoiceTargetType.SPECIFIC_VARIANT (singular).

isSpecificItems(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceTargetType

Checks if the selection is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS or DefaultItemChoiceTargetType.SPECIFIC_VARIANTS (plural).

isSpecificProductOrProducts(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceTargetType

isSpecificVariantOrVariants(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceTargetType

isStartChangeAutoRenewalWorkflowEnabled() - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionCancellationProperties

Whether or not to trigger the workflow from the ChangeSubscriptionAutoRenewalHandler

isSubscription() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Whether this addon is a subscription addon.

isSubscriptionInGracePeriod() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Whether the SubscriptionPricingContext.existingSubscription is within its grace period during a cancellation flow.

isSubscriptionInGracePeriod(CancellationPolicyDetail, Subscription) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

Determines whether the given Subscription is in its cancellation grace period.

isSubscriptionInGracePeriod(CancellationPolicyDetail, SubscriptionWithItems) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

isSubscriptionItem(CartItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

isSubscriptionItem(OrderItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

isTaxable() - Method in class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

Whether this non-catalog item is taxable.

isTaxable() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Whether this item is taxable

isTaxable() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Whether this item is taxable

isTaxAllowedForCancellationCharge() - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionCancellationProperties

Whether tax should be calculated on the cancellation charge

isTerminate(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

isUnitChargeForPreviouslyDiscountedPeriods(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

isUnlocked(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.LockState

isUpdateCatalogPricing() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.PriceCartRequest

Declares if catalog prices should also be gathered as part of the repricing process.

isUpgrade(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

isUpgrade(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionType

isVariantDistinguishingProductOption(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultProductOptionType

isWeeks(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultTermDurationType

isYears(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultTermDurationType

ITEM_CHOICE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultProductOptionType

Allows the user to select an additional item that is added to their cart

ITEM_DEPENDENT_ITEM_DETAILS_ATTR - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

ItemChoice - Class in com.broadleafcommerce.subscriptionoperation.domain

Configuration state for DefaultProductOptionType.ITEM_CHOICE.

ItemChoice() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

L

LOCKED - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.LockState

The lock is currently active

lockId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus.LockStatusBuilder

The ID of the lock

LockState - Enum Class in com.broadleafcommerce.subscriptionoperation.domain

LockStatus - Class in com.broadleafcommerce.subscriptionoperation.domain

Informative DTO about the lock status.

LockStatus.LockStatusBuilder - Class in com.broadleafcommerce.subscriptionoperation.domain

lockSubscription(String, List<String>) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

lockSubscription(String, List<String>) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

lockSubscription(String, List<String>) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Create a top-level lock for a subscription

lockSubscription(String, List<String>) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

Attempt to create a lock on a subscription.

lockSubscription(String, List<String>) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

Attempt to create a lock on a subscription.

logDebug(Exception, WebRequest) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.exception.SubscriptionOperationExceptionAdvisor

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of central logging managed by ExceptionHandlerUtils.

logError(Exception, WebRequest) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.exception.SubscriptionOperationExceptionAdvisor

Deprecated, for removal: This API element is subject to removal in a future version.

Deprecated in favor of central logging managed by ExceptionHandlerUtils.

M

modifySubscription(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

modifySubscription(ModifySubscriptionRequest, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

Handles modifying Subscriptions based on the allowed actions.

modifySubscription(String, ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

modifySubscription(String, String, ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.AccountSubscriptionOperationEndpoint

modifySubscription(String, String, ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.CustomerSubscriptionOperationEndpoint

ModifySubscriptionHandler - Interface in com.broadleafcommerce.subscriptionoperation.service.modification

Represents a component responsible for handling business logic related to some type of modification performed upon a Subscription such as upgrade, downgrade, cancel, etc.

ModifySubscriptionRequest - Class in com.broadleafcommerce.subscriptionoperation.web.domain

Represents a request to modify a user's subscription.

ModifySubscriptionRequest() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

ModifySubscriptionResponse - Class in com.broadleafcommerce.subscriptionoperation.web.domain

ModifySubscriptionResponse() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionResponse

MONTHLY - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionPeriodType

MONTHS - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultTermDurationType

N

NEXT_BILL_DATE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultDelayedSubscriptionActionEffectiveType

The subscription action should take effect at the next subscription bill date - i.e.

NEXT_BILL_DATE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultPriceChangeEffectiveType

The price change should take effect immediately on the next bill date.

NEXT_BILL_DATE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.offer.type.AdjustmentApplicationDateType

The SubscriptionItemAdjustment is added onto the SubscriptionItem on the next billing period.

NEXT_BILL_DATE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.pricing.type.PriceDataApplicationDateType

The PriceChangeRequest is applied on the next billing period.

NO_CHARGE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultCancellationChargeStrategy

No charge to the customer.

NO_DOWNGRADE_AVAILABLE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

There is no downgrade available for this subscription.

NO_UPGRADE_AVAILABLE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

There is no upgrade available for this subscription.

NonCatalogItemDetails - Class in com.broadleafcommerce.subscriptionoperation.domain

A DTO for specifying the details for a non-catalog item in a cart.

NonCatalogItemDetails() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

O

OAuth2ClientCredentialsAccessTokenResponseClient - Class in com.broadleafcommerce.subscriptionoperation.oauth2.client.endpoint

Deprecated, for removal: This API element is subject to removal in a future version.

Use CommonOAuth2ClientCredentialsAccessTokenResponseClient instead

OAuth2ClientCredentialsAccessTokenResponseClient(WebClient) - Constructor for class com.broadleafcommerce.subscriptionoperation.oauth2.client.endpoint.OAuth2ClientCredentialsAccessTokenResponseClient

Deprecated.

OFFER_REF - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants.AddAdjustmentWorkflow

OFFER_REF_TYPE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants.AddAdjustmentWorkflow

ORDER_IDS - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionAttributeConstants.Internal

The collection of the Order IDs related to the subscription.

orderItemRepresentsActionToExistingSubscription(Order, OrderItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

OrderProvider<O extends com.broadleafcommerce.order.client.domain.Order> - Interface in com.broadleafcommerce.subscriptionoperation.service.provider

Provider interfacing with a service or datastore providing Order entity details.

ORIGINAL_FREE_TRIAL_END_DATE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionPeriodAttributeConstants

The original free trial end date.

ORIGINAL_FREE_TRIAL_LENGTH - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionPeriodAttributeConstants

The original free trial length.

ORIGINAL_FREE_TRIAL_LENGTH_UNITS - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionPeriodAttributeConstants

The original free trial length units.

P

pageableToParams(Pageable) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.AbstractExternalProvider

Converts a pageable into its corresponding query parameters.

PARENT_WORKFLOW_REFERENCE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

PAUSED - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

Indicates a subscription whose activity is temporarily halted

pausedSubscriptionStatusHandler() - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration.SubscriptionStatusChangeHandlersConfiguration

PausedSubscriptionStatusHandler<SWI extends SubscriptionWithItems> - Class in com.broadleafcommerce.subscriptionoperation.service.status

The default handler that validates if the Subscription status can be changed to SubscriptionStatuses.PAUSED

PausedSubscriptionStatusHandler() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.status.PausedSubscriptionStatusHandler

PENDING_CANCELLATION - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

Indicates a subscription that should be cancelled soon

PENDING_FULFILLMENT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

Indicates that the subscription is pending fulfillment.

PENDING_SUBSCRIPTION_ITEM_ADJUSTMENT_REMOVAL_DETAILS - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartAttributeConstants.Internal

The list of PendingSubscriptionItemAdjustmentRemovals containing details of the subscription item adjustments that will be removed from the subscription items as a result of the subscription cancellation.

pendingCancellationSubscriptionStatusHandler() - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration.SubscriptionStatusChangeHandlersConfiguration

PendingCancellationSubscriptionStatusHandler<SWI extends SubscriptionWithItems> - Class in com.broadleafcommerce.subscriptionoperation.service.status

The default handler that validates if the Subscription status can be changed to SubscriptionStatuses.PENDING_CANCELLATION

PendingCancellationSubscriptionStatusHandler() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.status.PendingCancellationSubscriptionStatusHandler

PendingSubscriptionItemAdjustmentRemoval - Class in com.broadleafcommerce.subscriptionoperation.domain.offer

Represents details of a subscription item adjustment that will be removed from the subscription item, typically due to the cancellation of a subscription that is a qualifier of that offer.

PendingSubscriptionItemAdjustmentRemoval() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

PERCENT_OFF - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionAdjustmentType

Take a percent off the total amount.

PeriodDefinition - Class in com.broadleafcommerce.subscriptionoperation.domain

Describes subscription billing period, including the start date, end date, & when the customer will be billed.

PeriodDefinition() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

policyMatchesForItem(C, CartItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultCancellationPolicyService

Determines whether the given CancellationPolicy is a match for the given CartItem based on the CancellationPolicy.getPolicyRules().

populateAccountFields(CustomerRef) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProvider

Populates the account-related fields for the given CustomerRef from current authentication context.

populateActionPriceDetails(SubscriptionPriceResponse, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

populateAdditionalSubscriptionDetails(Subscription, CreateSubscriptionFromOrderRequest, OrderItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Hook point to easily populate additional details on the Subscription.

populateAdditionalSubscriptionItemDetails(Subscription, SubscriptionItem, OrderItem, OrderItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Hook point to easily populate additional details on the SubscriptionItem.

populateAdjustmentPriceDetails(SubscriptionItemPriceDetail, CartItem, String, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Populates the SubscriptionItemPriceDetail.getAdjustmentPriceDetailsByAdjustmentRef() based on the current item adjustments from CartItem.getItemAdjustments() and the existing subscription item adjustments from SubscriptionItem.getSubscriptionItemAdjustments().

populateCancelAction(SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

Populates the action details for the DefaultSubscriptionActionType.CANCEL.

populateCancelActionInfo(SubscriptionWithItems, SubscriptionAction, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

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

populateCancellationCharges(SubscriptionItemPriceDetail, String, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Populates the charges related to the cancellation of the subscription.

populateCancellationFeeProducts(SubscriptionWithItems, CancellationPolicyDetail, SubscriptionAction, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

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.

populateCartAttributesOnCreateCartRequest(ModifySubscriptionRequest, CreateCartRequest) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

Stores additional values in CreateCartRequest.getCartAttributes() that would be used in downstream flows.

populateCartAttributesOnCreateCartRequest(ModifySubscriptionRequest, CreateCartRequest) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

Stores additional values in CreateCartRequest.getCartAttributes() that would be used in downstream flows.

populateChangeAutoRenewalAction(SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

Populates the action details for the DefaultSubscriptionActionType.CHANGE_AUTO_RENEWAL.

populateCommonAdjustmentProperties(ExistingAdjustmentDetail, Adjustment, Subscription) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.SubscriptionModificationUtils

populateDefaultProductAndOrVariantId(ItemChoice, AddItemRequest) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

Populates AddItemRequest.getProductId() and, if applicable, AddItemRequest.getVariantId() based on the type of ItemChoice.

populateDowngradeAction(SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

Populates the action details for the DefaultSubscriptionActionType.DOWNGRADE.

populateDowngradeActionInfo(SubscriptionReferencedItem, SubscriptionAction, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

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

populateDueNowDetails(SubscriptionPriceResponse, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

populateEditAction(SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

Populates the action details for the DefaultSubscriptionActionType.EDIT.

populateExistingSubscriptionDetails(CreateCartRequest, SubscriptionWithItems) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.SubscriptionModificationUtils

Populates ExistingSubscriptionDetails onto the CreateCartRequest.

populateFreeTrialDetails(Subscription, OrderItem, CreateSubscriptionFromOrderRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Sets the details for when a free trial offer is applied, such as and Subscription.getFreeTrialEndDate().

populateItemChoiceDetailsToAddItemRequest(AddItemRequest, ItemChoice, Subscription, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.SubscriptionModificationUtils

populatePeriodAndBillDates(EstimatedFuturePayment, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

populatePeriodEndDate(PeriodDefinition, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

populatePeriodInfoOnPriceResponse(SubscriptionPriceResponse, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Populates SubscriptionPriceResponse.getPeriodType() and SubscriptionPriceResponse.getPeriodFrequency().

populatePricingContextFromCancellationPolicy(Cart, CartItem, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Sets the fields related to a CancellationPolicy on the given SubscriptionPricingContext.

populatePricingContextFromCartItem(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Populates contextual pricing information when there is no existing Subscription, e.g., when this is a create flow.

populatePricingContextFromExistingSubscription(SubscriptionPricingContext, SubscriptionWithItems, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

populateProratedAmounts(SubscriptionItemPriceDetail, CartItem, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

populateProratedAmounts(SubscriptionItemPriceDetail, SubscriptionItem, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

populateProratedAmounts(SubscriptionItemPriceDetail, MonetaryAmount, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

populateSubscriptionActionAvailability(String, SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

populateSubscriptionActions(Iterable<SWI>, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

populateSubscriptionActions(SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

populateSubscriptionActions(SWI, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

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

populateSubscriptionRoundBillDateAttribute(Subscription, CreateSubscriptionFromOrderRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Populates the SubscriptionAttributeConstants.Internal.ROUND_UP_BILL_DATES_TO_END_OF_MONTH if the order submission day is not available every month, e.g.

populateTermDetails(Subscription, Order, OrderItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Hook point for populating term-based data on the Subscription from the rootOrderItem.

populateTermDetailsForExistingSubscription(Subscription, List<RemovedAdjustment>, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Populates the term details for an existing Subscription based on the RemovedAdjustments.

populateUpgradeAction(SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

Populates the action details for the DefaultSubscriptionActionType.UPGRADE.

populateUpgradeActionInfo(SubscriptionReferencedItem, SubscriptionAction, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

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

POSTPAID - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionPaymentStrategy

Declares that payments made against a subscription are going towards the goods or services rendered in the previous period.

postProcessEnvironment(ConfigurableEnvironment, SpringApplication) - Method in class com.broadleafcommerce.subscriptionoperation.autoconfigure.SubscriptionOperationEnvironmentPostProcessor

PREPAID - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionPaymentStrategy

Declares that payments made against a subscription are going towards the goods or services rendered in the next period.

PREPAID_DOWNGRADE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultDelayedSubscriptionActionType

A downgrade action that is being delayed due to the subscription being prepaid.

PREPAID_ITEM_REMOVAL - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultDelayedSubscriptionActionType

An item removal action that is being delayed due to the subscription being prepaid.

PREPAID_ITEM_UPDATE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultDelayedSubscriptionActionType

An item update action that is being delayed due to the subscription being prepaid.

PRICE_CHANGE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

A request to change the price of one or more items in the subscription

PRICE_DATA_CHANGE_WORKFLOW - Static variable in class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultWorkflowNameConstants

Workflow used to apply pricing changes to a subscription and engage billing.

PRICE_DATA_ID - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

PRICE_DATA_PRICE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

PRICE_DATA_PRICE_LIST_ID - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

PRICE_DATA_RECURRING_PRICE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

PRICE_DATA_USAGE_PRICE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

PRICE_INFO_PAYMENT_STRATEGY - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

Indicates the DefaultSubscriptionPaymentStrategy associated with the cart item's PriceInfo.

PriceCartRequest - Class in com.broadleafcommerce.subscriptionoperation.web.domain

A DTO used to provide context on a request to price a cart.

PriceCartRequest() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.PriceCartRequest

PriceChangeRequest - Class in com.broadleafcommerce.subscriptionoperation.domain.pricing

A DTO to represent changeable price fields and other price data info.

PriceChangeRequest() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

PriceChangeRequest(String, String, MonetaryAmount, MonetaryAmount, MonetaryAmount, String, Instant, String, List<String>, List<String>, Map<String, Object>) - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

Creates a new PriceChangeRequest instance.

PriceDataApplicationDateType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.pricing.type

Enumerates the types of dates that dictate when a PriceChangeRequest is applied.

PriceDataAppliesToType - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.pricing.type

Enumerates the types of users a PriceChangeRequest applies to.

PriceDataChange - Class in com.broadleafcommerce.subscriptionoperation.domain

Structure representing a change to the pricing of the subscription.

PriceDataChange() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

PriceDataChange(String, String, BigDecimal, BigDecimal, String, Map<String, Object>) - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

Creates a new PriceDataChange instance.

PriceDataChangeRequest - Class in com.broadleafcommerce.subscriptionoperation.domain

Represents a request to change the price data for a batch of subscriptions.

PriceDataChangeRequest() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChangeRequest

PriceDataChangeRequest(PriceDataChange, Map<String, Set<String>>) - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChangeRequest

priceSubscription(SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

priceSubscriptions(Cart, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

priceSubscriptions(Cart, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionPricingService

Prices the cart's subscription items, returning SubscriptionPriceResponses describing how much the customer should be charged now, & estimations for how much & when they'll be charged in the future as part of subscription billing.

priceSubscriptions(Cart, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionPricingEndpoint

PRIOR_UNBILLED_UNIT_AMOUNT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

Prior to an edit, upgrade, or downgrade on a subscription that’s using a Postpaid payment strategy, the system will have prior unbilled charges that will be part of the next invoice.

PRIOR_UNBILLED_UNIT_DISCOUNT_AMOUNT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

The subscription item discount per unit to be deducted from the DefaultSubscriptionPriceDetailType.PRIOR_UNBILLED_UNIT_AMOUNT.

process(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.status.SubscriptionStatusHandler

Processes the Subscription status change if it is valid.

processPricingWorkflows(BulkPriceUpdateSubscriptionRequest, ContextInfo, Set<SubscriptionOwnerInfo>, Set<String>) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Launch a price change workflow for each subscription updated with a price change record.

Product - Class in com.broadleafcommerce.subscriptionoperation.domain

The product containing the details related to subscriptions.

Product() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.Product

PRODUCT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSpecificItemChoiceType

ProductOption - Class in com.broadleafcommerce.subscriptionoperation.domain

A "product option" encapsulates additional, variable information about a Product explicitly designed for customer-facing input.

ProductOption() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

PRORATED - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultCancellationChargeStrategy

Customer is charged for portion of the billing period that they have had access to the subscription.

PRORATED_UNIT_AMOUNT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

The subscription item price per unit, prorated relative to the next invoice date.

PRORATED_UNIT_DISCOUNT_AMOUNT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

The subscription item discount per unit, prorated relative to the next invoice date.

ProviderApiException - Exception in com.broadleafcommerce.subscriptionoperation.exception

Defines a generic error that can be thrown in response to receiving an error from an API that one of the providers (e.g., SubscriptionProvider) received.

ProviderApiException(String, Throwable, WebClientResponseException) - Constructor for exception com.broadleafcommerce.subscriptionoperation.exception.ProviderApiException

ProviderApiException(String, WebClientResponseException) - Constructor for exception com.broadleafcommerce.subscriptionoperation.exception.ProviderApiException

ProviderApiException(Throwable, WebClientResponseException) - Constructor for exception com.broadleafcommerce.subscriptionoperation.exception.ProviderApiException

ProviderApiException(WebClientResponseException) - Constructor for exception com.broadleafcommerce.subscriptionoperation.exception.ProviderApiException

Q

QUARTERLY - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionPeriodType

R

readAccountsBySegments(Set<String>, Set<String>, Set<String>, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.CustomerProvider

Group the requested account ids by the requested segments that match those accounts.

readAccountsBySegments(Set<String>, Set<String>, Set<String>, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProvider

readAccountSubscription(String, String, boolean, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.AccountSubscriptionOperationEndpoint

readAccountSubscriptionActions(String, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.AccountSubscriptionOperationEndpoint

readAll(Node, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.CancellationPolicyProvider

Reads all CancellationPolicies based on the provided filters and paging.

readAll(Node, Pageable, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProvider

readAllAccountSubscriptions(String, boolean, Pageable, Node, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.AccountSubscriptionOperationEndpoint

readAllByIds(Set<String>, Pageable, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProvider

readAllByIds(Set<String>, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.OrderProvider

Retrieve all Orders with the specified ids.

readAllCancellationPolicies(Cart, Collection<T>, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Reads all CancellationPolicies for the given CartItems representing root SubscriptionItems in a cancellation flow (DefaultSubscriptionActionFlow.CANCEL or DefaultSubscriptionActionFlow.TERMINATE).

readAllCustomerSubscriptions(String, boolean, Pageable, Node, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.CustomerSubscriptionOperationEndpoint

readAllSubscriptionOwnerInfosByPriceData(String, Set<String>, Pageable, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

readAllSubscriptionOwnerInfosByPriceData(String, Set<String>, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Find all SubscriptionOwnerInfo by priceDataId.

readAllSubscriptionsByIds(Collection<String>, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

readAllSubscriptionsByIds(Collection<String>, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Retrieves a list of subscriptions with items for the given ids

readAllSubscriptionsByUserRefAndStatuses(String, String, Collection<String>, Pageable, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

readAllSubscriptionsByUserRefAndStatuses(String, String, Collection<String>, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Find all subscriptions by userRef and statuses.

readAllUserOwnedSubscriptions(String, String, boolean, Pageable, Node, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

readById(String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProvider

readById(String, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.CancellationPolicyProvider

Reads a CancellationPolicy by its id.

readCancellationPolicyById(String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultCancellationPolicyService

readCancellationPolicyById(String, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.CancellationPolicyService

Reads a CancellationPolicy by its id.

readCustomerSubscription(String, String, boolean, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.CustomerSubscriptionOperationEndpoint

readCustomerSubscriptionActions(String, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.CustomerSubscriptionOperationEndpoint

readNewItemReferenced(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

Retrieves the new item to upgrade/downgrade to.

readNewSubscriptionItemOfCustomType(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractGradeChangeSubscriptionModificationHandler

Hookpoint for custom item ref types.

readProductById(String, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.CatalogProvider

Retrieves the Product based on the given id.

readProductById(String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProvider

readProductsByIds(Collection<String>, Pageable, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProvider

readProductsByIds(Collection<String>, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.CatalogProvider

Retrieves Products based on the given ids.

readSubscription(String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

readSubscription(String, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Retrieves a subscription for a given id.

readSubscriptionActions(SubscriptionActionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

readSubscriptionActions(SubscriptionActionRequest, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

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

readSubscriptionById(String, boolean, boolean, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

readSubscriptionById(String, boolean, boolean, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

readSubscriptionById(String, boolean, boolean, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Retrieves a subscription with items for a given id

readSubscriptionById(String, boolean, boolean, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

This method reads a subscription for the given id

readSubscriptionById(String, boolean, boolean, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

readSubscriptionById(String, boolean, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Retrieves a subscription with items for a given id

readSubscriptionById(String, boolean, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

This method reads a subscription for the given id

readSubscriptionById(String, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Retrieves a subscription with items for a given id

readSubscriptionById(String, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

This method reads a subscription for the given id

readSubscriptionOrderHistory(String, Pageable, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOrderHistoryService

readSubscriptionOrderHistory(String, Pageable, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOrderHistoryService

Reads the Orders related to the specified subscription ID.

readSubscriptionOrderHistory(String, Pageable, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOrderHistoryEndpoint

readSubscriptionsForUserRefTypeAndUserRef(String, String, boolean, Pageable, Node, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

readSubscriptionsForUserRefTypeAndUserRef(String, String, Pageable, Node, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

readSubscriptionsForUserRefTypeAndUserRef(String, String, boolean, Pageable, Node, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

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

readSubscriptionsForUserRefTypeAndUserRef(String, String, Pageable, Node, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Retrieves a page of subscriptions with items for a given user type and user id, taking into account the provided filters and paging

readUserSubscriptionById(String, String, String, boolean, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

readUserSubscriptionById(String, String, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

readUserSubscriptionById(String, String, String, boolean, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

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

readUserSubscriptionById(String, String, String, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Retrieves a user-owned subscription with items for a given id

readUserSubscriptionSummary(String, String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

REDEMPTION_CODE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionSourceType

Indicates that the subscription source for a subscription is a redemption code.

REJECTED - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.LockState

The attempt to lock the resource was rejected

REMAINDER_OF_TERMS_UNIT_AMOUNT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

The unit amount to charge for the remainder of terms if the remainder of terms is being charged.

REMAINDER_OF_TERMS_UNIT_DISCOUNT_AMOUNT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

The unit discount amount to be applied to the remainder of terms charge if the remainder of terms is being charged.

remainingReservations(int) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus.LockStatusBuilder

The quantity of reservations remaining for the lock

RemovedAdjustment - Class in com.broadleafcommerce.subscriptionoperation.domain

Represents an Adjustment that will be lost given proposed changes to a current Subscription.

RemovedAdjustment() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

REPLACE_EXISTING - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants.AddAdjustmentWorkflow

replaceSubscription(S, boolean, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

replaceSubscription(S, boolean, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Replaces a subscription.

replaceSubscription(S, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Replaces a subscription.

replaceSubscriptionWithItems(String, boolean, SubscriptionWithItems, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

replaceSubscriptionWithItems(SWI, boolean, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

replaceSubscriptionWithItems(SWI, boolean, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

replaceSubscriptionWithItems(SWI, boolean, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Replaces a subscription and its items.

replaceSubscriptionWithItems(SWI, boolean, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

Handles updating the Subscription's status.

replaceSubscriptionWithItems(SWI, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Replaces a subscription and its items.

REQUIRES_DIRECT_REFERENCE - Static variable in class com.broadleafcommerce.subscriptionoperation.service.DefaultCancellationPolicyService

reservationTokens(Stack<String>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus.LockStatusBuilder

The tokens associated with each of the optional child locks.

resolvePageable(JsonNode) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.page.ResponsePageGenerator

Generates an appropriate pageable based off of the pageable data received.

ResponsePageGenerator<T> - Class in com.broadleafcommerce.subscriptionoperation.service.provider.page

Generates a Page representing the data and page data received as a response from another service.

ResponsePageGenerator(List<T>, Long, JsonNode) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.provider.page.ResponsePageGenerator

ROOT_ORDER_ITEM_IDS - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionAttributeConstants.Internal

The collection of the root OrderItem IDs related to the subscription.

ROUND_UP_BILL_DATES_TO_END_OF_MONTH - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionAttributeConstants.Internal

Determines whether the bill dates (e.g.

roundUpToTheEndOfMonth(Instant, String) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

Rounds the given Instant to the end of the month.

RouteConstants - Class in com.broadleafcommerce.subscriptionoperation.provider.jpa.environment

RouteConstants.Persistence - Class in com.broadleafcommerce.subscriptionoperation.provider.jpa.environment

RSQL_FILTER_PARAM - Static variable in class com.broadleafcommerce.subscriptionoperation.service.provider.external.AbstractExternalProvider

RSQL_FILTER_PARAM - Static variable in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProvider

S

SANDBOX_AWARE_HEADER - Static variable in class com.broadleafcommerce.subscriptionoperation.service.provider.external.AbstractExternalProvider

SANDBOX_IGNORE_DELETE_FILTERING_HEADER - Static variable in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

SEGMENTS - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultPriceChangeScopeType

Accounts identified by requested CustomerSegments

setAccounts(Set<String>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

The filtered set of accounts that are valid based on the inclusion and exclusion segments.

setAction(SubscriptionAction) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The action to be performed on the specified Subscription.

setActionEffectiveType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The descriptor of when the price change should take effect.

setActionFlow(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The original action flow that led to the creation of this delayed action.

setActionInfo(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAction

A map that may contain additional information about the action.

setActionPriceDetails(List<SubscriptionActionPriceDetail>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

A collection of SubscriptionActionPriceDetail objects describing the price before & after the action for each item.

setActionType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The type of delayed action that is to be performed.

setActionType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAction

The type of action.

setActiveEndDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

When this Variant should no longer be active.

setActiveStartDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

When this Variant should start to become active.

setActiveSubscriptions(List<ExistingSubscriptionDetails>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.UserSubscriptionSummary

ExistingSubscriptionDetails of the active subscriptions purchased by the user.

setActiveSubscriptionStatuses(List<String>) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationServiceProperties

List of subscription statuses that are considered as active subscription statuses.

setAddItemRequests(List<AddItemRequest>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

The initial AddItemRequests to populate the cart.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Category

Map holding any additional attributes passed in the request not matching any defined properties.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Map holding any additional attributes passed in the request not matching any defined properties.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

Miscellaneous attributes that can be set on this item.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

Map holding any additional attributes passed in the request not matching any defined properties.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

Map holding any additional attributes passed in the request not matching any defined properties.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Miscellaneous attributes that can be set to this request in order to inform business logic

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Miscellaneous attributes that can be added to the response in order to provide more information.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Miscellaneous attributes that can be added to the context in order to provide more information.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

Map holding any additional attributes passed in the request not matching any defined properties.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

Miscellaneous attributes that can be set to this request in order to inform business logic for adding a CartItem.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateSubscriptionFromOrderRequest

Miscellaneous attributes that can be set to this request in order to inform business logic for adding a Subscription.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyRequest

Miscellaneous attributes that can be added to the response in order to provide more information.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyResponse

Miscellaneous attributes that can be added to the response in order to provide more information.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Miscellaneous attributes that can be set to this request in order to inform business logic

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Miscellaneous attributes that can be set to this request in order to inform business logic for adding a Subscription.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Miscellaneous attributes that can be set to this request in order to inform business logic for adding a SubscriptionItem.

setAdditionalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.UpdateSubscriptionStatusRequest

Miscellaneous attributes that can be set to this request to inform business logic

setAdditionalAttributes(Map<String, String>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

Additional information about the lock

setAdditionalFields(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

setAdditionalFields(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

setAdditionalProperties(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

Any additional information related to the price change.

setAddOnKey(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

setAddOnKey(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

If this item was the result of an add-on, then this stores the key of the add-on in the context of its parent.

setAddOnKey(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

If this item was the result of an add-on, then this stores the key of the add-on in the context of its parent.

setAdjustmentAmount(BigDecimal) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The amount of the adjustment that will be removed.

setAdjustmentAmount(BigDecimal) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setAdjustmentAmount(BigDecimal) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setAdjustmentAmountTotal(BigDecimal) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

Cumulative total of all instances of an Adjustment.

setAdjustmentCartLabel(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The cart label of the adjustment that will be removed.

setAdjustmentCartLabel(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

setAdjustmentCartLabel(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setAdjustmentCartLabel(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setAdjustmentCodeRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

setAdjustmentCodeRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setAdjustmentCodeRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setAdjustmentCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The currency of the adjustment that will be removed.

setAdjustmentDescription(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The description of the adjustment that will be removed.

setAdjustmentDescription(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

setAdjustmentDescription(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setAdjustmentDescription(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setAdjustmentDiscountFactor(BigDecimal) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setAdjustmentDiscountFactor(BigDecimal) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setAdjustmentDiscountMethodType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setAdjustmentDiscountMethodType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setAdjustmentName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

setAdjustmentName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The name of the adjustment that will be removed.

setAdjustmentName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

setAdjustmentName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setAdjustmentName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setAdjustmentPriceDetailsByAdjustmentRef(Map<String, SubscriptionItemAdjustmentPriceDetail>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The map of SubscriptionItemAdjustmentPriceDetail by adjustment reference, containing the details about how the discount affects the prorated unit amount, credited amount, and prior unbilled amount.

setAdjustmentProrationType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

setAdjustmentProrationType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setAdjustmentProrationType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setAdjustmentQuantity(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The quantity of the item impacted by the adjustment after the subscription modification.

setAdjustmentRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

setAdjustmentRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The reference of the adjustment that will be removed.

setAdjustmentRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

setAdjustmentRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setAdjustmentRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setAdjustmentRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

setAdjustmentUnitAmount(BigDecimal) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

The unit discount of an Adjustment.

setAfterRecurringPrice(BigDecimal) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

setAfterRecurringPrice(BigDecimal) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

The PriceData recurringPrice after the price change.

setAllowAddAfterInitialPurchase(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Whether the customer is allowed to add an optional item after initial purchase.

setAllowAutoRenewalModification(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

This flag indicates whether this subscription's auto-renewability can be modified after declaration on the subscription.

setAllowCancellation(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

Whether the customer can cancel their service before the end of the agreement.

setAllowChangingBillingFrequency(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

Whether the billing frequency can be changed after initial purchase.

setAllowedActionsBySubscriptionStatus(Map<String, List<String>>) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationServiceProperties

List of allowed subscription actions for each subscription status.

setAllowEditAfterInitialPurchase(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Whether edit is allowed after initial purchase.

setAllowQtyEditAfterInitialPurchase(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Whether quantity can be edited after initial purchase.

setAllowQtyEditAfterInitialPurchase(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

Whether quantity can be edited after initial purchase.

setAllowRemoveAfterInitialPurchase(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Whether the customer is allowed to remove an optional item after initial purchase.

setAlternateUserRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Alternate reference to the user.

setAlternateUserRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Alternate reference to the user.

setAlternateUserRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Type of the alternative user reference

setAlternateUserRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Type of the alternative user reference

setAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

Amount due on the payment schedule date.

setAmountDueNow(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Amount due today, which is typically captured immediately.

setApplicableForThisPeriod(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Whether this adjustment is applicable for the period that this detail is built for.

setApplicablePeriod(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The period number on which the delayed action is due.

setApplicationDateType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

Indicates when the adjustment should be applied onto the subscription.

setApplicationDateType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

Indicates when the price data should be applied onto the subscription.

setApplicationId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

The application associated with the subscription

setAppliesTo(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

Whether the Price Data applies to all customers or identifies users to via customer segments.

setApplyToDependentItems(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

Indicates whether the Offer should also be applied to the dependent items.

setArchived(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Whether this item is archived

setArchiveReason(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Why this item was archived

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The additional attributes.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

The additional attributes.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

Any additional attributes used to describe the delayed action

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

Additional attributes to include.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

Additional attributes to include.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

Additional attributes to include.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Miscellaneous attributes for this tag.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

Additional, miscellaneous attributes.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

Map holding any additional attributes passed in the request not matching any defined properties.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

Miscellaneous attributes for this tag.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

Additional information to include with this removal DTO.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Miscellaneous attributes for this subscription.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

Miscellaneous attributes for this subscription item adjustment.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Map holding any additional attributes passed in the request not matching any defined properties.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Map holding any additional attributes passed in the request not matching any defined properties.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

Any additional attributes used to describe the period

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Map holding any additional attributes passed in the request not matching any defined properties.

setAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.UserSubscriptionSummary

Additional attributes to include.

setAuthorizationFailureHandler(OAuth2AuthorizationFailureHandler) - Method in class com.broadleafcommerce.subscriptionoperation.oauth2.client.web.SynchronizedDelegatingOAuth2AuthorizedClientManager

Deprecated.

setAuthorizationSuccessHandler(OAuth2AuthorizationSuccessHandler) - Method in class com.broadleafcommerce.subscriptionoperation.oauth2.client.web.SynchronizedDelegatingOAuth2AuthorizedClientManager

Deprecated.

setAuthorizedClientProvider(OAuth2AuthorizedClientProvider) - Method in class com.broadleafcommerce.subscriptionoperation.oauth2.client.web.SynchronizedDelegatingOAuth2AuthorizedClientManager

Deprecated.

setAutoRenewalEnabled(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Whether this subscription automatically renews at the end of the current subscription term.

setAutoRenewalEnabled(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The value to change Subscription.isAutoRenewalEnabled() to.

setAutoRenewalEnabled(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Whether this subscription automatically renews at the end of the current subscription term.

setAvailableActions(List<SubscriptionAction>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

The available SubscriptionActions that may be possible for this subscription.

setAvailableActions(List<SubscriptionAction>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionResponse

The available SubscriptionActions that may be possible for this subscription.

setBeforeRecurringPrice(BigDecimal) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

setBeforeRecurringPrice(BigDecimal) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

The PriceData recurringPrice before the price change.

setBeginPeriod(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

setBeginPeriod(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

setBeginPeriod(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setBeginPeriod(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setBillDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

The date on which the customer is expected to be billed.

setBillDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

The date on which the customer is expected to be billed.

setBillDate(Date) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

The bill date of the period

setBillingFrequency(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Deprecated.

in favor of Subscription.periodType & Subscription.periodFrequency

setBillingFrequency(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Deprecated.

in favor of SubscriptionCreationRequest.periodType & SubscriptionCreationRequest.periodFrequency

setBulkUpdateBatchSize(int) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionPricingProperties

The batch size to use when performing bulk pricing updates for subscriptions.

setCampaignTrackingId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

setCampaignTrackingId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setCampaignTrackingId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setCancellationFeeProductId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

The product id that holds the cancellation fee.

setCancellationPoliciesPath(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProviderProperties

The base uri path to the cancellation policy endpoint

setCancellationPolicy(CancellationPolicy) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The full CancellationPolicy for the SubscriptionPricingContext.subscriptionRootItem if any.

setCancellationPolicy(CancellationPolicy) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

Describes details for access & charges in the current period in which the cancellation of this subscription is being requested/executed.

setCancellationPolicy(CancellationPolicy) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Describes details for access & charges in the current period in which the cancellation of this subscription is being requested/executed.

setCancellationPolicyDetail(CancellationPolicyDetail) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The relevant CancellationPolicyDetail for the SubscriptionPricingContext.paymentStrategy from the SubscriptionPricingContext.cancellationPolicy.

setCancellationPolicyDetail(CancellationPolicyDetail) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Describes details of the applicable cancellation policy for this subscription.

setCancellationPolicyRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

A reference of the CancellationPolicy that governs how this subscription would be cancelled.

setCancellationStrategy(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

The strategy to use when cancelling a subscription, e.g.

setCandidateAccounts(Set<String>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

The set of requested candidate accounts that were filtered.

setCart(Cart) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The Cart containing subscriptions.

setCart(Cart) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionResponse

setCartAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

Attributes that should be copied to the Cart.getAttributes() for this request.

setCartAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

Miscellaneous attributes that should be copied to Cart.getAttributes()

setCartInternalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

Miscellaneous internal attributes for this item.

setCartItemId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

Reference to the subscription CartItem.

setCartItemId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Reference to the subscription CartItem.

setCartItems(List<CartItem>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyRequest

The cart items to identify the cancellation policies for.

setCartUri(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProviderProperties

The URI to endpoints managing a specific cart.

setCategory(Category) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The Category which the choice will be chosen from by the customer if the ItemChoice.targetType is DefaultItemChoiceTargetType.CATEGORY.

setChargeback(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Whether this subscription is being cancelled due to a chargeback

setChargeForPreviouslyReceivedDiscountAmounts(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

Whether the customer would be charged for any discounts he/she received before cancelling the subscription.

setChargeForRemainderOfTerms(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

Whether the customer would be charged for the remainder of the term despite cancelling the subscription.

setChargeFullPriceForRemainderOfTerms(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

Whether the customer would be charged the full price for the remainder of the term despite cancelling the subscription.

setChargeStrategy(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

The strategy to use when charging a customer for cancelling a subscription, e.g.

setChildLock(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

Whether the lock is a child lock

setChoiceKey(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The key used during the validation of cart item's configuration to relate this ItemChoice to one of the cart item's dependent items.

setCodeUsed(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

setCodeUsed(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setCodeUsed(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setContextAttributesMapper(Function<OAuth2AuthorizeRequest, Map<String, Object>>) - Method in class com.broadleafcommerce.subscriptionoperation.oauth2.client.web.SynchronizedDelegatingOAuth2AuthorizedClientManager

Deprecated.

setContextState(EmbeddedContextState) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

A subset of Tracking information to expose the context state for this object.

setContextState(ContextState) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

A subset of Tracking information to expose the context state for this object.

setContextState(ContextState) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

A subset of Tracking information to expose the context state for this object.

setContextState(ContextState) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

A subset of Tracking information to expose the context state for this object.

setContextState(ContextState) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

A subset of Tracking information to expose the context state for this object.

setContextState(ContextState) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

A subset of Tracking information to expose the context state for this object.

setContextState(ContextState) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

A subset of Tracking information to expose the context state for this object.

setContextState(ContextState) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

A subset of Tracking information to expose the context state for this object.

setCost(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Can be used in display or as apart of more complex pricing algorithms

setCreated(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

The time the lock was created

setCreatedDate(Date) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Date this subscription was created.

setCreditedAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

For edits, upgrades, and downgrades, the system has partial credits to the prorated amount that the customer already paid.

setCreditedAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

For edits, upgrades, and downgrades on a subscription that’s using an DefaultSubscriptionPaymentStrategy.PREPAID payment strategy, the customer has already paid the full amount for this billing cycle at the previous rate.

setCreditedUnitAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

For edits, upgrades, and downgrades on a subscription that’s using an DefaultSubscriptionPaymentStrategy.PREPAID payment strategy, the customer has already paid the full amount for this billing cycle at the previous rate.

setCreditedUnitDiscountAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The subscription item discount per unit to be deducted from the SubscriptionItemPriceDetail.getCreditedUnitAmount().

setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

Currency for all of the prices on this product

setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Currency of this subscription

setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Currency of this subscription

setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Currency of this subscription

setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The CurrencyUnit of the item to be added to the Cart.

setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.PriceCartRequest

The currency to price the cart against.

setCurrency(CurrencyUnit) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Currency of this subscription

setCurrencyCode(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

setCurrencyConversionDetail(CurrencyConversionDetail) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

Represents the details of the exchange rate used to convert a MonetaryAmount from one currency to another.

setCurrencyConversionDetail(CurrencyConversionDetail) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Represents the details of the exchange rate used to convert a MonetaryAmount from one currency to another.

setCurrentPeriod(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

The subscription's current period

setCustomersUri(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProviderProperties

The base uri path to the customer endpoint

setCustomerTimezone(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The customer's timezone.

setCustomerTimezone(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The customer's timezone.

setCustomerTimezone(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

The customer's timezone, which gets stored in Cart.getInternalAttributes() to be used by downstream services.

setDatasource(Object) - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationJpaProperties

setDefaultPrice(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

The default price that should be used if there is not a Variant.salePrice set.

setDefaultProduct(Product) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The default product that can be used when driving customer selections if the ItemChoice.targetType is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS.

setDefaultProductInCategory(Product) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The default product that can be used when driving customer selections if the ItemChoice.targetType is DefaultItemChoiceTargetType.CATEGORY.

setDefaultVariant(Variant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The default variant that can be used when driving customer selections if the ItemChoice.targetType is DefaultItemChoiceTargetType.SPECIFIC_VARIANTS.

setDelayedActions(List<DelayedSubscriptionAction>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

List of delayed actions for this subscription.

setDelayedActions(List<DelayedSubscriptionAction>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

List of delayed actions for this subscription.

setDelegating(SchemaDelegatingProperties) - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationJpaProperties

setDependentCartItems(List<AddItemRequest>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

A list of additional AddItemRequests that should be processed as dependent items of the resulting parent item of this current AddItemRequest.

setDescription(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The description of the policy.

setDescription(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Description of the Variant that can include HTML in implementations where a WYSIWYG editor manages this field.

setDisabled(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SSLVerificationProperties

Deprecated.

Dictates whether SSL verification should be disabled.

setDiscountable(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

Whether this non-catalog item can receive discounts.

setDiscountable(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Whether or not this variant can participate in offers or promotions

setDiscountAllowed(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Dictates whether or not discounts are allowed to be applied to this choice.

setDiscountAllowed(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

Dictates whether or not discounts are allowed to be applied to this add-on.

setDiscountAllowedForCancellationCharge(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionCancellationProperties

Whether a discount amount can be applied to the cancellation charge.

setDiscountType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

setDiscountType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

setDiscountType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setDiscountType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setDisplayOrder(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

The ordering of this option in relation to other options on the page.

setDowngradeProductIds(List<String>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

The list of ids of the product that this product can downgrade to.

setDueNowItemDetails(List<SubscriptionItemPriceDetail>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

A list of SubscriptionPriceItemDetails describing the individual item prices that contributed to the overall SubscriptionPriceResponse.getAmountDueNow().

setDueNowQuantityOverride(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

An item's quantity override value used for "due now" price calculations where the item's quantity decreased due to the subscription action.

setEndOfTermDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The end of term date for this subscription.

setEndOfTermDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The date at which the subscription's terms will expire.

setEndOfTermDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

The end of term date for this subscription.

setEndPeriod(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

setEndPeriod(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

setEndPeriod(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setEndPeriod(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setEstimatedFuturePayments(List<EstimatedFuturePayment>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

A collection of EstimatedFuturePayment objects describing the timing & amount of future subscription payments.

setExceptionHandlerUtils(ExceptionHandlerUtils) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.exception.SubscriptionOperationExceptionAdvisor

setExcludedSegments(List<String>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

List of excluded customer segments — overrides the PriceChangeRequest.appliesTo and PriceChangeRequest.includedSegments values to exclude users based on these customer segments.

setExcludedSegments(Set<String>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

The segments that identify the accounts whose subscriptions should be excluded from those identified by BulkPriceUpdateSubscriptionRequest.includedSegments.

setExcludeSegmentIds(Set<String>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

The set of accounts that were excluded from the final result.

setExistingAdjustmentDetails(List<ExistingSubscriptionAdjustmentDetail>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

setExistingFullSubscriptionPeriodUnitDiscountAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The existing, un-prorated unit discount amount prior to the subscription modification.

setExistingItemAdjustmentDetails(List<ExistingSubscriptionItemAdjustmentDetail>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

setExistingItemAdjustmentQuantity(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The quantity of the item impacted by the adjustment prior to the subscription modification.

setExistingItemDetails(List<ExistingSubscriptionItemDetail>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

ExistingSubscriptionItemDetail for each SubscriptionItem on the existing Subscription.

setExistingProratedUnitAmountBetweenActionAndNextBillDate(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Similar to SubscriptionItemPriceDetail.getProratedUnitAmountBetweenActionAndNextBillDate(), this is the SubscriptionItemAdjustmentPriceDetail.existingFullSubscriptionPeriodUnitDiscountAmount prorated for the period between the action date and the next bill date and the regardless of the subscription action being taken or the payment strategy.

setExistingProratedUnitAmountBetweenPeriodStartAndActionDate(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Similar to SubscriptionItemPriceDetail.getProratedUnitAmountBetweenPeriodStartAndActionDate(), this is the SubscriptionItemAdjustmentPriceDetail.existingFullSubscriptionPeriodUnitDiscountAmount prorated for the period between the period start date and the action date and the regardless of the subscription action being taken or the payment strategy.

setExistingSubscription(Subscription) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The existing Subscription if any.

setExistingSubscriptionItemById(Map<String, SubscriptionItem>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The existing Subscription if any.

setExistingSubscriptionItemId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The existing subscription item's id prior the subscription action (e.g.

setExistingSubscriptionItemQuantities(Map<String, Integer>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Map of SubscriptionItem.getId() to the existing SubscriptionItem's quantity.

setExistingSubscriptionItemQuantity(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The existing subscription item's quantity prior the subscription action (e.g.

setExistingSubscriptionItemUnitPrice(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The existing subscription item's unit price prior the subscription action (e.g.

setExistingSubscriptionItemUnitPrices(Map<String, MonetaryAmount>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Map of SubscriptionItem.getId() to the existing SubscriptionItem's unit price.

setExpirationDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

DefaultCartTypes.QUOTE carts can have an expiration date.

setExpires(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

The time the lock will expire

setExternalId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

This is an arbitrary ID, typically assigned by or used by 1st or 3rd party systems that are not Broadleaf.

setFlow(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Describes the subscription action flow that is being executed.

setFlow(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Describes the subscription action flow that is being executed.

setFormerSubscriptions(List<ExistingSubscriptionDetails>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.UserSubscriptionSummary

ExistingSubscriptionDetails of the former subscriptions purchased by the user.

setFormerSubscriptionStatuses(List<String>) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationServiceProperties

List of subscription statuses that are considered as former subscription statuses.

setFreeTrial(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

Whether this period represents a free trial period.

setFreeTrialEndDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

The end date of the free trial for this subscription, if applicable, null if none applied.

setFreeTrialEndDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The end date of the free trial for this subscription, if applicable, null if none applied.

setFreeTrialLength(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

setFreeTrialLength(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setFreeTrialLength(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setFreeTrialLengthUnits(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

setFreeTrialLengthUnits(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setFreeTrialLengthUnits(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setFulfillments(List<OrderFulfillment>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateSubscriptionFromOrderRequest

The Fulfillments created for the CreateSubscriptionFromOrderRequest.order.

setFulfillmentWorkflow(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

A reference to the workflow used to fulfill the creation of, & modifications to, this subscription.

setFullSubscriptionPeriodUnitAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The unit price of the item (price of one) for the length of a full subscription period.

setFullSubscriptionPeriodUnitDiscountAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The unit adjustment amount for this event item for the length of a full subscription period.

setGracePeriodCancellationFeeProductId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

The product id that holds the cancellation fee for the grace period.

setGracePeriodCancellationStrategy(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

The cancellation strategy to use during the grace period.

setGracePeriodChargeStrategy(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

The charge strategy to use during the grace period.

setGracePeriodDurationInDays(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

Duration of the initial grace period in days.

setGracePeriodRecursEachBillingPeriod(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

Whether the grace period repeats after each billing period.

setGracePeriodSupported(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

Whether grace period properties are enabled.

setHasPostPurchaseEditRules(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Whether this has post purchase edit rules.

setHttpServletRequest(HttpServletRequest) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProvider

setId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The id of the policy.

setId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

setId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

An identifying label for this change.

setId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

setId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

The id of the product.

setId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

setId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

setId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

setId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

The unique identifier for this variant.

setImmediateCancellation(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Should this subscription be cancelled immediately?

setIncludedSegments(List<String>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

List of included customer segments.

setIncludedSegments(Set<String>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

The segments that identify the accounts whose subscriptions should be updated.

setIncludeSegmentIds(Set<String>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

The set of accounts that were included in the final result.

setInternalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Miscellaneous internal attributes for this subscription.

setInternalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Miscellaneous internal attributes for this subscription item.

setInventoryCheckStrategy(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Describes when the variant's inventory should be checked for availability.

setInventoryReservationStrategy(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Describes when the variant's inventory should be reserved.

setItemAdjustmentQuantity(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

If it's an item adjustment, it represents the quantity this adjustment applies to.

setItemAdjustmentQuantity(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

The quantity of the SubscriptionItem the adjustment applies to.

setItemAttributeChoices(Map<String, String>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

Attribute choices that should be copied to CartItem.getAttributeChoices() for this request.

setItemAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

Miscellaneous attributes that should be copied to the CartItem.getAttributes() for this request.

setItemChoice(ItemChoice) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

Configuration for the DefaultProductOptionType.ITEM_CHOICE.

setItemChoiceByChoiceKey(Map<String, ItemChoice>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Mapping of add-on choice keys to add-ons.

setItemChoiceKey(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

If this AddItemRequest is one within AddItemRequest.getDependentCartItems(), this is the key to use to relate to this CartItem to a configured product item choice.

setItemCreationRequests(List<SubscriptionItemCreationRequest>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

setItemDetails(List<SubscriptionItemPriceDetail>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

A list of SubscriptionPriceItemDetails describing the individual item prices that contributed to the overall EstimatedFuturePayment.getAmount().

setItemDetails(Map<String, String>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Additional details about the item

setItemInternalAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

Miscellaneous internal attributes that should be copied to the CartItem.getInternalAttributes() for this request.

setItemName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

The name of the non-catalog-item.

setItemName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

Name of the item identified by SubscriptionActionPriceDetail.getItemRefType() & SubscriptionActionPriceDetail.getItemRef().

setItemName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Item name

setItemName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Name of the item identified by SubscriptionItemPriceDetail.getItemRefType() & SubscriptionItemPriceDetail.getItemRef().

setItemName(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Item name

setItemQuantity(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

setItemRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

setItemRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

Reference to the id of the item represented by this object.

setItemRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Reference to the id of the item represented by this object.

setItemRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Reference to the id of the item represented by this object.

setItemRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Reference to the item ID

setItemRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

setItemRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

Type of item that this object represents.

setItemRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Type of item that this object represents.

setItemRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Type of item that this object represents.

setItemRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Type of item that this object represents

setItemSku(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

setItemSku(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

SKU of the item represented by this object.

setItemSourceRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

This field shows the identifier of the process or user action this subscription item originated.

setItemSourceType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

This field shows from which process or user action this subscription item originated.

setItemType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The type of this item (e.g.

setItemUnitPrice(BigDecimal) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Unit price of the item (price of a single unit)

setItemUnitPrice(BigDecimal) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Unit price of the item (price of a single unit)

setJpa(JpaProperties) - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationJpaProperties

setLabel(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

The label shown to customers when displaying this option.

setLastBillingBatchId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The batch id of the last billing job run for this subscription

setLastBillingOperationStatus(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The most current status of the last billing event for this subscription

setLastBillingSuccessDate(Date) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Last date this that the Billing Job succeeded billing this subscription

setLiquibase(Object) - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationJpaProperties

setLocale(Locale) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.PriceCartRequest

The locale to price the cart against.

setLockId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

The ID of the lock

setLocksPath(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

setManageCartsUri(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProviderProperties

The base uri path to the manage cart endpoint.

setMapper(ObjectMapper) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.exception.SubscriptionOperationExceptionAdvisor

setMaximumQuantity(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The maximum amount of this item that a customer can purchase at a time.

setMaximumThreshold(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

The maximum count of this product that must be added in a cart.

setMaximumThreshold(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

The maximum count of this variant can be added in a cart.

setMaxNumberOfActiveSubscriptions(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

The max number of active subscriptions that can be created for this product.

setMerchandisingContext(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The value that should be mapped to CartItem.getMerchandisingContext().

setMinimumQuantity(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The minimum amount of the item that a customer must purchase.

setMinimumThreshold(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

The minimum count of this product that must be added in a cart.

setMinimumThreshold(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

The minimum count of this variant that must be added in a cart.

setName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The name of the policy.

setName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

Name of this product.

setName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Name of this subscription

setName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

The name of this particular variant of the product.

setName(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

Allows optionally setting a cart name.

setName(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Name of this subscription

setNameOverride(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

When displaying this choice to a customer, an optional override for the display the customer should see.

setNeedGrantEntitlements(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Whether the system has outstanding entitlements to grant on this subscription

setNeedGrantEntitlements(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Whether the system has outstanding entitlements to grant for this subscription

setNewItemRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Reference to the id (productId) of the item to upgrade or downgrade to.

setNewItemRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Type of newItemRef that this item is to be upgraded or downgraded to.

setNextBillDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Describes the next time that the customer will be billed.

setNextBillDate(Date) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Next date this subscription will be billed

setNextBillDate(Date) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Next date this subscription will be billed

setNextPeriod(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The next period this subscription will cover.

setNextRootItem(SubscriptionReferencedItem) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The hydrated item identified by ModifySubscriptionRequest.newItemRefType and ModifySubscriptionRequest.newItemRef which the subscription will be upgraded or downgraded to.

setNextStatusChangeDate(Date) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Date when the next status should begin

setNextStatusChangeDate(Date) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Date when the next status should begin

setNextStatusChangeReason(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Reason for the update to the next status

setNextStatusChangeReason(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Reason for the update to the next status

setNextSubscription(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

If this subscription was upgraded or downgraded, holds the reference to the subscription replacing this one

setNonCatalogItemDetails(NonCatalogItemDetails) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

Details of the item not present in a catalog.

setNonCatalogItemDetailsOnCancelItem(ModifySubscriptionRequest, AddItemRequest) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

Sets the NonCatalogItemDetails on the cancelItem

setNumberOfDaysInFullPeriod(Long) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

If a period is shortened (typically by the Subscription.getEndOfTermDate() occurring before the end of the period), then this value will describe the number of days in the full period - i.e.

setNumberOfDaysInFullPeriod(Long) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

If a period is shortened (typically by the Subscription.getEndOfTermDate() occurring before the end of the period), then this value will describe the number of days in the full period - i.e.

setNumberOfDaysInShortenedPeriod(Long) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

If a period is shortened (typically by the Subscription.getEndOfTermDate() occurring before the end of the period), then this value will describe the number of days in the shortened period.

setNumberOfDaysInShortenedPeriod(Long) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

If a period is shortened (typically by the Subscription.getEndOfTermDate() occurring before the end of the period), then this value will describe the number of days in the shortened period.

setNumberOfPeriodsLeftInTerm(Long) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The number of billing periods left in a term beyond the current period, if there are terms.

setOfferRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

The ID that refers to the offer / offer code being added.

setOfferRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

The type of adjustment to be added.

setOffersUri(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOfferProviderProperties

The base uri path to the offers endpoint

setOnline(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Whether or not this variant should be visible at all in the store.

setOptions(List<ProductOption>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

Drives additional information that the customer should enter when purchasing this product.

setOptionValues(Map<String, String>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Helper to make this particular variant uniquely identifiable across multiple variants for the same product.

setOrder(Order) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateSubscriptionFromOrderRequest

The source order to use to create one or more Subscriptions.

setOrderFulfillmentId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The id of the fulfillment that led to the creation of this delayed action.

setOrderId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The id of the order that led to the creation of this delayed action.

setOrderUri(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProviderProperties

The URI path for basic singular order retrieval.

setOriginalSubscriptionItemQuantity(int) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The original quantity of the SubscriptionItem.

setOverrideChangeContainer(ChangeContainer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

setOverridePrice(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The price of this choice.

setParentExistingQuantity(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The item's parent existing quantity prior to the subscription action (e.g.

setParentItemRef(SubscriptionItem, OrderItem) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Set the SubscriptionItem.getParentItemRef() and SubscriptionItem.getParentItemRefType() given the parentItem.

setParentItemRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

Reference of the parent subscription item's backing item if this is a child subscription item.

setParentItemRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Reference of the parent subscription item's backing item if this is a child subscription item

setParentItemRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Reference of the parent subscription item's backing item if this is a child subscription item

setParentItemRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Reference to the item underlying the parent subscription item if this is a child subscription item

setParentItemRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

Type of the parent subscription item's backing item if this is a child subscription item.

setParentItemRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Type of the parent subscription item's backing item if this is a child subscription item

setParentItemRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Type of the parent subscription item's backing item if this is a child subscription item

setParentItemRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Type of the parent subscription item's backing item if this is a child subscription item

setParentQuantity(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The item's parent quantity following the subscription action (e.g.

setPaymentStrategy(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

Declares that payments made against a subscription are going towards the goods/services rendered in the previous vs current period.

setPaymentStrategy(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Declares that payments made against a subscription are going towards the goods/services rendered in the previous vs current period.

setPaymentStrategy(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The payment strategy of the subscription, e.g.

setPaymentStrategy(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Declares that payments made against a subscription are going towards the goods/services rendered in the previous vs current period.

setPaymentStrategy(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

Declares that payments made against a subscription are going towards the goods/services rendered in the previous vs current period.

setPaymentStrategy(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Declares that payments made against a subscription are going towards the goods/services rendered in the previous vs current period.

setPeriod(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

The period number

setPeriodDefinitions(Map<Integer, PeriodDefinition>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Describes upcoming subscription billing periods, including the start date, end date, & when the customer will be billed.

setPeriodEndDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

The date describing the end of the billing period that is being billed for.

setPeriodEndDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

The date describing the end of the billing period that is being billed for.

setPeriodEndDate(Date) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

The end date of the period

setPeriodFrequency(int) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

The frequency with which the recurring price should be charged., e.g., a value of 1 combined with ExistingSubscriptionDetails.periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.

setPeriodFrequency(int) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The frequency with which the recurring price should be charged., e.g., a value of 1 combined with Subscription.periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.

setPeriodFrequency(int) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The frequency with which the recurring price should be charged., e.g., a value of 1 combined with SubscriptionPriceResponse.periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.

setPeriodFrequency(int) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The frequency with which the recurring price should be charged., e.g., a value of 1 combined with SubscriptionPricingContext.periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.

setPeriodFrequency(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

The frequency with which the recurring price should be charged., e.g., a value of 1 combined with SubscriptionCreationRequest.periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.

setPeriodNumber(int) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

The period number of the billing period.

setPeriodNumber(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

The period number of the billing period.

setPeriods(List<SubscriptionPeriod>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

List tracking the Subscription's periods.

setPeriodsAlreadyUsed(int) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

Represents the number of periods this adjustment has already been used.

setPeriodStartDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

The date describing the beginning of the billing period that is being billed for.

setPeriodStartDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

The date describing the beginning of the billing period that is being billed for.

setPeriodStartDate(Date) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

The start date of the period

setPeriodType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

The period type for the price, e.g.

setPeriodType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The period type for the price, e.g.

setPeriodType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The period type for the price, e.g.

setPeriodType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The period type for the price, e.g.

setPeriodType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

The period type for the price, e.g.

setPolicyByCartItemId(Map<String, CancellationPolicyRef>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyResponse

A map of CartItem.getId() to the matching CancellationPolicyRef.

setPolicyRules(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The rules of the policy that are used to matching items.

setPolicyUtils(TrackablePolicyUtils) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionValidationService

setPolicyUtils(TrackablePolicyUtils) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

setPolicyUtils(TrackablePolicyUtils) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

setPolicyUtils(TrackablePolicyUtils) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateDowngradeSubscriptionHandler

setPolicyUtils(TrackablePolicyUtils) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

setPolicyUtils(TrackablePolicyUtils) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateUpgradeSubscriptionHandler

setPostActionSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

The subscription item subtotal after to the action being taken, reflecting the typical recurring price for the item.

setPostActionSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The subscription subtotal after to the action being taken, reflecting the typical recurring price for the subscription.

setPostpaidPolicyDetail(CancellationPolicyDetail) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The policy details for items that are using the DefaultSubscriptionPaymentStrategy.POSTPAID strategy.

setPreActionSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

The subscription item subtotal prior to the action being taken, reflecting the typical recurring price for the item.

setPreActionSubtotal(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The subscription subtotal prior to the action being taken, reflecting the typical recurring price for the subscription.

setPreferredPaymentAccountId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

References an identifier of a PaymentAccount that is considered preferred for this subscription.

setPreferredPaymentAccountId(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

References an identifier of a BillingServices PaymentAccount that is considered preferred for this subscription.

setPrepaidPolicyDetail(CancellationPolicyDetail) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The policy details for items that are using the DefaultSubscriptionPaymentStrategy.PREPAID strategy.

setPrice(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

The price of the non-catalog-item.

setPrice(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

The one-time price.

setPriceCartRequest(PriceCartRequest) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

The initial PriceCartRequest to price the cart.

setPriceChangeEffectiveDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

The date and time when the price data change is to be taken into effect.

setPriceChangeEffectiveDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

The effective date of the price change.

setPriceChangeEffectiveType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

The descriptor of when the price change should take effect.

setPriceChangeEffectiveType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

Describes how the effective date of a subscription price change should be determined.

setPriceChangeScopeType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

Represents the default types of customer scope for which subscription bulk price changes can be applied.

setPriceDataChange(PriceDataChange) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChangeRequest

setPriceDataChanges(List<PriceDataChange>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

List of price data changes for this subscription

setPriceDataId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

The ID of the price data that is changed

setPriceDataId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

The id of the price data associated with this item.

setPriceDataId(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

The id of the updated price data tied to one or more subscriptions.

setPriceListId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

The contextId of the parent price list.

setPriceListId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

The id of the price list associated with this item.

setPricingKey(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

System-wide unique identifier to configure specific pricing for the choice.

setPricingKey(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

System-wide unique identifier to configure specific pricing for the choice.

setPriorBillDate(Date) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The bill date for the previous period

setPriority(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

The priority of the policy/

setPriorPeriodFrequency(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The frequency with which the recurring price should be charged., e.g., a value of 1 combined with SubscriptionPricingContext.periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.

setPriorPeriodType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The period type for the price, e.g.

setPriorUnbilledAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

Prior to an upgrade, downgrade, or edit, the system may have prior unbilled charges that will be part of the next invoice.

setPriorUnbilledAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Prior to an edit, upgrade, or downgrade on a subscription that’s using a Postpaid payment strategy, the system will have prior unbilled charges that will be part of the next invoice.

setPriorUnbilledUnitAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

Prior to an edit, upgrade, or downgrade on a subscription that’s using a Postpaid payment strategy, the system will have prior unbilled charges that will be part of the next invoice.

setPriorUnbilledUnitDiscountAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The subscription item discount per unit to be deducted from the SubscriptionItemPriceDetail.getPriorUnbilledUnitAmount().

setProduct(Product) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

If the SpecificItemChoice.type is DefaultSpecificItemChoiceType.PRODUCT this holds the product for this choice

setProduct(Product) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The Product of the root SubscriptionItem.

setProductId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

The link to the product that this variant is a part of

setProductId(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The id of the product for this add item request.

setProducts(Page<Product>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Category

The first page of Products belonging to the category.

setProductsUri(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProviderProperties

The base uri path to the products endpoint

setProductUri(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProviderProperties

The base uri path to the products endpoint

setProperties(SubscriptionCancellationProperties) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

setProratedAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

Prorated amount for this item (for new, this would match the amount)

setProratedAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The subscription price, prorated relative to the next invoice date.

setProratedUnitAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The subscription item price per unit, prorated relative to the next invoice date.

setProratedUnitAmountBetweenActionAndNextBillDate(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Similar to SubscriptionItemPriceDetail.getProratedUnitAmountBetweenActionAndNextBillDate(), this is the SubscriptionItemAdjustmentPriceDetail.fullSubscriptionPeriodUnitDiscountAmount prorated for the period between the action date and the next bill date after subscription action, regardless of the subscription action being taken or the payment strategy.

setProratedUnitAmountBetweenActionAndNextBillDate(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The subscription item price per unit prorated for the period between the action date and the next invoice date regardless of the subscription action being taken or the payment strategy.

setProratedUnitAmountBetweenPeriodStartAndActionDate(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Similar to SubscriptionItemPriceDetail.getProratedUnitAmountBetweenPeriodStartAndActionDate(), this is the SubscriptionItemAdjustmentPriceDetail.fullSubscriptionPeriodUnitDiscountAmount prorated for the period between the period start date and the action date after subscription action, regardless of the subscription action being taken or the payment strategy.

setProratedUnitAmountBetweenPeriodStartAndActionDate(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The subscription item price per unit prorated for the period between the period start date and the action date and the regardless of the subscription action being taken or the payment strategy.

setProratedUnitDiscountAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Similar to SubscriptionItemPriceDetail.getProratedUnitAmount(), this is the original discount amount prorated relative to the next invoice date.

setProvider(String) - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationProviderProperties

setQualifierDetails(List<OfferItemDetail>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

A list of OfferItemDetails representing the qualifier items where this adjustment was from.

setQuantity(int) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Quantity purchased.

setQuantity(int) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The quantity of this item to be added to the Cart.

setQuantity(int) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Quantity purchased

setQuantity(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The item's quantity following the subscription action (e.g.

setReadOfferUri(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOfferProviderProperties

The uri path to the endpoint that reads an offer based on the passed ID

setReason(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The reason for modifying the subscription.

setReasonCode(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

A system code used to identify the reason for the removal of the adjustment.

setReasonMessage(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

A message to the customer specifying why the adjustment is being removed.

setRecurringPeriodFrequency(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The frequency of the recurring period, e.g., if this is 1 and AddItemRequest.recurringPeriodType is MONTHLY, then the recurring price should be charged every 1 month.

setRecurringPeriodType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The period type for the recurring price, e.g.

setRecurringPrice(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

The amount of the recurring price.

setReference(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

An idempotency key that can be used to identify repeated requests

setRemainderOfTermsUnitAmount(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

The unit amount to charge for the remainder of terms if the remainder of terms is being charged.

setRemainingReservations(int) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

The quantity of reservations remaining for the lock

setRemovedAdjustments(List<RemovedAdjustment>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The list of Adjustments being removed with additional contextual information.

setRemovedAdjustments(List<RemovedAdjustment>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The list of Adjustments being removed due to the proposed changes.

setRemovedSubscriptionItems(List<SubscriptionItem>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

List of SubscriptionItems that are not on the cart.

setReplaceExisting(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

Indicates whether this request should replace all other adjustments on the subscription.

setRequestAttributes(Map<String, Object>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionRequest

Additional request attributes.

setRequestedStatus(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.UpdateSubscriptionStatusRequest

The new status that's being requested.

setRequiresDirectReference(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

Whether the policy requires direct reference via Product or PriceData references.

setReservationTokens(Stack<String>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

The tokens associated with each of the optional child locks.

setRestrictDowngradeAfterDays(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

The number of days after which a downgrade is not allowed, until the window re-opens at the next billing cycle.

setRestrictQtyDecreaseAfterDays(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The number of days after which a quantity decrease is not allowed until the window re-opens at the next billing cycle.

setRestrictRemovalAfterDays(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

The number of days after which an item can't be removed from the subscription, until the window re-opens at the next billing cycle.

setResumeDate(Date) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Date this subscription will or did continue.

setRootCartItemId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Reference to the root subscription CartItem

setRootItem(SubscriptionReferencedItem) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

The item referenced by Subscription.getRootItemRef().

setRootItem(SubscriptionReferencedItem) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The hydrated original root item of the subscription to be modified.

setRootItemRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Reference to the item id for which this subscription was provision

setRootItemRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Reference to the id of the item represented by this object.

setRootItemRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Reference to the item id for which this subscription was provision

setRootItemRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Type of the item for which this subscription was provisioned

setRootItemRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

Type of item that this object represents.

setRootItemRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Type of the item for which this subscription was provisioned

setRootSubscriptionItemId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

ID of the root SubscriptionItem.

setSalePrice(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Indicates that this product is on sale.

setSearchOnOption(Boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

If the product option is of type DefaultProductOptionType.VARIANT_DISTINGUISHING, this allows searching based on this product option.

setSecondarySourceRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The secondary source to reference, e.g, an Order Item on an Order.

setSecondarySourceRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

The secondary source to reference, e.g, an Order Item on an Order.

setSecondarySourceRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

The secondary source to reference, e.g, an Order Item on an Order.

setSecondarySourceType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The type of the secondary source to reference, e.g, an Order Item on an Order.

setSecondarySourceType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

The type of the secondary source to reference, e.g, an Order Item on an Order.

setSecondarySourceType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

The type of the secondary source to reference, e.g, an Order Item on an Order.

setSegmentsUri(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProviderProperties

The base uri path to the customer endpoint

setSelectionType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Describes restrictions placed on the customer's ability to select items from the targeted set.

setSeparateFromPrimaryItem(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Whether this is a sub-item on the main subscription or a separate item.

setServiceClient(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProviderProperties

The service client to use when calling billing services.

setServiceClient(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProviderProperties

The service client to use when calling an external service.

setServiceClient(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProviderProperties

The service client to use when calling catalog services.

setServiceClient(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProviderProperties

The service client to use when calling customer services.

setServiceClient(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOfferProviderProperties

The service client to use when calling offer/promotion services.

setServiceClient(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProviderProperties

The service client to use when calling Order services.

setServiceClient(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

The service client to use when calling billing services.

setShortenedPeriodReason(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

Describes the reason that the period was shortened.

setShortenedPeriodReason(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

Describes the reason that the period was shortened.

setSiteIdentifier(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Multi-tenancy support

setSku(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Sku code for this particular variant.

setSku(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The SKU code for the item (e.g., Product or Variant).

setSpecificChoices(List<SpecificItemChoice>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

If the ItemChoice.targetType is DefaultItemChoiceTargetType.SPECIFIC_PRODUCTS or DefaultItemChoiceTargetType.SPECIFIC_VARIANTS this holds the manually-curated options that the customer can choose from.

setSpecificItemChoice(SpecificItemChoice) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

If the ItemChoice.targetType is DefaultItemChoiceTargetType.SPECIFIC_PRODUCT or DefaultItemChoiceTargetType.SPECIFIC_VARIANT this holds the manually selected option that the customer can choose to add on.

setStartChangeAutoRenewalWorkflowEnabled(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionCancellationProperties

Whether or not to trigger the workflow from the ChangeSubscriptionAutoRenewalHandler

setStartChangeAutoRenewalWorkflowService(StartChangeAutoRenewalWorkflowService) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

setStartOfTermDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The start of term date for this subscription.

setStartOfTermDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The date at which the subscription's terms will begin.

setState(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

The current state of the lock

setSubOpsService(SubscriptionOperationService<SubscriptionWithItems>) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

setSubscription(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Whether this addon is a subscription addon.

setSubscription(Subscription) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

setSubscriptionActionDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

The timestamp at which the subscription action was taken.

setSubscriptionActionDate(Instant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The timestamp at which the subscription action was taken.

setSubscriptionAdjustments(List<SubscriptionAdjustment>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Adjustments for this subscription.

setSubscriptionAdjustments(List<SubscriptionAdjustment>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Adjustments for this subscription.

setSubscriptionAdjustmentType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

setSubscriptionAdjustmentType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

setSubscriptionAdjustmentType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

setSubscriptionId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The id of delayed action's related subscription.

setSubscriptionId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionAdjustmentDetail

Id of the Subscription.

setSubscriptionId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

setSubscriptionId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

The subscription ID that the lock is associated with

setSubscriptionId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

The ID of the Subscription to add the offer to.

setSubscriptionId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The id of the subscription of which the adjustment going to be removed belongs to.

setSubscriptionId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

Reference to the Subscription whose price this adjusts

setSubscriptionId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Reference the subscription for this item

setSubscriptionId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

Identifier for the subscription

setSubscriptionId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

setSubscriptionId(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The id of the subscription to modify.

setSubscriptionId(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionRequest

The id of the subscription to get the available actions for.

setSubscriptionId(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.UpdateSubscriptionStatusRequest

The id of the subscription to modify.

setSubscriptionInGracePeriod(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Whether the SubscriptionPricingContext.existingSubscription is within its grace period during a cancellation flow.

setSubscriptionItemAdjustmentId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The id of the subscription item adjustment that will actually be removed.

setSubscriptionItemAdjustmentRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

Reference to the SubscriptionItemAdjustment

setSubscriptionItemAdjustments(List<SubscriptionItemAdjustment>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Adjustments for this subscription.

setSubscriptionItemAdjustments(List<SubscriptionItemAdjustment>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Adjustments for this subscription.

setSubscriptionItemId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemAdjustmentDetail

Id of the SubscriptionItem.

setSubscriptionItemId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

setSubscriptionItemId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The id of the subscription item of which the adjustment going to be removed belongs to.

setSubscriptionItemId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

Reference to the SubscriptionItem whose price this adjusts

setSubscriptionItemName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The id of the subscription item of which the adjustment going to be removed belongs to.

setSubscriptionItems(List<SubscriptionItem>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

setSubscriptionName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

The id of the subscription of which the adjustment going to be removed belongs to.

setSubscriptionNextStatus(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Next status for this subscription

setSubscriptionNextStatus(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Next status for this subscription

setSubscriptionOperationService(SubscriptionOperationService<SubscriptionWithItems>) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionValidationService

setSubscriptionPriceDataPath(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

The base uri path to the subscription price data endpoint

setSubscriptionRootItem(CartItem) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

The CartItem representing the root SubscriptionItem.

setSubscriptionsByApplication(Map<String, Set<String>>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChangeRequest

setSubscriptionSource(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

This field shows from which process or user action this subscription originated.

setSubscriptionSource(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

This field shows from which process or user action this subscription originated.

setSubscriptionSourceRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

This field shows the identifier of the process or user action this subscription originated.

setSubscriptionSourceRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

This field shows the identifier of the process or user action this subscription originated.

setSubscriptionsPath(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

The base uri path to the subscription endpoint

setSubscriptionStatus(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Current status of this subscription

setSubscriptionStatus(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Current status of this subscription

setSubscriptionStatusHandlers(List<SubscriptionStatusHandler<SWI>>) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

setSubscriptionWithItems(SubscriptionWithItems) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

Holds the SubscriptionWithItems referenced by ModifySubscriptionRequest.subscriptionId.

setSubscriptionWithItems(SubscriptionWithItems) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionResponse

setSubscriptionWithItemsPageSize(int) - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationServiceProperties

the default page size for gathering SubscriptionWithItems from BillingServices

setSubscriptionWithItemsPath(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

The base uri path to the subscription with items endpoint

setTargetType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

Identifies the type of items that a customer can choose from, whether specific products, specific variants, or products from a specific category.

setTaxable(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

Whether this non-catalog item is taxable.

setTaxable(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Whether this item is taxable

setTaxable(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Whether this item is taxable

setTaxAllowedForCancellationCharge(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionCancellationProperties

Whether tax should be calculated on the cancellation charge

setTaxCategory(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Tax category of the item

setTaxCategory(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Tax category of the item

setTaxCode(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

The tax code for this variant.

setTaxNexus(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Comma-separated nexus codes

setTermDurationLength(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The length of the terms, e.g., if this is 36 and Subscription.termDurationType is MONTHS, then the user should be billed for 36 months.

setTermDurationLength(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The length of the term duration selected for the item, if any.

setTermDurationLength(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

The length of the terms, e.g., if this is 36 and SubscriptionCreationRequest.termDurationType is MONTHS, then the user should be billed for 36 months.

setTermDurationType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The term duration type, e.g.

setTermDurationType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The type of the term duration selected for the item, if any.

setTermDurationType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

The term duration type, e.g.

setTrackablePolicyUtils(TrackablePolicyUtils) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionAccessValidationService

setType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

Controls both how the customer should be inputting values to fill out this option as well as storage of where the value will go once added to the cart.

setType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

Whether or not this item holds a product or a variant that the customer can select from

setType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

Allows optionally setting the type of cart to be created.

setUnavailableReasonsByActionType(Map<String, List<String>>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

The unavailable SubscriptionActionTypes along with unavailable reasons for this subscription.

setUnavailableReasonsByActionType(Map<String, List<String>>) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionResponse

The unavailable SubscriptionActionTypes along with unavailable reasons for this subscription.

setUnitChargeForPreviouslyDiscountedPeriods(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The unit discount amount to charge for previously discounted periods.

setUnitDiscountAmountForRemainderOfTerms(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

The unit discount amount that is to be applied for the remainder of terms if the remainder of terms is being charged.

setUpc(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

Universal product code that defines this particular variant of the product

setUpdateCatalogPricing(boolean) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.PriceCartRequest

Declares if catalog prices should also be gathered as part of the repricing process.

setUpgradeProductIds(List<String>) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

The list of ids of the product that this product can upgrade to.

setUrl(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProviderProperties

The base url for an external service holding cancellation policies.

setUrl(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCartOperationProviderProperties

The base url for an external cart operation service.

setUrl(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProviderProperties

The base url for an external service holding products.

setUrl(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProviderProperties

The base url for an external service concerning customers.

setUrl(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOfferProviderProperties

The base url for an external service concerning offers.

setUrl(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProviderProperties

The base url for an external order service.

setUrl(String) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

The base url for an external service holding subscriptions.

setUsagePrice(MonetaryAmount) - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

The amount of the usage price.

setUserRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Reference to the user to whom this subscription belongs

setUserRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

Reference to the user to whom this subscription belongs

setUserRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The reference to the user requesting to perform the modification.

setUserRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionRequest

The reference to the user making the request.

setUserRef(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Reference to the user to whom this subscription belongs

setUserRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Type of user owning this subscription

setUserRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

Type of user owning this subscription.

setUserRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

The type of user requesting to preform the modification.

setUserRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionRequest

The type of the user making the request.

setUserRefType(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Type of user owning this subscription

setVariant(Variant) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

If the SpecificItemChoice.type is DefaultSpecificItemChoiceType.VARIANT this holds the variant for this choice

setVariantId(String) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The id of the variant for this add item request.

setVariantParentProductId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

This field contains the id of the parent product of the specified SpecificItemChoice.variant if the type is DefaultSpecificItemChoiceType.VARIANT.

setVersion(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

The version of this subscription.

setVersion(Integer) - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

The version of the cart being modified.

setWorkflowName(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

The name of the workflow that created this delayed action.

shouldBuildItemDetailsForRemovedSubscriptionItems(Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Declares if SubscriptionItemPriceDetail records should be constructed for subscription items that have been removed according to the current state of the cart's items.

shouldCreateNewSubscription(CreateSubscriptionFromOrderRequest, OrderItem, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Hook point to determine whether a given Order has any items representing a Subscription that should be created.

shouldOverrideDueNowItemQuantity(Integer, Integer, Integer, SubscriptionPricingContext, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Determines if using the existing item's quantity should be used for due now price calculations.

shouldProcessPriceChangeImmediately(PriceDataChange) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionPricingService

Hook point to decide whether a PriceDataChange should be applied immediately to the related Subscriptions and possibly existing BillingEvents.

shouldRoundUpBillDates() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

Determines whether the bill dates (e.g.

shouldStartChangeAutoRenewalWorkflow(ModifySubscriptionRequest, Subscription) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

SPECIFIC_PRODUCT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceTargetType

The item choice is a specific Product.

SPECIFIC_PRODUCTS - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceTargetType

The item choice is among Products from a predetermined list.

SPECIFIC_VARIANT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceTargetType

The item choice is a specific Variant.

SPECIFIC_VARIANTS - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceTargetType

The item choice is among Variants from a predetermined list.

SpecificItemChoice - Class in com.broadleafcommerce.subscriptionoperation.domain

When a ItemChoice is determined to be a DefaultItemChoiceTargetType#SPECIFIC_PRODUCTS or DefaultItemChoiceTargetType#SPECIFIC_VARIANTS, this holds the relationship that the customer should select from

SpecificItemChoice() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

SSLVerificationProperties - Class in com.broadleafcommerce.subscriptionoperation.service.autoconfigure

Deprecated, for removal: This API element is subject to removal in a future version.

Use CommonInternalServiceSSLVerificationProperties instead

SSLVerificationProperties() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SSLVerificationProperties

Deprecated.

startChangeAutoRenewalWorkflow(Subscription, boolean, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultStartChangeAutoRenewalWorkflowService

startChangeAutoRenewalWorkflow(Subscription, boolean, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.StartChangeAutoRenewalWorkflowService

Starts the "*ChangeAutoRenewalWorkflow" workflow

startChangeAutoRenewalWorkflowService(WorkflowProvider) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

StartChangeAutoRenewalWorkflowService - Interface in com.broadleafcommerce.subscriptionoperation.service

This service is responsible for starting the "*ChangeAutoRenewalWorkflow" workflow.

state(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus.LockStatusBuilder

The current state of the lock

subOpsCancellationPolicyProvider(WebClient, ObjectMapper, TypeFactory, ExternalCancellationPolicyProviderProperties, AuthenticationUtils) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration.SubscriptionProviderConfiguration

subOpsCancellationPolicyService(CancellationPolicyProvider<CancellationPolicy>, RuleEvaluationService, TypeFactory) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

subOpsCartOperationsProvider(WebClient, ObjectMapper, TypeFactory, ExternalCartOperationProviderProperties, AuthenticationUtils) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration.SubscriptionProviderConfiguration

subOpsCatalogProvider(WebClient, ObjectMapper, TypeFactory, ExternalCatalogProviderProperties) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration.SubscriptionProviderConfiguration

subOpsCustomerProvider(WebClient, ObjectMapper, TypeFactory, ExternalCustomerProviderProperties) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration.SubscriptionProviderConfiguration

subOpsMessagesDefaultBasenameAddingPostProcessor() - Method in class com.broadleafcommerce.subscriptionoperation.i18n.autoconfigure.SubscriptionOperationI18nAutoConfiguration

SubOpsMessagesDefaultBasenameAddingPostProcessor() - Constructor for class com.broadleafcommerce.subscriptionoperation.i18n.autoconfigure.SubscriptionOperationI18nAutoConfiguration.SubOpsMessagesDefaultBasenameAddingPostProcessor

subOpsOrderHistoryService(SubscriptionProvider<SubscriptionWithItems, Subscription, SubscriptionOwnerInfo>, OrderProvider<Order>) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

subOpsOrderProvider(WebClient, ObjectMapper, TypeFactory, ExternalOrderProviderProperties) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration.SubscriptionProviderConfiguration

subOpsSubscriptionGenerationService(SubscriptionProvider<SubscriptionWithItems, Subscription, SubscriptionOwnerInfo>, SubscriptionOperationUtils, MessageSource, TypeFactory) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

subOpsSubscriptionPricingService(SubscriptionProvider<SubscriptionWithItems, Subscription, SubscriptionOwnerInfo>, TypeFactory, CancellationPolicyProvider<CancellationPolicy>, SubscriptionOperationUtils, SubscriptionPricingProperties, CustomerProvider<FilteredAccounts>, WorkflowProvider) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

Subscription - Class in com.broadleafcommerce.subscriptionoperation.domain

This is a domain representing a user's subscription to a service or a good.

Subscription() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Subscription(String, String, String, String, Date, String, Date, String, String, String, String, String, String, String, String, String, String, String, String, int, String, String, Date, Date, String, CurrencyUnit, String, String, String, Date, Date, boolean, Integer, List<SubscriptionPeriod>, List<DelayedSubscriptionAction>, List<PriceDataChange>, boolean, List<SubscriptionAdjustment>, boolean, boolean, Instant, Instant, Integer, String, String, String, String, Map<String, Object>, Map<String, Object>, Integer, ContextState) - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.Subscription

Deprecated.

in favor of Subscription.periodType & Subscription.periodFrequency

SUBSCRIPTION - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultAdjustmentOwnerType

SUBSCRIPTION_ACTION_DATE - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

SUBSCRIPTION_ACTION_FLOW - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartAttributeConstants

Describes the subscription action flow that is being executed.

SUBSCRIPTION_ACTION_FLOW - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

SUBSCRIPTION_BULK_PRICING_UPDATE_WORKFLOW - Static variable in class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultWorkflowNameConstants

Workflow used to update price data value and find applicable subscriptions that require further processing.

SUBSCRIPTION_CSR_ADD_ADJUSTMENT_WORKFLOW - Static variable in class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultWorkflowNameConstants

Workflow used to add adjustments to a subscription, done by a CSR, and then engage billing event generation.

SUBSCRIPTION_ITEM - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultAdjustmentOwnerType

SUBSCRIPTION_OPS_ROUTE_KEY - Static variable in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.RouteConstants.Persistence

SUBSCRIPTION_OPS_ROUTE_PACKAGE - Static variable in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.RouteConstants.Persistence

SUBSCRIPTION_PAYMENT_STRATEGY - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartAttributeConstants.Internal

The payment strategy used to pay for the subscription.

SUBSCRIPTION_PAYMENT_STRATEGY - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartItemAttributeConstants.Internal

The payment strategy used to pay for the subscription.

SUBSCRIPTION_PRICE_EXPIRATION_DATE_UTC - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.CartAttributeConstants.Internal

The expiration date of the subscription prices.

SUBSCRIPTION_RESTRICTION_TYPE - Static variable in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionAccessValidationService

SUBSCRIPTION_USE_SANDBOX - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

subscriptionAccessValidationService(AuthenticationUtils) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

SubscriptionAccessValidationService - Interface in com.broadleafcommerce.subscriptionoperation.service

Performs validation to check the accessibility of the subscriptions for the user.

SubscriptionAction - Class in com.broadleafcommerce.subscriptionoperation.domain

Represents an action that can be taken against a Subscription.

SubscriptionAction() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAction

SubscriptionActionConstants - Class in com.broadleafcommerce.subscriptionoperation.domain.constants

SubscriptionActionConstants() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionActionConstants

SubscriptionActionPriceDetail - Class in com.broadleafcommerce.subscriptionoperation.domain

Describes the amount being charged for this item.

SubscriptionActionPriceDetail() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

SubscriptionActionRequest - Class in com.broadleafcommerce.subscriptionoperation.web.domain

A request DTO to see what actions are available for a Subscription.

SubscriptionActionRequest() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionRequest

SubscriptionActionResponse - Class in com.broadleafcommerce.subscriptionoperation.web.domain

A response DTO containing the available SubscriptionActions and unavailable SubscriptionActions along with the unavailable reasons.

SubscriptionActionResponse() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionResponse

SubscriptionAdjustment - Class in com.broadleafcommerce.subscriptionoperation.domain

This is a representation of a price adjustment for a Subscription

SubscriptionAdjustment() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

SubscriptionAttributeConstants - Class in com.broadleafcommerce.subscriptionoperation.domain.constants

Contains all the constants for Subscription.getAttributes() and Subscription.getInternalAttributes().

SubscriptionAttributeConstants() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionAttributeConstants

SubscriptionAttributeConstants.Internal - Class in com.broadleafcommerce.subscriptionoperation.domain.constants

SubscriptionCancellationProperties - Class in com.broadleafcommerce.subscriptionoperation.service.autoconfigure

Configuration properties for Subscription cancellation.

SubscriptionCancellationProperties() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionCancellationProperties

SubscriptionCreationRequest - Class in com.broadleafcommerce.subscriptionoperation.web.domain

A request DTO that stores fields necessary for creating a Subscription and its items.

SubscriptionCreationRequest() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

SubscriptionCreationRequest(String, String, String, Date, String, String, String, String, String, String, String, String, String, String, Integer, String, String, Date, String, String, String, List<SubscriptionItemCreationRequest>, List<SubscriptionAdjustment>, CurrencyUnit, boolean, boolean, Instant, Integer, String, Map<String, Object>) - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

Deprecated.

in favor of SubscriptionCreationRequest.periodType & SubscriptionCreationRequest.periodFrequency

SubscriptionDateUtils - Class in com.broadleafcommerce.subscriptionoperation.service

An util class for time related calculations.

SubscriptionDateUtils() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.SubscriptionDateUtils

SubscriptionGenerationService<SWI extends SubscriptionWithItems> - Interface in com.broadleafcommerce.subscriptionoperation.service

Service used to generate Subscription records based on an Order and its items.

subscriptionId(String) - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus.LockStatusBuilder

The subscription ID that the lock is associated with

SubscriptionItem - Class in com.broadleafcommerce.subscriptionoperation.domain

This represents a line item for a Subscription

SubscriptionItem() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

SubscriptionItem(String, String, String, String, String, String, Map<String, String>, String, String, String, String, String, String, String, BigDecimal, int, boolean, String, String, boolean, String, List<SubscriptionItemAdjustment>, String, String, Map<String, Object>, ContextState) - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

Creates a new SubscriptionItem instance.

SubscriptionItemAdjustment - Class in com.broadleafcommerce.subscriptionoperation.domain

This represents a line item price adjustment for a Subscription

SubscriptionItemAdjustment() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

SubscriptionItemAdjustmentPriceDetail - Class in com.broadleafcommerce.subscriptionoperation.domain

Represent the details of the price adjustment for a subscription item.

SubscriptionItemAdjustmentPriceDetail() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

SubscriptionItemCreationRequest - Class in com.broadleafcommerce.subscriptionoperation.web.domain

Request DTO stored on SubscriptionCreationRequest that holds fields necessary for building and creating a subscription

SubscriptionItemCreationRequest() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

SubscriptionItemCreationRequest(String, String, String, String, String, String, BigDecimal, int, boolean, String, List<SubscriptionItemAdjustment>, Map<String, Object>) - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

Creates a new SubscriptionItemCreationRequest instance.

SubscriptionItemPriceDetail - Class in com.broadleafcommerce.subscriptionoperation.domain

Describes the amount being charged for this item.

SubscriptionItemPriceDetail() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

SubscriptionLockException - Exception in com.broadleafcommerce.subscriptionoperation.service.exception

Thrown if the subscription can't be locked.

SubscriptionLockException(String) - Constructor for exception com.broadleafcommerce.subscriptionoperation.service.exception.SubscriptionLockException

subscriptionModificationUtils(TypeFactory) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

SubscriptionModificationUtils - Class in com.broadleafcommerce.subscriptionoperation.service.modification

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

SubscriptionModificationUtils(TypeFactory) - Constructor for class com.broadleafcommerce.subscriptionoperation.service.modification.SubscriptionModificationUtils

subscriptionOperationAuthorizedClientManager(ClientRegistrationRepository, Optional<ClientHttpConnector>) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationWebClientAutoConfiguration

The shared authorized-client manager for service-to-service calls.

subscriptionOperationClientHttpConnector(CommonInternalServiceSSLVerificationProperties, ObjectProvider<CommonInternalServiceClientConnectorFactory>) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationWebClientAutoConfiguration

SubscriptionOperationEndpoint - Class in com.broadleafcommerce.subscriptionoperation.web.endpoint

SubscriptionOperationEndpoint(SubscriptionOperationService<SubscriptionWithItems>, UserSubscriptionSummaryService<UserSubscriptionSummary, SubscriptionWithItems>) - Constructor for class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

SubscriptionOperationEnvironmentPostProcessor - Class in com.broadleafcommerce.subscriptionoperation.autoconfigure

Spring Boot default property overrides for this service

SubscriptionOperationEnvironmentPostProcessor() - Constructor for class com.broadleafcommerce.subscriptionoperation.autoconfigure.SubscriptionOperationEnvironmentPostProcessor

SubscriptionOperationExceptionAdvisor - Class in com.broadleafcommerce.subscriptionoperation.web.endpoint.exception

General exception handler registry for handlers not exclusive to a single controller.

SubscriptionOperationExceptionAdvisor() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.endpoint.exception.SubscriptionOperationExceptionAdvisor

SubscriptionOperationI18nAutoConfiguration - Class in com.broadleafcommerce.subscriptionoperation.i18n.autoconfigure

SubscriptionOperationI18nAutoConfiguration() - Constructor for class com.broadleafcommerce.subscriptionoperation.i18n.autoconfigure.SubscriptionOperationI18nAutoConfiguration

SubscriptionOperationI18nAutoConfiguration.SubOpsMessagesDefaultBasenameAddingPostProcessor - Class in com.broadleafcommerce.subscriptionoperation.i18n.autoconfigure

SubscriptionOperationJpaAutoConfiguration - Class in com.broadleafcommerce.subscriptionoperation.provider.jpa.autoconfigure

SubscriptionOperationJpaAutoConfiguration() - Constructor for class com.broadleafcommerce.subscriptionoperation.provider.jpa.autoconfigure.SubscriptionOperationJpaAutoConfiguration

SubscriptionOperationJpaAutoConfiguration.EnabledGranularOrFlex - Class in com.broadleafcommerce.subscriptionoperation.provider.jpa.autoconfigure

SubscriptionOperationJpaProperties - Class in com.broadleafcommerce.subscriptionoperation.provider.jpa.environment

SubscriptionOperationJpaProperties() - Constructor for class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationJpaProperties

subscriptionOperationOAuth2FilterFunctionSupplier(OAuth2AuthorizedClientManager) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationWebClientAutoConfiguration

SubscriptionOperationProviderProperties - Class in com.broadleafcommerce.subscriptionoperation.provider.jpa.environment

Provides a programmatic way to access the property that defines whether a database provider is present, and if so, which framework is used.

SubscriptionOperationProviderProperties() - Constructor for class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationProviderProperties

subscriptionOperationRouteSupplier(DataRouteSupporting) - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.autoconfigure.SubscriptionOperationJpaAutoConfiguration

subscriptionOperationService - Variable in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

subscriptionOperationService(SubscriptionProvider<SubscriptionWithItems, Subscription, SubscriptionOwnerInfo>, SubscriptionValidationService, TypeFactory, List<ModifySubscriptionHandler>, CatalogProvider<Product>, CancellationPolicyProvider<CancellationPolicy>, SubscriptionGenerationService<SubscriptionWithItems>, SubscriptionOperationUtils, WorkflowProvider, SubscriptionOperationServiceProperties, MessageSource) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

SubscriptionOperationService<SWI extends SubscriptionWithItems> - Interface in com.broadleafcommerce.subscriptionoperation.service

Service for operations on subscriptions and their items

SubscriptionOperationServiceAutoConfiguration - Class in com.broadleafcommerce.subscriptionoperation.service.autoconfigure

SubscriptionOperationServiceAutoConfiguration() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

SubscriptionOperationServiceAutoConfiguration.SubscriptionProviderConfiguration - Class in com.broadleafcommerce.subscriptionoperation.service.autoconfigure

SubscriptionOperationServiceAutoConfiguration.SubscriptionStatusChangeHandlersConfiguration - Class in com.broadleafcommerce.subscriptionoperation.service.autoconfigure

SubscriptionOperationServiceProperties - Class in com.broadleafcommerce.subscriptionoperation.service

Configurable properties for the Subscription Operation Service.

SubscriptionOperationServiceProperties() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationServiceProperties

subscriptionOperationSource() - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.autoconfigure.SubscriptionOperationJpaAutoConfiguration

Defines a DataRouteSupporting for Subscription Ops.

subscriptionOperationUtils() - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

SubscriptionOperationUtils - Class in com.broadleafcommerce.subscriptionoperation.service

SubscriptionOperationUtils() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationUtils

SubscriptionOperationWebAutoConfiguration - Class in com.broadleafcommerce.subscriptionoperation.web.autoconfigure

SubscriptionOperationWebAutoConfiguration() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.autoconfigure.SubscriptionOperationWebAutoConfiguration

subscriptionOperationWebClient(Supplier<ServletOAuth2AuthorizedClientExchangeFilterFunction>, OAuth2AuthorizedClientManager, ObjectMapper, Optional<ClientHttpConnector>) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationWebClientAutoConfiguration

SubscriptionOperationWebClientAutoConfiguration - Class in com.broadleafcommerce.subscriptionoperation.service.autoconfigure

SubscriptionOperationWebClientAutoConfiguration() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationWebClientAutoConfiguration

SubscriptionOrderHistoryEndpoint - Class in com.broadleafcommerce.subscriptionoperation.web.endpoint

SubscriptionOrderHistoryEndpoint(SubscriptionOrderHistoryService<Order>) - Constructor for class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOrderHistoryEndpoint

SubscriptionOrderHistoryService<O extends com.broadleafcommerce.order.client.domain.Order> - Interface in com.broadleafcommerce.subscriptionoperation.service

Service that is used to read the Orders for the specified subscription ID.

SubscriptionOwnerInfo - Class in com.broadleafcommerce.subscriptionoperation.domain

DTO that contains information about the owner of a subscription, e.g.

SubscriptionOwnerInfo() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

SubscriptionOwnerInfo(String, String, String, String, Map<String, Object>) - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

Creates a new SubscriptionOwnerInfo instance.

SubscriptionPeriod - Class in com.broadleafcommerce.subscriptionoperation.domain

Simple object describing the start, end, & bill dates of a subscription period.

SubscriptionPeriod() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

SubscriptionPeriodAttributeConstants - Class in com.broadleafcommerce.subscriptionoperation.domain.constants

Contains all the constants for SubscriptionPeriod.getAttributes().

SubscriptionPeriodAttributeConstants() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionPeriodAttributeConstants

SubscriptionPriceResponse - Class in com.broadleafcommerce.subscriptionoperation.domain

For a subscription cart item, this object describes the amount that the customer should be charged now vs their future payments.

SubscriptionPriceResponse() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

SubscriptionPricingContext - Class in com.broadleafcommerce.subscriptionoperation.domain

Context object that's used throughout the subscription pricing ecosystem to communicate details about the subscription, action, & subscription periods.

SubscriptionPricingContext() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

SubscriptionPricingEndpoint - Class in com.broadleafcommerce.subscriptionoperation.web.endpoint

SubscriptionPricingEndpoint(SubscriptionPricingService) - Constructor for class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionPricingEndpoint

SubscriptionPricingProperties - Class in com.broadleafcommerce.subscriptionoperation.service

SubscriptionPricingProperties() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.SubscriptionPricingProperties

subscriptionPricingService - Variable in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionPricingEndpoint

SubscriptionPricingService - Interface in com.broadleafcommerce.subscriptionoperation.service

Service for pricing subscriptions.

subscriptionProvider(WebClient, ObjectMapper, TypeFactory, ExternalSubscriptionProperties) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration.SubscriptionProviderConfiguration

SubscriptionProvider<SWI extends SubscriptionWithItems,S extends Subscription,SO extends SubscriptionOwnerInfo> - Interface in com.broadleafcommerce.subscriptionoperation.service.provider

Provider interfacing with Broadleaf's BillingServices to gather, update, or create Subscription and related entities.

SubscriptionProviderConfiguration() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration.SubscriptionProviderConfiguration

SubscriptionReferencedItem - Interface in com.broadleafcommerce.subscriptionoperation.domain

Identifies an entity that can be referenced by a SubscriptionItem.

SubscriptionStatusChangeHandlersConfiguration() - Constructor for class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration.SubscriptionStatusChangeHandlersConfiguration

SubscriptionStatuses - Enum Class in com.broadleafcommerce.subscriptionoperation.domain.enums

Enumerates the statuses for a subscription

SubscriptionStatusHandler<SWI extends SubscriptionWithItems> - Interface in com.broadleafcommerce.subscriptionoperation.service.status

A handler that handles a Subscription's status change, e.g.

subscriptionValidationService(CatalogProvider<Product>) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

SubscriptionValidationService - Interface in com.broadleafcommerce.subscriptionoperation.service

Service for validating actions against subscriptions.

SubscriptionWithItems - Class in com.broadleafcommerce.subscriptionoperation.domain

This is a container for a Subscription and a list of SubscriptionItem

SubscriptionWithItems() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

SubscriptionWithItems(Subscription, List<SubscriptionItem>, List<SubscriptionAction>, Map<String, List<String>>, SubscriptionReferencedItem, CancellationPolicy, Map<String, Object>) - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

Creates a new SubscriptionWithItems instance.

SynchronizedDelegatingOAuth2AuthorizedClientManager - Class in com.broadleafcommerce.subscriptionoperation.oauth2.client.web

Deprecated, for removal: This API element is subject to removal in a future version.

Use CommonInternalServiceSynchronizedOAuth2AuthorizedClientManager instead

SynchronizedDelegatingOAuth2AuthorizedClientManager(ClientRegistrationRepository) - Constructor for class com.broadleafcommerce.subscriptionoperation.oauth2.client.web.SynchronizedDelegatingOAuth2AuthorizedClientManager

Deprecated.

T

TENANT_ID - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.WorkflowContextConstants

TERMINATE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

A system-driven/business-driven request to cancel the subscription.

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicy

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.CancellationPolicyDetail

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Category

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.DelayedSubscriptionAction

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.EstimatedFuturePayment

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionAdjustmentDetail

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemAdjustmentDetail

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionItemDetail

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.FilteredAccounts

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ItemChoice

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus.LockStatusBuilder

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.LockStatus

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.NonCatalogItemDetails

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.AddAdjustmentRequest

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.offer.PendingSubscriptionItemAdjustmentRemoval

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PeriodDefinition

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChange

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.PriceDataChangeRequest

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.pricing.PriceChangeRequest

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Product

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.ProductOption

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.RemovedAdjustment

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SpecificItemChoice

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Subscription

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAction

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionActionPriceDetail

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItem

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustment

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemAdjustmentPriceDetail

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionItemPriceDetail

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionOwnerInfo

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPeriod

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPriceResponse

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionPricingContext

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.SubscriptionWithItems

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.UserSubscriptionSummary

toString() - Method in class com.broadleafcommerce.subscriptionoperation.domain.Variant

toString() - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationJpaProperties

toString() - Method in class com.broadleafcommerce.subscriptionoperation.provider.jpa.environment.SubscriptionOperationProviderProperties

toString() - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SSLVerificationProperties

Deprecated.

toString() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCancellationPolicyProviderProperties

toString() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCatalogProviderProperties

toString() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalCustomerProviderProperties

toString() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOfferProviderProperties

toString() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalOrderProviderProperties

toString() - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProperties

toString() - Method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionPricingProperties

toString() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.AddItemRequest

toString() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.BulkPriceUpdateSubscriptionRequest

toString() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateCartRequest

toString() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.CreateSubscriptionFromOrderRequest

toString() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyRequest

toString() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.IdentifyCancellationPolicyResponse

toString() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionRequest

toString() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.ModifySubscriptionResponse

toString() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.PriceCartRequest

toString() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionRequest

toString() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionActionResponse

toString() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionCreationRequest

toString() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.SubscriptionItemCreationRequest

toString() - Method in class com.broadleafcommerce.subscriptionoperation.web.domain.UpdateSubscriptionStatusRequest

truncateToBeginningOfDay(Instant, String) - Static method in class com.broadleafcommerce.subscriptionoperation.service.SubscriptionDateUtils

Truncates the given Instant to ChronoUnit.DAYS in the specified timezone.

U

UNIT_CHARGE_FOR_PREVIOUSLY_DISCOUNTED_PERIODS - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

The subscription item discount per unit to be deducted from the DefaultSubscriptionPriceDetailType.PRIOR_UNBILLED_UNIT_AMOUNT.

UNLOCKED - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.LockState

The resource has been unlocked

unlockToken(String, String, boolean) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

unlockToken(String, String, boolean) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.ExternalSubscriptionProvider

unlockToken(String, String, boolean) - Method in interface com.broadleafcommerce.subscriptionoperation.service.provider.SubscriptionProvider

Unlock a child lock identified by a token

unlockToken(String, String, boolean) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

Unlock a child lock on a subscription.

unlockToken(String, String, boolean) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

Unlock a child lock on a subscription.

UnsupportedSubscriptionModificationRequestException - Exception in com.broadleafcommerce.subscriptionoperation.service.exception

Thrown when a request is made to modify a Subscription that has no matching ModifySubscriptionHandler.

UnsupportedSubscriptionModificationRequestException(ModifySubscriptionRequest) - Constructor for exception com.broadleafcommerce.subscriptionoperation.service.exception.UnsupportedSubscriptionModificationRequestException

updateAdjustmentQualifierDetailRefs(List<SWI>, CreateSubscriptionFromOrderRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionGenerationService

Updates the SubscriptionItemAdjustment.getQualifierDetails() to map to the actual created SubscriptionItem.getId().

updatePriceData(String, PriceChangeRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

updatePriceData(String, PriceChangeRequest, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

updatePriceData(String, PriceChangeRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

updateSubscriptionAutoRenewal(ModifySubscriptionRequest, Subscription, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

updateSubscriptionStatus(UpdateSubscriptionStatusRequest, boolean, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionOperationService

updateSubscriptionStatus(UpdateSubscriptionStatusRequest, boolean, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionOperationService

Handles updating the Subscription's status.

updateSubscriptionStatus(String, boolean, UpdateSubscriptionStatusRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

UpdateSubscriptionStatusRequest - Class in com.broadleafcommerce.subscriptionoperation.web.domain

Represents a request to modify a subscription's status.

UpdateSubscriptionStatusRequest() - Constructor for class com.broadleafcommerce.subscriptionoperation.web.domain.UpdateSubscriptionStatusRequest

UPGRADE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

A request to upgrade the subscription's level of service

UPGRADE - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionType

A request to upgrade the subscription's level of service

UPGRADE_OPTIONS_ATTR - Static variable in class com.broadleafcommerce.subscriptionoperation.domain.constants.SubscriptionActionConstants

Name of the attribute on SubscriptionAction.getActionInfo() that stores the available upgrade options for a Subscription for action type of DefaultSubscriptionActionType.UPGRADE.

uriVars(Object...) - Method in class com.broadleafcommerce.subscriptionoperation.service.provider.external.AbstractExternalProvider

Convenience method to generate a map of variables.

UserSubscriptionSummary - Class in com.broadleafcommerce.subscriptionoperation.domain

Holds summary of the former and current subscriptions purchased by a user.

UserSubscriptionSummary() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.UserSubscriptionSummary

userSubscriptionSummaryService - Variable in class com.broadleafcommerce.subscriptionoperation.web.endpoint.SubscriptionOperationEndpoint

userSubscriptionSummaryService(TypeFactory, SubscriptionProvider<SubscriptionWithItems, Subscription, SubscriptionOwnerInfo>, SubscriptionOperationServiceProperties, SubscriptionModificationUtils) - Method in class com.broadleafcommerce.subscriptionoperation.service.autoconfigure.SubscriptionOperationServiceAutoConfiguration

UserSubscriptionSummaryService<U extends UserSubscriptionSummary,SWI extends SubscriptionWithItems> - Interface in com.broadleafcommerce.subscriptionoperation.service

Service for operations on UserSubscriptionSummary

V

validateAccess(String[], String, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionAccessValidationService

validateAccess(String[], String, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionAccessValidationService

Validates whether the current user is restricted to certain subscriptions only.

validateActionType(ModifySubscriptionRequest, Errors, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

Validates the requested action against the resolved subscription's available actions.

validateAdditionalPermissionRules(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

Hook point to supply additional permission validation logic.

validateAutoRenewalCanBeDisabled(ModifySubscriptionRequest, SubscriptionWithItems, Errors, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

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

validateAutoRenewalCanBeEnabled(ModifySubscriptionRequest, SubscriptionWithItems, Errors, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

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

validateBusinessRules(ModifySubscriptionRequest, Errors, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

Hook point to supply custom business rules for specific action types.

validateBusinessRules(ModifySubscriptionRequest, Errors, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.ChangeSubscriptionAutoRenewalHandler

validateBusinessRules(ModifySubscriptionRequest, Errors, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateCancelSubscriptionHandler

validateBusinessRules(ModifySubscriptionRequest, Errors, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateDowngradeSubscriptionHandler

validateBusinessRules(ModifySubscriptionRequest, Errors, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateEditSubscriptionHandler

validateBusinessRules(ModifySubscriptionRequest, Errors, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.InitiateUpgradeSubscriptionHandler

validateCurrentSubscriptionState(ModifySubscriptionRequest, Errors, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

Validates the current state of the subscription before allowing modification.

validateRequest(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

Validates the request to modify the subscription.

validateStatusChange(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.status.ActiveSubscriptionStatusHandler

validateStatusChange(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.status.CanceledSubscriptionStatusHandler

validateStatusChange(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.status.FulfillmentInProcessSubscriptionStatusHandler

validateStatusChange(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.status.PausedSubscriptionStatusHandler

validateStatusChange(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.status.PendingCancellationSubscriptionStatusHandler

validateStatusChange(UpdateSubscriptionStatusRequest, SWI, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.status.SubscriptionStatusHandler

Validates that the UpdateSubscriptionStatusRequest.getRequestedStatus() is a valid next status of the Subscription.

validateSubscriptionCreation(SubscriptionCreationRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionValidationService

validateSubscriptionCreation(SubscriptionCreationRequest, ContextInfo) - Method in interface com.broadleafcommerce.subscriptionoperation.service.SubscriptionValidationService

Validates the creation of a subscription.

validateUserAccessToSubscription(ModifySubscriptionRequest, ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.modification.AbstractModifySubscriptionHandler

Validates the user's access to the subscription.

validateUserPermissions(String[], ContextInfo) - Method in class com.broadleafcommerce.subscriptionoperation.service.DefaultSubscriptionAccessValidationService

Validates whether the current user has the exact permission based on ContextInfo.getOperationType() to perform the operation.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultAdjustmentOwnerType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultCancellationChargeStrategy

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultCancellationStrategy

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultDelayedSubscriptionActionEffectiveType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultDelayedSubscriptionActionType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceSelectionType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceTargetType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultPriceChangeEffectiveType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultPriceChangeScopeType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultProductOptionType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultShortenedPeriodReason

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSpecificItemChoiceType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionAdjustmentType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionItemReferenceType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionNextStatusChangeReason

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionPaymentStrategy

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionPeriodType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionSourceType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultTermDurationType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultUserRefTypes

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.EndOfTermStrategy

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.LockState

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.offer.type.AdjustmentApplicationDateType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.pricing.type.PriceDataApplicationDateType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.pricing.type.PriceDataAppliesToType

Returns the enum constant of this class with the specified name.

valueOf(String) - Static method in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

Returns the enum constant of this class with the specified name.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultAdjustmentOwnerType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultCancellationChargeStrategy

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultCancellationStrategy

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultDelayedSubscriptionActionEffectiveType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultDelayedSubscriptionActionType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceSelectionType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultItemChoiceTargetType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultPriceChangeEffectiveType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultPriceChangeScopeType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultProductOptionType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultShortenedPeriodReason

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSpecificItemChoiceType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionFlow

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionActionUnavailableReasons

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionAdjustmentType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionItemReferenceType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionNextStatusChangeReason

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionPaymentStrategy

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionPeriodType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSubscriptionSourceType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultTermDurationType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultUserRefTypes

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.EndOfTermStrategy

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.SubscriptionStatuses

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.LockState

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.offer.type.AdjustmentApplicationDateType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.pricing.type.PriceDataApplicationDateType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.domain.pricing.type.PriceDataAppliesToType

Returns an array containing the constants of this enum class, in the order they are declared.

values() - Static method in enum class com.broadleafcommerce.subscriptionoperation.service.enums.DefaultSubscriptionPriceDetailType

Returns an array containing the constants of this enum class, in the order they are declared.

Variant - Class in com.broadleafcommerce.subscriptionoperation.domain

Variants can help further identify the specifics of a Product by narrowing down the Sku via additional user data.

Variant() - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.Variant

Variant(String, String, String, String, String, String, Instant, Instant, MonetaryAmount, MonetaryAmount, MonetaryAmount, boolean, boolean, String, Map<String, String>, String, String, Integer, Integer, ContextState, String, ChangeContainer) - Constructor for class com.broadleafcommerce.subscriptionoperation.domain.Variant

Creates a new Variant instance.

VARIANT - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultSpecificItemChoiceType

VARIANT_DISTINGUISHING - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultProductOptionType

Values selected by the customer will help distinguish a specific variant directly on this Product that should be added to the cart.

W

WEEKS - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultTermDurationType

WorkflowContextConstants - Class in com.broadleafcommerce.subscriptionoperation.domain.constants

WorkflowContextConstants.AddAdjustmentWorkflow - Class in com.broadleafcommerce.subscriptionoperation.domain.constants

Y

YEARS - Enum constant in enum class com.broadleafcommerce.subscriptionoperation.domain.enums.DefaultTermDurationType

A B C D E F G H I L M N O P Q R S T U V W Y
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form