Package com.broadleafcommerce.subscriptionoperation.domain

Class ExistingSubscriptionDetails

java.lang.Object

com.broadleafcommerce.subscriptionoperation.domain.ExistingSubscriptionDetails

All Implemented Interfaces:

Serializable

public class ExistingSubscriptionDetails
extends Object
implements Serializable

Contains details describing an existing Subscription when entering a modify-subscription flow such as for edit, upgrade, or downgrade. This is stored on the created Cart for use by downstream systems that handle fulfillment like Order Operations Service in comparing the subscription before and after the modifications.

Author:

karanjariwala

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExistingSubscriptionDetails()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
Map<String,Object>	getAttributes()	Additional attributes to include.
Integer	getCurrentPeriod()	The subscription's current period
List<DelayedSubscriptionAction>	getDelayedActions()	List of delayed actions for this subscription.
List<ExistingSubscriptionAdjustmentDetail>	getExistingAdjustmentDetails()
List<ExistingSubscriptionItemDetail>	getExistingItemDetails()	ExistingSubscriptionItemDetail for each SubscriptionItem on the existing Subscription.
String	getPaymentStrategy()	Declares that payments made against a subscription are going towards the goods/services rendered in the previous vs current period.
int	getPeriodFrequency()	The frequency with which the recurring price should be charged., e.g., a value of 1 combined with periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.
String	getPeriodType()	The period type for the price, e.g.
String	getRootSubscriptionItemId()	ID of the root SubscriptionItem.
String	getSubscriptionId()
int	hashCode()
void	setAttributes(Map<String,Object> attributes)	Additional attributes to include.
void	setCurrentPeriod(Integer currentPeriod)	The subscription's current period
void	setDelayedActions(List<DelayedSubscriptionAction> delayedActions)	List of delayed actions for this subscription.
void	setExistingAdjustmentDetails(List<ExistingSubscriptionAdjustmentDetail> existingAdjustmentDetails)
void	setExistingItemDetails(List<ExistingSubscriptionItemDetail> existingItemDetails)	ExistingSubscriptionItemDetail for each SubscriptionItem on the existing Subscription.
void	setPaymentStrategy(String paymentStrategy)	Declares that payments made against a subscription are going towards the goods/services rendered in the previous vs current period.
void	setPeriodFrequency(int periodFrequency)	The frequency with which the recurring price should be charged., e.g., a value of 1 combined with periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.
void	setPeriodType(String periodType)	The period type for the price, e.g.
void	setRootSubscriptionItemId(String rootSubscriptionItemId)	ID of the root SubscriptionItem.
void	setSubscriptionId(String subscriptionId)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

ExistingSubscriptionDetails

public ExistingSubscriptionDetails()

Method Details

getSubscriptionId

public String getSubscriptionId()

See Also:

• Subscription.getId()

getRootSubscriptionItemId

public String getRootSubscriptionItemId()

ID of the root SubscriptionItem.

getCurrentPeriod

public Integer getCurrentPeriod()

The subscription's current period

getPeriodFrequency

public int getPeriodFrequency()

The frequency with which the recurring price should be charged., e.g., a value of 1 combined with periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.

See Also:

• periodType

getPeriodType

public String getPeriodType()

The period type for the price, e.g. MONTHLY, QUARTERLY, ANNUALLY

See Also:

• periodFrequency

getPaymentStrategy

public String getPaymentStrategy()

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

See Also:

• DefaultSubscriptionPaymentStrategy

getDelayedActions

public List<DelayedSubscriptionAction> getDelayedActions()

List of delayed actions for this subscription.

Often, these delayed actions are related to requested actions against a subscription with a DefaultSubscriptionPaymentStrategy.PREPAID Subscription.getPaymentStrategy() where instead of refunding the customer, the action is delayed until the end of the period, causing the next period to naturally identify the updated price.

getExistingItemDetails

public List<ExistingSubscriptionItemDetail> getExistingItemDetails()

ExistingSubscriptionItemDetail for each SubscriptionItem on the existing Subscription.

getExistingAdjustmentDetails

public List<ExistingSubscriptionAdjustmentDetail> getExistingAdjustmentDetails()

See Also:

• Subscription.getSubscriptionAdjustments()

getAttributes

public Map<String,Object> getAttributes()

Additional attributes to include.

setSubscriptionId

public void setSubscriptionId(String subscriptionId)

See Also:

• Subscription.getId()

setRootSubscriptionItemId

public void setRootSubscriptionItemId(String rootSubscriptionItemId)

ID of the root SubscriptionItem.

setCurrentPeriod

public void setCurrentPeriod(Integer currentPeriod)

The subscription's current period

setPeriodFrequency

public void setPeriodFrequency(int periodFrequency)

The frequency with which the recurring price should be charged., e.g., a value of 1 combined with periodType of MONTH would indicate to a subscription service that the price should be charged every 1 month.

See Also:

• periodType

setPeriodType

public void setPeriodType(String periodType)

The period type for the price, e.g. MONTHLY, QUARTERLY, ANNUALLY

See Also:

• periodFrequency

setPaymentStrategy

public void setPaymentStrategy(String paymentStrategy)

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

See Also:

• DefaultSubscriptionPaymentStrategy

setDelayedActions

public void setDelayedActions(List<DelayedSubscriptionAction> delayedActions)

List of delayed actions for this subscription.

Often, these delayed actions are related to requested actions against a subscription with a DefaultSubscriptionPaymentStrategy.PREPAID Subscription.getPaymentStrategy() where instead of refunding the customer, the action is delayed until the end of the period, causing the next period to naturally identify the updated price.

setExistingItemDetails

public void setExistingItemDetails(List<ExistingSubscriptionItemDetail> existingItemDetails)

ExistingSubscriptionItemDetail for each SubscriptionItem on the existing Subscription.

setExistingAdjustmentDetails

public void setExistingAdjustmentDetails(List<ExistingSubscriptionAdjustmentDetail> existingAdjustmentDetails)

See Also:

• Subscription.getSubscriptionAdjustments()

setAttributes

public void setAttributes(Map<String,Object> attributes)

Additional attributes to include.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object