Package com.broadleafcommerce.subscriptionoperation.domain

Class ExistingAdjustmentDetail

java.lang.Object

com.broadleafcommerce.subscriptionoperation.domain.ExistingAdjustmentDetail

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

ExistingSubscriptionAdjustmentDetail, ExistingSubscriptionItemAdjustmentDetail

public class ExistingAdjustmentDetail
extends Object
implements Serializable

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

This is helpful to avoid any existing adjustments from being lost after modifying a subscription.

Author:

Sunny Yu

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ExistingAdjustmentDetail()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getAdjustmentName()
String	getAdjustmentRef()
Map<String,Object>	getAttributes()	Additional attributes to include.
Integer	getBeginPeriod()
String	getDiscountType()
Integer	getEndPeriod()
Instant	getFreeTrialEndDate()	The end date of the free trial for this subscription, if applicable, null if none applied.
String	getId()
int	getPeriodsAlreadyUsed()	Represents the number of periods this adjustment has already been used.
int	hashCode()
void	setAdjustmentName(String adjustmentName)
void	setAdjustmentRef(String adjustmentRef)
void	setAttributes(Map<String,Object> attributes)	Additional attributes to include.
void	setBeginPeriod(Integer beginPeriod)
void	setDiscountType(String discountType)
void	setEndPeriod(Integer endPeriod)
void	setFreeTrialEndDate(Instant freeTrialEndDate)	The end date of the free trial for this subscription, if applicable, null if none applied.
void	setId(String id)
void	setPeriodsAlreadyUsed(int periodsAlreadyUsed)	Represents the number of periods this adjustment has already been used.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

ExistingAdjustmentDetail

public ExistingAdjustmentDetail()

Method Details

getId

public String getId()

getAdjustmentRef

public String getAdjustmentRef()

See Also:

• Adjustment.getAdjustmentRef()

getAdjustmentName

public String getAdjustmentName()

See Also:

• Adjustment.getAdjustmentName()

getDiscountType

public String getDiscountType()

See Also:

• Adjustment.getDiscountType()

getBeginPeriod

public Integer getBeginPeriod()

See Also:

• Adjustment.getBeginPeriod()

getEndPeriod

@Nullable
public Integer getEndPeriod()

See Also:

• Adjustment.getEndPeriod()

getFreeTrialEndDate

@Nullable
public Instant getFreeTrialEndDate()

The end date of the free trial for this subscription, if applicable, null if none applied.

This is an easy way to determine if a subscription is in a free trial period without having to calculate from the adjustment.

getPeriodsAlreadyUsed

public int getPeriodsAlreadyUsed()

Represents the number of periods this adjustment has already been used. This is helpful to determine if the adjustment has any remaining periods.

getAttributes

public Map<String,Object> getAttributes()

Additional attributes to include.

setId

public void setId(String id)

setAdjustmentRef

public void setAdjustmentRef(String adjustmentRef)

See Also:

• Adjustment.getAdjustmentRef()

setAdjustmentName

public void setAdjustmentName(String adjustmentName)

See Also:

• Adjustment.getAdjustmentName()

setDiscountType

public void setDiscountType(String discountType)

See Also:

• Adjustment.getDiscountType()

setBeginPeriod

public void setBeginPeriod(Integer beginPeriod)

See Also:

• Adjustment.getBeginPeriod()

setEndPeriod

public void setEndPeriod(@Nullable
 Integer endPeriod)

See Also:

• Adjustment.getEndPeriod()

setFreeTrialEndDate

public void setFreeTrialEndDate(@Nullable
 Instant freeTrialEndDate)

The end date of the free trial for this subscription, if applicable, null if none applied.

This is an easy way to determine if a subscription is in a free trial period without having to calculate from the adjustment.

setPeriodsAlreadyUsed

public void setPeriodsAlreadyUsed(int periodsAlreadyUsed)

Represents the number of periods this adjustment has already been used. This is helpful to determine if the adjustment has any remaining periods.

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