com.broadleafcommerce.subscription.domain.catalog

Interface SubscriptionProduct

All Superinterfaces:

Serializable

All Known Implementing Classes:

ProductImplTemplate, SubscriptionProductImpl

public interface SubscriptionProduct
extends Serializable

Interface for adding subscription properties to a product.

Author:

bpolster

Method Summary

Modifier and Type	Method and Description
BillingFrequencyType	getBillingFrequencyType() Returns the billing frequency type of this SKU.
Boolean	getSubscription()
boolean	getUpgradeable() Returns true if this product is upgradable.
String	getUpgradeFamilyType() This property returns the upgrade family for products that are upgradable.
void	setBillingFrequencyType(BillingFrequencyType billingFrequencyType)
void	setSubscription(Boolean subscription)
void	setUpgradeable(boolean upgradeable) Set whether or not this product is upgradable.
void	setUpgradeFamilyType(String upgradeFamilyType) Set the upgrade family type.

Method Detail

getUpgradeable

boolean getUpgradeable()

Returns true if this product is upgradable.

Returns:

setUpgradeable

void setUpgradeable(boolean upgradeable)

Set whether or not this product is upgradable.

Parameters:

isUpgradeable -

getUpgradeFamilyType

String getUpgradeFamilyType()

This property returns the upgrade family for products that are upgradable.

Returns:

setUpgradeFamilyType

void setUpgradeFamilyType(String upgradeFamilyType)

Set the upgrade family type. Used to denote a product relation to other products to which this subscription product can be upgraded or down graded. Systems can manage upgrade levels by allowing

Parameters:

upgradeFamilyType -

See Also:

SubscriptionSku#getUpgradeLevel()}

getBillingFrequencyType

BillingFrequencyType getBillingFrequencyType()

Returns the billing frequency type of this SKU. If the SKU contains an attribute of type BillingFrequencyType then that value will be returned. Otherwise, defaults to the BillingFrequencyType from the parent SubscriptionProduct Allows a Product to have a set of SKUs for different billing frequencies.

Returns:

getSubscription

Boolean getSubscription()

setSubscription

void setSubscription(Boolean subscription)

setBillingFrequencyType

void setBillingFrequencyType(BillingFrequencyType billingFrequencyType)