com.broadleafcommerce.subscription.domain.catalog

Interface SubscriptionSku

All Superinterfaces:

Serializable

All Known Implementing Classes:

SkuImplTemplate, SubscriptionSkuImpl

public interface SubscriptionSku
extends Serializable

Author:

Priyesh Patel

Method Summary

Modifier and Type	Method and Description
BillingFrequencyType	getBillingFrequencyType() Returns the billing frequency type of this SKU.
Boolean	getIsFutureStartDate()
Boolean	getIsSubscription() Returns whether this sku represents a subscription sku
Boolean	getIsTrial() Returns whether this sku represents a subscription trial
org.broadleafcommerce.core.catalog.domain.Sku	getPaidSubscription() Returns the sku that this subscription trial will become
org.broadleafcommerce.core.catalog.domain.Sku	getSku() Returns the related parent SKU for this embeddable object.
Integer	getTrialPeriodDays() Returns the number of days this subscription trial lasts
String	getUpgradeFamily()
Integer	getUpgradeLevel() The upgrade level can be used by implementations to indicate whether a given SKU represents an upgrade or downgrade within a SubscriptionProduct.getUpgradeFamilyType()
void	setBillingFrequencyType(BillingFrequencyType billingFrequencyType) Sets the billing frequency type of this SKU.
void	setFutureStartDate(Boolean isFutureStartDate)
void	setIsSubscription(Boolean isSubscription) Sets whether this sku represents a subscription sku
void	setIsTrial(Boolean isTrial) Sets whether this sku represents a subscription trial
void	setPaidSubscription(org.broadleafcommerce.core.catalog.domain.Sku paidSubscription) Sets the sku that this subscription trial will become
void	setSku(org.broadleafcommerce.core.catalog.domain.Sku sku) Sets the related parent SKU for this embeddable object
void	setTrialPeriodDays(Integer trialPeriodDays) Sets the number of days this subscription trial lasts
void	setUpgradeLevel(Integer upgradeLevel) Returns the upgrade level for this SKU

Method Detail

getUpgradeLevel

Integer getUpgradeLevel()

The upgrade level can be used by implementations to indicate whether a given SKU represents an upgrade or downgrade within a SubscriptionProduct.getUpgradeFamilyType()

Returns:

setUpgradeLevel

void setUpgradeLevel(Integer upgradeLevel)

Returns the upgrade level for this SKU

Parameters:

upgradeLevel -

See Also:

getUpgradeLevel()

getUpgradeFamily

String getUpgradeFamily()

getSku

org.broadleafcommerce.core.catalog.domain.Sku getSku()

Returns the related parent SKU for this embeddable object.

Returns:

setSku

void setSku(org.broadleafcommerce.core.catalog.domain.Sku sku)

Sets the related parent SKU for this embeddable object

Parameters:

sku -

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:

setBillingFrequencyType

void setBillingFrequencyType(BillingFrequencyType billingFrequencyType)

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

Parameters:

billingFrequencyType -

getIsSubscription

Boolean getIsSubscription()

Returns whether this sku represents a subscription sku

Returns:

setIsSubscription

void setIsSubscription(Boolean isSubscription)

Sets whether this sku represents a subscription sku

Parameters:

isSubscription -

getIsTrial

Boolean getIsTrial()

Returns whether this sku represents a subscription trial

Returns:

setIsTrial

void setIsTrial(Boolean isTrial)

Sets whether this sku represents a subscription trial

Parameters:

isTrial -

getTrialPeriodDays

Integer getTrialPeriodDays()

Returns the number of days this subscription trial lasts

Returns:

setTrialPeriodDays

void setTrialPeriodDays(Integer trialPeriodDays)

Sets the number of days this subscription trial lasts

Parameters:

trialPeriodDays -

getPaidSubscription

org.broadleafcommerce.core.catalog.domain.Sku getPaidSubscription()

Returns the sku that this subscription trial will become

Returns:

setPaidSubscription

void setPaidSubscription(org.broadleafcommerce.core.catalog.domain.Sku paidSubscription)

Sets the sku that this subscription trial will become

Parameters:

paidSubscription -

getIsFutureStartDate

Boolean getIsFutureStartDate()

setFutureStartDate

void setFutureStartDate(Boolean isFutureStartDate)