Package com.broadleafcommerce.subscriptionoperation.domain

Class SubscriptionAdjustment

java.lang.Object

com.broadleafcommerce.subscriptionoperation.domain.SubscriptionAdjustment

All Implemented Interfaces:

com.broadleafcommerce.data.tracking.core.ContextStateAware, Adjustment, Serializable

public class SubscriptionAdjustment
extends Object
implements Adjustment, com.broadleafcommerce.data.tracking.core.ContextStateAware

This is a representation of a price adjustment for a Subscription

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SubscriptionAdjustment()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BigDecimal	getAdjustmentAmount()	Adjustment amount applied to the unit price of the target item.
String	getAdjustmentCartLabel()	Friendly label to display in the cart or to a customer in general instead of the Adjustment.getAdjustmentName().
String	getAdjustmentCodeRef()	A reference to the Offer Code (if any).
String	getAdjustmentDescription()	A description of what benefits the adjustment provides to a customer.
BigDecimal	getAdjustmentDiscountFactor()	The discount factor by which to discount a target.
String	getAdjustmentDiscountMethodType()	Determines the method used to apply the discount.
String	getAdjustmentName()	Name of the adjustment applied.
String	getAdjustmentProrationType()	Determines how an adjustment's discount amount is distributed across the adjustment's related item types.
String	getAdjustmentRef()	Reference to the promotion or offer that drives this adjustment
Integer	getBeginPeriod()	Number of the billing period this adjustment starts being active
String	getCampaignTrackingId()	The campaign tracking id (if any) for this adjustment.
String	getCodeUsed()	The code used (if any) that triggered the application of the adjustment for this adjustment.
com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState	getContextState()	A subset of Tracking information to expose the context state for this object.
String	getDiscountType()	Defines the type of the discount, e.g., free trial, order discount, future credit, etc.
Integer	getEndPeriod()	Number of the billing period this adjustment stops.
Integer	getFreeTrialLength()	If Adjustment.getDiscountType() is FREE_TRIAL, then this defines the free trial's length.
String	getFreeTrialLengthUnits()	If Adjustment.getDiscountType() is FREE_TRIAL, then this defines the units for Adjustment.getFreeTrialLength().
String	getId()
String	getOwnerId()	Identifier for the subscription entity that owns this adjustment, e.g., the Subscription ID.
String	getOwnerType()	The type of subscription entity that owns this adjustment, e.g., DefaultAdjustmentOwnerType.SUBSCRIPTION.
String	getSubscriptionAdjustmentType()	Type of adjustment that this adds
String	getSubscriptionId()	Reference to the Subscription whose price this adjusts
int	hashCode()
void	setAdjustmentAmount(BigDecimal adjustmentAmount)
void	setAdjustmentCartLabel(String adjustmentCartLabel)
void	setAdjustmentCodeRef(String adjustmentCodeRef)
void	setAdjustmentDescription(String adjustmentDescription)
void	setAdjustmentDiscountFactor(BigDecimal adjustmentDiscountFactor)
void	setAdjustmentDiscountMethodType(String adjustmentDiscountMethodType)
void	setAdjustmentName(String adjustmentName)
void	setAdjustmentProrationType(String adjustmentProrationType)
void	setAdjustmentRef(String adjustmentRef)
void	setBeginPeriod(Integer beginPeriod)
void	setCampaignTrackingId(String campaignTrackingId)
void	setCodeUsed(String codeUsed)
void	setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)	A subset of Tracking information to expose the context state for this object.
void	setDiscountType(String discountType)
void	setEndPeriod(Integer endPeriod)
void	setFreeTrialLength(Integer freeTrialLength)
void	setFreeTrialLengthUnits(String freeTrialLengthUnits)
void	setId(String id)
void	setSubscriptionAdjustmentType(String subscriptionAdjustmentType)
void	setSubscriptionId(String subscriptionId)	Reference to the Subscription whose price this adjusts
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.broadleafcommerce.subscriptionoperation.domain.Adjustment

getAdjustmentQuantity

Constructor Details

SubscriptionAdjustment

public SubscriptionAdjustment()

Method Details

getOwnerId

public String getOwnerId()

Description copied from interface: Adjustment

Identifier for the subscription entity that owns this adjustment, e.g., the Subscription ID.

Specified by:

getOwnerId in interface Adjustment

Returns:

Identifier for the subscription entity that owns this adjustment, e.g., the Subscription ID.

See Also:

• Adjustment.getOwnerId()

getOwnerType

public String getOwnerType()

Description copied from interface: Adjustment

The type of subscription entity that owns this adjustment, e.g., DefaultAdjustmentOwnerType.SUBSCRIPTION.

Specified by:

getOwnerType in interface Adjustment

Returns:

The type of subscription entity that owns this adjustment, e.g., DefaultAdjustmentOwnerType.SUBSCRIPTION.

See Also:

• Adjustment.getOwnerType()

getId

public String getId()

getSubscriptionId

public String getSubscriptionId()

Reference to the Subscription whose price this adjusts

getAdjustmentRef

public String getAdjustmentRef()

Description copied from interface: Adjustment

Reference to the promotion or offer that drives this adjustment

Specified by:

getAdjustmentRef in interface Adjustment

Returns:

Reference to the promotion or offer that drives this adjustment

See Also:

• Adjustment.getAdjustmentRef()

getSubscriptionAdjustmentType

public String getSubscriptionAdjustmentType()

Description copied from interface: Adjustment

Type of adjustment that this adds

Specified by:

getSubscriptionAdjustmentType in interface Adjustment

Returns:

Type of adjustment that this adds

See Also:

• Adjustment.getSubscriptionAdjustmentType()

getAdjustmentAmount

public BigDecimal getAdjustmentAmount()

Description copied from interface: Adjustment

Adjustment amount applied to the unit price of the target item.

Specified by:

getAdjustmentAmount in interface Adjustment

Returns:

Amount of the price adjustment

See Also:

• Adjustment.getAdjustmentAmount()

getBeginPeriod

public Integer getBeginPeriod()

Description copied from interface: Adjustment

Number of the billing period this adjustment starts being active

Specified by:

getBeginPeriod in interface Adjustment

Returns:

Number of the billing period this adjustment starts being active

See Also:

• Adjustment.getBeginPeriod()

getEndPeriod

public Integer getEndPeriod()

Description copied from interface: Adjustment

Number of the billing period this adjustment stops. If this field is null, the adjustment is considered indefinite

Specified by:

getEndPeriod in interface Adjustment

Returns:

Number of the billing period this adjustment stops. If this field is null, the adjustment is considered indefinite

See Also:

• Adjustment.getEndPeriod()

getAdjustmentName

public String getAdjustmentName()

Description copied from interface: Adjustment

Name of the adjustment applied.

Specified by:

getAdjustmentName in interface Adjustment

Returns:

Name of the adjustment applied.

See Also:

• Adjustment.getAdjustmentName()

getAdjustmentCartLabel

public String getAdjustmentCartLabel()

Description copied from interface: Adjustment

Friendly label to display in the cart or to a customer in general instead of the Adjustment.getAdjustmentName().

Specified by:

getAdjustmentCartLabel in interface Adjustment

Returns:

Friendly label to display in the cart or to a customer in general instead of the Adjustment.getAdjustmentName().

See Also:

• Adjustment.getAdjustmentCartLabel()

getAdjustmentDescription

public String getAdjustmentDescription()

Description copied from interface: Adjustment

A description of what benefits the adjustment provides to a customer.

Specified by:

getAdjustmentDescription in interface Adjustment

Returns:

A description of what benefits the adjustment provides to a customer.

See Also:

• Adjustment.getAdjustmentDescription()

getAdjustmentProrationType

public String getAdjustmentProrationType()

Description copied from interface: Adjustment

Determines how an adjustment's discount amount is distributed across the adjustment's related item types. This can either be set to prorate across target items or target and qualifier items.

Specified by:

getAdjustmentProrationType in interface Adjustment

Returns:

Determines how an adjustment's discount amount is distributed across the adjustment's related item types. This can either be set to prorate across target items or target and qualifier items.

See Also:

• Adjustment.getAdjustmentProrationType()

getAdjustmentCodeRef

public String getAdjustmentCodeRef()

Description copied from interface: Adjustment

A reference to the Offer Code (if any).

Specified by:

getAdjustmentCodeRef in interface Adjustment

Returns:

A reference to the Offer Code (if any).

See Also:

• Adjustment.getAdjustmentCodeRef()

getAdjustmentDiscountMethodType

public String getAdjustmentDiscountMethodType()

Description copied from interface: Adjustment

Determines the method used to apply the discount. Typically in Broadleaf, the Adjustment.getSubscriptionAdjustmentType() ends up as DefaultSubscriptionAdjustmentType.AMOUNT_OFF since the offer system calculates the actual amount to discount even if the base offer was a percentage off or fixed price. This field then is distinguished as the actual method specified on the offer before it was applied.

Specified by:

getAdjustmentDiscountMethodType in interface Adjustment

Returns:

The type of discount method used for this adjustment.

See Also:

• Adjustment.getAdjustmentDiscountMethodType()

getAdjustmentDiscountFactor

public BigDecimal getAdjustmentDiscountFactor()

Description copied from interface: Adjustment

The discount factor by which to discount a target. If the amount is 10, then whether it is calculated as a percentage (10%) or a currency amount ($10) is determined by Adjustment.getAdjustmentDiscountMethodType(). This does not represent that actual amount discounted from the target.

Specified by:

getAdjustmentDiscountFactor in interface Adjustment

Returns:

The discount factor used for this adjustment.

See Also:

• Adjustment.getAdjustmentDiscountFactor()

getCodeUsed

public String getCodeUsed()

Description copied from interface: Adjustment

The code used (if any) that triggered the application of the adjustment for this adjustment.

Specified by:

getCodeUsed in interface Adjustment

Returns:

The code used (if any) that triggered the application of the adjustment for this adjustment.

See Also:

• Adjustment.getCodeUsed()

getCampaignTrackingId

public String getCampaignTrackingId()

Description copied from interface: Adjustment

The campaign tracking id (if any) for this adjustment.

Specified by:

getCampaignTrackingId in interface Adjustment

Returns:

The campaign tracking id (if any) for this adjustment.

See Also:

• Adjustment.getCampaignTrackingId()

getDiscountType

public String getDiscountType()

Description copied from interface: Adjustment

Defines the type of the discount, e.g., free trial, order discount, future credit, etc. This primarily determines when it should be applied to the order or items. This helps distinguish whether the adjustment applies at checkout or later such as for a subscription.

Specified by:

getDiscountType in interface Adjustment

Returns:

The type of the discount.

See Also:

• Adjustment.getDiscountType()

getFreeTrialLength

public Integer getFreeTrialLength()

Description copied from interface: Adjustment

If Adjustment.getDiscountType() is FREE_TRIAL, then this defines the free trial's length.

Specified by:

getFreeTrialLength in interface Adjustment

Returns:

If Adjustment.getDiscountType() is FREE_TRIAL, then this defines the free trial's length.

See Also:

• Adjustment.getFreeTrialLength()

getFreeTrialLengthUnits

public String getFreeTrialLengthUnits()

Description copied from interface: Adjustment

If Adjustment.getDiscountType() is FREE_TRIAL, then this defines the units for Adjustment.getFreeTrialLength().

Specified by:

getFreeTrialLengthUnits in interface Adjustment

Returns:

If Adjustment.getDiscountType() is FREE_TRIAL, then this defines the units for Adjustment.getFreeTrialLength().

See Also:

• Adjustment.getFreeTrialLengthUnits()

getContextState

public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()

A subset of Tracking information to expose the context state for this object.

Specified by:

getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware

setId

public void setId(String id)

setSubscriptionId

public void setSubscriptionId(String subscriptionId)

Reference to the Subscription whose price this adjusts

setAdjustmentRef

public void setAdjustmentRef(String adjustmentRef)

See Also:

• Adjustment.getAdjustmentRef()

setSubscriptionAdjustmentType

public void setSubscriptionAdjustmentType(String subscriptionAdjustmentType)

See Also:

• Adjustment.getSubscriptionAdjustmentType()

setAdjustmentAmount

public void setAdjustmentAmount(BigDecimal adjustmentAmount)

See Also:

• Adjustment.getAdjustmentAmount()

setBeginPeriod

public void setBeginPeriod(Integer beginPeriod)

See Also:

• Adjustment.getBeginPeriod()

setEndPeriod

public void setEndPeriod(Integer endPeriod)

See Also:

• Adjustment.getEndPeriod()

setAdjustmentName

public void setAdjustmentName(String adjustmentName)

See Also:

• Adjustment.getAdjustmentName()

setAdjustmentCartLabel

public void setAdjustmentCartLabel(String adjustmentCartLabel)

See Also:

• Adjustment.getAdjustmentCartLabel()

setAdjustmentDescription

public void setAdjustmentDescription(String adjustmentDescription)

See Also:

• Adjustment.getAdjustmentDescription()

setAdjustmentProrationType

public void setAdjustmentProrationType(String adjustmentProrationType)

See Also:

• Adjustment.getAdjustmentProrationType()

setAdjustmentCodeRef

public void setAdjustmentCodeRef(String adjustmentCodeRef)

See Also:

• Adjustment.getAdjustmentCodeRef()

setAdjustmentDiscountMethodType

public void setAdjustmentDiscountMethodType(String adjustmentDiscountMethodType)

See Also:

• Adjustment.getAdjustmentDiscountMethodType()

setAdjustmentDiscountFactor

public void setAdjustmentDiscountFactor(BigDecimal adjustmentDiscountFactor)

See Also:

• Adjustment.getAdjustmentDiscountFactor()

setCodeUsed

public void setCodeUsed(String codeUsed)

See Also:

• Adjustment.getCodeUsed()

setCampaignTrackingId

public void setCampaignTrackingId(String campaignTrackingId)

See Also:

• Adjustment.getCampaignTrackingId()

setDiscountType

public void setDiscountType(String discountType)

See Also:

• Adjustment.getDiscountType()

setFreeTrialLength

public void setFreeTrialLength(Integer freeTrialLength)

See Also:

• Adjustment.getFreeTrialLength()

setFreeTrialLengthUnits

public void setFreeTrialLengthUnits(String freeTrialLengthUnits)

See Also:

• Adjustment.getFreeTrialLengthUnits()

setContextState

public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)

A subset of Tracking information to expose the context state for this object.

Specified by:

setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware

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