Package de.hybris.platform.subscriptionservices.price

Interface SubscriptionCommercePriceService

All Superinterfaces:

CommercePriceService

All Known Implementing Classes:

DefaultSubscriptionCommercePriceService

public interface SubscriptionCommercePriceService
extends CommercePriceService

Extends the CommercePriceService in order to retrieve the applicable SubscriptionPricePlanModel for a product as the CommercePriceService returns the price information only. The standard filtering functionality for PriceRowModels of the active PriceFactory is used.

Spring Bean ID:

subscriptionCommercePriceService

Method Summary

Modifier and Type	Method	Description
RecurringChargeEntryModel	getFirstRecurringPriceFromPlan(SubscriptionPricePlanModel pricePlan)	Returns the first recurring price of the given SubscriptionPricePlanModel.
RecurringChargeEntryModel	getLastRecurringPriceFromPlan(SubscriptionPricePlanModel pricePlan)	Returns the last recurring price of the given SubscriptionPricePlanModel.
OneTimeChargeEntryModel	getOneTimeChargeEntryPlan(SubscriptionPricePlanModel pricePlan, BillingEventModel billingEvent)	Returns the one time charge entry of the given SubscriptionPricePlanModel.
SubscriptionPricePlanModel	getSubscriptionPricePlanForEntry(AbstractOrderEntryModel entry)	Search a SubscriptionPricePlanModel for the given entry's product.
default SubscriptionPricePlanModel	getSubscriptionPricePlanForProduct(ProductModel subscriptionProduct)	Search a SubscriptionPricePlanModel for the given subscriptionProduct.

Methods inherited from interface de.hybris.platform.commerceservices.price.CommercePriceService

getFromPriceForProduct, getWebPriceForProduct

Method Detail

getSubscriptionPricePlanForProduct

@Nullable
default SubscriptionPricePlanModel getSubscriptionPricePlanForProduct(@Nonnull
                                                                      ProductModel subscriptionProduct)

Search a SubscriptionPricePlanModel for the given subscriptionProduct.

Parameters:

subscriptionProduct - the SubscriptionProductModel

Returns:

the applicable SubscriptionPricePlanModel or null

getSubscriptionPricePlanForEntry

@Nullable
SubscriptionPricePlanModel getSubscriptionPricePlanForEntry(AbstractOrderEntryModel entry)

Search a SubscriptionPricePlanModel for the given entry's product.

Parameters:

entry - the AbstractOrderEntryModel

Returns:

the applicable SubscriptionPricePlanModel or null

getFirstRecurringPriceFromPlan

@Nullable
RecurringChargeEntryModel getFirstRecurringPriceFromPlan(@Nullable
                                                         SubscriptionPricePlanModel pricePlan)

Returns the first recurring price of the given SubscriptionPricePlanModel. It is assumed that the recurring prices are sorted in a way so that the price increases as time goes by. Therefore, the returned recurring price is the lowest price. If price logic is different this function must be overridden.

Parameters:

pricePlan - SubscriptionPricePlanModel

Returns:

the first recurring price of the given pricePlan or null

getLastRecurringPriceFromPlan

@Nullable
RecurringChargeEntryModel getLastRecurringPriceFromPlan(@Nullable
                                                        SubscriptionPricePlanModel pricePlan)

Returns the last recurring price of the given SubscriptionPricePlanModel. It is assumed that the recurring prices are sorted in a way so that the price increases as time goes by. Therefore, the returned recurring price is the highest price. If price logic is different this function must be overridden.

Parameters:

pricePlan - SubscriptionPricePlanModel

Returns:

the last recurring price of the given pricePlan or null

getOneTimeChargeEntryPlan

@Nullable
OneTimeChargeEntryModel getOneTimeChargeEntryPlan(@Nonnull
                                                  SubscriptionPricePlanModel pricePlan,
                                                  @Nonnull
                                                  BillingEventModel billingEvent)

Returns the one time charge entry of the given SubscriptionPricePlanModel.

Parameters:

pricePlan - SubscriptionPricePlanModel

billingEvent - BillingEventModel

Returns:

the OneTimeChargeEntry