Package com.broadleafcommerce.billing.domain

Class BillingEventAdjustment

java.lang.Object

com.broadleafcommerce.billing.domain.BillingEventAdjustment

All Implemented Interfaces:

com.broadleafcommerce.data.tracking.core.ContextStateAware

public class BillingEventAdjustment
extends Object
implements com.broadleafcommerce.data.tracking.core.ContextStateAware

Represents a price adjustment to the original price on a BillingEvent. These are prorated into item adjustments upon Billing Event creation in DefaultBillingEventService.generateProratedEventItemAdjustments(List, List). As such, they are not used for further pricing calculations.

Field Summary

Fields

Modifier and Type	Field	Description
protected BigDecimal	adjustmentAmount	The total event-level adjustment amount.
protected String	adjustmentRef	Reference to the promotion or offer that drives this adjustment
protected @Size(max=255) @NotBlank String	billingEventId	References the billing event for this adjustment.
protected @Null(groups=Create.class) @Size(max=255) String	id

Constructor Summary

Constructors

Constructor	Description
BillingEventAdjustment()
BillingEventAdjustment(String id, String billingEventId, String adjustmentRef, BigDecimal adjustmentAmount, com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BigDecimal	getAdjustmentAmount()	The total event-level adjustment amount.
String	getAdjustmentRef()	Reference to the promotion or offer that drives this adjustment
String	getBillingEventId()	References the billing event 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	getId()
int	hashCode()
void	setAdjustmentAmount(BigDecimal adjustmentAmount)	The total event-level adjustment amount.
void	setAdjustmentRef(String adjustmentRef)	Reference to the promotion or offer that drives this adjustment
void	setBillingEventId(String billingEventId)	References the billing event for this adjustment.
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	setId(String id)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

id

@Null(groups=Create.class)
@Size(max=255)
protected @Null(groups=Create.class) @Size(max=255) String id

billingEventId

@Size(max=255)
@NotBlank
protected @Size(max=255) @NotBlank String billingEventId

References the billing event for this adjustment.

adjustmentRef

protected String adjustmentRef

Reference to the promotion or offer that drives this adjustment

adjustmentAmount

protected BigDecimal adjustmentAmount

The total event-level adjustment amount.

Constructor Details

BillingEventAdjustment

public BillingEventAdjustment()

BillingEventAdjustment

public BillingEventAdjustment(String id,
 String billingEventId,
 String adjustmentRef,
 BigDecimal adjustmentAmount,
 com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)

Method Details

getId

public String getId()

getBillingEventId

public String getBillingEventId()

References the billing event for this adjustment.

getAdjustmentRef

public String getAdjustmentRef()

Reference to the promotion or offer that drives this adjustment

getAdjustmentAmount

public BigDecimal getAdjustmentAmount()

The total event-level adjustment amount.

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)

setBillingEventId

public void setBillingEventId(String billingEventId)

References the billing event for this adjustment.

setAdjustmentRef

public void setAdjustmentRef(String adjustmentRef)

Reference to the promotion or offer that drives this adjustment

setAdjustmentAmount

public void setAdjustmentAmount(BigDecimal adjustmentAmount)

The total event-level adjustment amount.

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