Package com.broadleafcommerce.pricing.domain

Class PriceModifier

java.lang.Object

com.broadleafcommerce.pricing.domain.PriceModifier

All Implemented Interfaces:

Serializable

public class PriceModifier
extends Object
implements Serializable

Whereas PriceData provides a specific price for a PriceableTarget, a price modifier performs an operation on a priceable field of the target such as adding 20% of the target's cost to calculate the price.

Several priceable fields are defined by default including basePrice, baseCost, standardPrice, salePrice, and contractPrice. BasePrice and baseCost are provided as part of PriceableTarget.priceableFields. The map key names are configurable by PriceableFieldProperties so that each implementor can use their own terminology. For instance, the basePrice could be called 'MSRP' or 'retailPrice'.

StandardPrice, salePrice, and contractPrice are derivative prices determined after a standard or sale price list has provided a specific price. That is to say, the standardPrice is usually an override or modification of the basePrice provided by a PriceableEntity. Likewise, the salePrice can be an override or modification of the standardPrice provided by a StandardPriceList, and a contractPrice can override or modify a salePrice provided by a SalePriceList. Consequently, a StandardPriceList's PriceModifier cannot modify a salePrice or contractPrice, neither can a SalePriceList's PriceModifier modify a contractPrice.

The modificationType determines whether the amount is added, subtracted, multiplied, or a some other operation to the fieldToModify. Default supported operations defined in PriceModificationType.

Author:

Nathan Moore (nathanmoore

See Also:

• PriceableFieldProperties
• PriceModificationType
• Serialized Form

Constructor Summary

Constructors

Constructor	Description
PriceModifier()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
BigDecimal	getAmount()	The amount by which we are modifying the target
String	getCriteria()	String representation of an expression to determine whether this modifier applies to a PriceableTarget.
String	getFieldToModify()	Name of field to modify.
String	getModificationType()	Type of modification to perform: Addition, Subtraction, Multiplication, Percentage, etc.
int	hashCode()
void	setAmount(BigDecimal amount)	The amount by which we are modifying the target
void	setCriteria(String criteria)	String representation of an expression to determine whether this modifier applies to a PriceableTarget.
void	setFieldToModify(String fieldToModify)	Name of field to modify.
void	setModificationType(String modificationType)	Type of modification to perform: Addition, Subtraction, Multiplication, Percentage, etc.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

PriceModifier

public PriceModifier()

Method Details

getAmount

public BigDecimal getAmount()

The amount by which we are modifying the target

getModificationType

public String getModificationType()

Type of modification to perform: Addition, Subtraction, Multiplication, Percentage, etc.

See Also:

• PriceModificationType

getCriteria

public String getCriteria()

String representation of an expression to determine whether this modifier applies to a PriceableTarget.

getFieldToModify

public String getFieldToModify()

Name of field to modify. Modifiers can modify direct prices that are passed in the PriceableTarget.priceableFields or the value from a previous pricing phase. Note that for ADJUSTMENT price lists, the value to modify is determined from the AdjustmentPhaseType on the PriceList

See Also:

• PriceableFieldProperties
• PriceListType
• DefaultPriceInfoService.isAdjustmentPriceListValidForType(PriceList, String)

setAmount

public void setAmount(BigDecimal amount)

The amount by which we are modifying the target

setModificationType

public void setModificationType(String modificationType)

Type of modification to perform: Addition, Subtraction, Multiplication, Percentage, etc.

See Also:

• PriceModificationType

setCriteria

public void setCriteria(String criteria)

String representation of an expression to determine whether this modifier applies to a PriceableTarget.

setFieldToModify

public void setFieldToModify(String fieldToModify)

Name of field to modify. Modifiers can modify direct prices that are passed in the PriceableTarget.priceableFields or the value from a previous pricing phase. Note that for ADJUSTMENT price lists, the value to modify is determined from the AdjustmentPhaseType on the PriceList

See Also:

• PriceableFieldProperties
• PriceListType
• DefaultPriceInfoService.isAdjustmentPriceListValidForType(PriceList, String)

toString

public String toString()

Overrides:

toString in class Object

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