com.broadleafcommerce.pricelist.domain

Interface PriceModifier

All Superinterfaces:

org.broadleafcommerce.common.copy.MultiTenantCloneable<PriceModifier>, Serializable

All Known Implementing Classes:

PriceModifierImpl

public interface PriceModifier
extends Serializable, org.broadleafcommerce.common.copy.MultiTenantCloneable<PriceModifier>

Method Summary

Modifier and Type	Method and Description
boolean	getApplyToRetailPrice() If true, this modification will be applied to both the price and retail price fields.
String	getFriendlyName() Returns the friendly name of the modifier which is useful for keeping track of modifiers in the admin.
Long	getId() The unique id of this PriceModifier
String	getMatchRule() Returns the MVEL rule string to use for this PriceModifier.
BigDecimal	getModificationAmount() The amount of the modification.
ModificationSourceFieldType	getModificationSourceField() Deprecated. since pricelist 1.3.0
PriceList	getPriceList() Gets the associated pricelist
PriceModificationType	getPriceModificationType() Determines the modification type (e.g.
Long	getPriority() Determines the order that modifier rules are evaluated.
void	setApplyToRetailPrice(boolean applyToRetailPrice) Sets whether or not modifiers should modify both price and retailPrice.
void	setFriendlyName(String friendlyName) Sets the friendly name of the modifier.
void	setId(Long id) Sets the unique id of this PriceModifier
void	setMatchRule(String matchRule) Sets the matchRule for this PriceModifier
void	setModificationAmount(BigDecimal modificationAmount) Sets the amount of the modification.
void	setModificationSourceField(ModificationSourceFieldType type) Deprecated. since pricelist 1.3.0
void	setPriceList(PriceList priceList) Sets the associate pricelist
void	setPriceModificationType(PriceModificationType type) Sets the modifiction type.
void	setPriority(Long priority) Sets the priority of this modifier.

Methods inherited from interface org.broadleafcommerce.common.copy.MultiTenantCloneable

createOrRetrieveCopyInstance

Method Detail

getMatchRule

String getMatchRule()

Returns the MVEL rule string to use for this PriceModifier. If the matchRule is null or empty, the rule evaluation should consider this modifier a match.

Returns:

setMatchRule

void setMatchRule(String matchRule)

Sets the matchRule for this PriceModifier

Parameters:

matchRule -

getId

Long getId()

The unique id of this PriceModifier

Returns:

setId

void setId(Long id)

Sets the unique id of this PriceModifier

Parameters:

id -

getFriendlyName

String getFriendlyName()

Returns the friendly name of the modifier which is useful for keeping track of modifiers in the admin.

Returns:

setFriendlyName

void setFriendlyName(String friendlyName)

Sets the friendly name of the modifier.

Parameters:

friendlyName -

getPriority

Long getPriority()

Determines the order that modifier rules are evaluated. Only one price modifier will be applied for any pricing circumstance. Lower priority modifiers will be tried first. If multiple modifiers have the same priority, the underlying implementation should use the first matching one that it processes although this contract makes no guarantees on which modifier that will be.

Returns:

setPriority

void setPriority(Long priority)

Sets the priority of this modifier.

Parameters:

priority -

getModificationSourceField

@Deprecated
ModificationSourceFieldType getModificationSourceField()

Deprecated. since pricelist 1.3.0

Determines which base price is being used as the basis for modification.

Returns:

See Also:

ModificationSourceFieldType

setModificationSourceField

@Deprecated
void setModificationSourceField(ModificationSourceFieldType type)

Deprecated. since pricelist 1.3.0

Sets which base price field is being used as the basis for modification.

Parameters:

type -

getPriceModificationType

PriceModificationType getPriceModificationType()

Determines the modification type (e.g. ADD, MULTIPLY)

Returns:

setPriceModificationType

void setPriceModificationType(PriceModificationType type)

Sets the modifiction type.

Parameters:

type -

getModificationAmount

BigDecimal getModificationAmount()

The amount of the modification.

Returns:

setModificationAmount

void setModificationAmount(BigDecimal modificationAmount)

Sets the amount of the modification.

Parameters:

modificationAmount -

getPriceList

PriceList getPriceList()

Gets the associated pricelist

Returns:

the pricelist

setPriceList

void setPriceList(PriceList priceList)

Sets the associate pricelist

Parameters:

priceList -

getApplyToRetailPrice

boolean getApplyToRetailPrice()

If true, this modification will be applied to both the price and retail price fields. If the value not explicitly set, this method will return true if the currency of this priceList does not match the currency of the parent priceList. Generally, it would be set to its default value of false.

Returns:

setApplyToRetailPrice

void setApplyToRetailPrice(boolean applyToRetailPrice)

Sets whether or not modifiers should modify both price and retailPrice.

Parameters:

applyToRetailPrice -