com.broadleafcommerce.pricelist.domain

Class PriceListImpl

java.lang.Object

com.broadleafcommerce.pricelist.domain.PriceListImpl

All Implemented Interfaces:

PriceList, PriceListAdminPresentation, Serializable, org.broadleafcommerce.common.admin.domain.AdminMainEntity, org.broadleafcommerce.common.admin.domain.TypedEntity, org.broadleafcommerce.common.copy.MultiTenantCloneable<PriceList>, org.broadleafcommerce.common.currency.util.CurrencyCodeIdentifiable

@Entity
public class PriceListImpl
extends Object
implements PriceList, org.broadleafcommerce.common.currency.util.CurrencyCodeIdentifiable, org.broadleafcommerce.common.admin.domain.AdminMainEntity, PriceListAdminPresentation, org.broadleafcommerce.common.admin.domain.TypedEntity

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.broadleafcommerce.pricelist.domain.PriceListAdminPresentation

PriceListAdminPresentation.FieldOrder, PriceListAdminPresentation.GroupName, PriceListAdminPresentation.GroupOrder, PriceListAdminPresentation.TabName, PriceListAdminPresentation.TabOrder

Field Summary

Fields

Modifier and Type	Field and Description
protected Date	activeEndDate
protected Date	activeStartDate
protected org.broadleafcommerce.common.currency.domain.BroadleafCurrency	currency
protected String	customerQualificationType
protected String	friendlyName
protected Boolean	hasPromotionMessage
protected Long	id
protected PriceList	parentPriceList
protected List<PriceAdjustment>	priceAdjustmentList
protected Map<String,PriceListRuleXref>	priceListMatchRules
protected String	priceListType
protected List<PriceModifier>	priceModifierList
protected Long	priority
protected List<PriceListPromotionMessageXref>	promotionMessageXrefs
protected Boolean	requireAssignmentToCustomer Deprecated.
protected List<SkuBundleItemPriceData>	skuBundleItemPriceDataList
protected List<SkuPriceData>	skuPriceDataList

Fields inherited from interface org.broadleafcommerce.common.admin.domain.AdminMainEntity

MAIN_ENTITY_NAME_PROPERTY

Constructor Summary

Constructors

Constructor and Description
PriceListImpl()

Method Summary

Modifier and Type	Method and Description
boolean	checkParentPriceListHierarchy()
<G extends PriceList> org.broadleafcommerce.common.copy.CreateResponse<G>	createOrRetrieveCopyInstance(org.broadleafcommerce.common.copy.MultiTenantCopyContext context)
boolean	equals(Object o)
Date	getActiveEndDate() Returns the active end date of this PriceList.
List<org.broadleafcommerce.core.promotionMessage.domain.PromotionMessage>	getActivePromotionMessagesByPlacement(org.broadleafcommerce.core.promotionMessage.domain.type.PromotionMessagePlacementType placementType) Returns the active PromotionMessages for this offer by PromotionMessagePlacementType
Date	getActiveStartDate() Returns the activeStartDate of this PriceList.
org.broadleafcommerce.common.currency.domain.BroadleafCurrency	getCurrency() Returns the currency associated with this pricelist
String	getCurrencyCode()
String	getCustomerQualificationType() A return value of ALL_CUSTOMERS indicates that the PriceList will only be in play for all customers.
String	getDefaultType()
String	getFriendlyName() Return the friendly name of the PriceList
Boolean	getHasPromotionMessage() Returns whether or not the PriceList has any associated PromotionMessages
Long	getId() Returns the unique id for this PriceList
String	getMainEntityName()
PriceList	getParentPriceList() Retuns the parent PriceList if applicable.
Map<String,PriceListRuleXref>	getPriceListMatchRules() List of Rules that determine if this PriceList should be used.
List<PriceModifier>	getPriceModifierList() Returns a list of price modifiers based on the priority order
Long	getPriority() Returns the priority of this PriceList.
List<PriceAdjustment>	getProductOptionPriceAdjustmentList() Returns the list of SkuBundleItemPriceData objects which represent the prices that have been overridden for this PriceList.
List<org.broadleafcommerce.core.promotionMessage.domain.PromotionMessage>	getPromotionMessages() Returns the list of promotion messages associated with this pricelist
List<PriceListPromotionMessageXref>	getPromotionMessageXrefs() Returns the list of promotion message xrefs associated with this pricelist
boolean	getRequireAssignmentToCustomer() A return value of true indicates that the PriceList will only be in play if it is directly attached to a customer (possibly via an account or other custom entity and resolver).
List<SkuBundleItemPriceData>	getSkuBundleItemPriceDataList() Returns the list of SkuBundleItemPriceData objects which represent the prices that have been overridden for this PriceList.
List<SkuPriceData>	getSkuPriceDataList() Returns the list of SkuPriceData objects which represent the SKU prices that have been overridden for this PriceList.
org.broadleafcommerce.common.BroadleafEnumerationType	getType() Returns the PriceListType for this PriceList.
String	getTypeFieldName()
PriceList	getValidParentPriceList() Provides a safe way to recursively request parent price lists.
int	hashCode()
boolean	isDecendantOf(PriceList parent) Returns true if the passed in PriceList is a parent of this PriceList or if the passed in PriceList matches this PriceList.
void	setActiveEndDate(Date endDate) Sets the active end date for the PriceList.
void	setActiveStartDate(Date startDate) Sets the active start date for the PriceList.
void	setCurrency(org.broadleafcommerce.common.currency.domain.BroadleafCurrency currency) sets the currency associated with this PriceList
void	setCustomerQualificationType(String customerQualificationType) Setting this to ALL_CUSTOMERS indicates that the PriceList will only be in play for all customers.
void	setFriendlyName(String friendlyName) Set the friendly name of this PriceList
void	setHasPromotionMessage(Boolean hasPromotionMessage) Sets whether or not the PriceList has any associated PromotionMessages
void	setId(Long id) Unique id for this PriceList
void	setParentPriceList(PriceList parentPriceList) Sets the parent PriceList if applicable.
void	setPriceListMatchRules(Map<String,PriceListRuleXref> priceListMatchRules) Sets the list of Rules that determine if this PriceList should be used.
void	setPriceModifierList(List<PriceModifier> priceModifierList) Sets the list of PriceModifiers to use with this PriceList
void	setPriority(Long priority) If two PriceLists are active for the same PricingContext, than the one with the lowest priority will apply.
void	setProductOptionPriceAdjustmentList(List<PriceAdjustment> productOptionPriceAdjustmentList) Sets the list of SkuPriceData objects which represent the SKU prices that have been overridden for this PriceList.
void	setPromotionMessageXrefs(List<PriceListPromotionMessageXref> promotionMessageXrefs) Sets a list of promotion message xrefs associated with this pricelist
void	setRequireAssignmentToCustomer(boolean requireAssignmentToCustomer) Setting this to true indicates that the PriceList will only be in play if it is directly attached to a customer (possibly via an account or other custom entity and resolver).
void	setSkuBundleItemPriceDataList(List<SkuBundleItemPriceData> skuBundleItemPriceDataList) Sets the list of SkuPriceData objects which represent the SKU prices that have been overridden for this PriceList.
void	setSkuPriceDataList(List<SkuPriceData> skuPriceDataList) Sets the list of SkuPriceData objects which represent the SKU prices that have been overridden for this PriceList.
void	setType(org.broadleafcommerce.common.BroadleafEnumerationType priceListType) Sets the PriceListType.
void	updateRequireAssignmentToCustomer() Updates the value of requireAssignmentToCustomer based on the customerQualificationType.

Methods inherited from class java.lang.Object

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

Field Detail

id

protected Long id

priceListType

protected String priceListType

friendlyName

protected String friendlyName

currency

protected org.broadleafcommerce.common.currency.domain.BroadleafCurrency currency

activeStartDate

protected Date activeStartDate

activeEndDate

protected Date activeEndDate

parentPriceList

protected PriceList parentPriceList

priority

protected Long priority

customerQualificationType

protected String customerQualificationType

priceListMatchRules

protected Map<String,PriceListRuleXref> priceListMatchRules

priceModifierList

protected List<PriceModifier> priceModifierList

skuBundleItemPriceDataList

protected List<SkuBundleItemPriceData> skuBundleItemPriceDataList

skuPriceDataList

protected List<SkuPriceData> skuPriceDataList

priceAdjustmentList

protected List<PriceAdjustment> priceAdjustmentList

requireAssignmentToCustomer

@Deprecated
protected Boolean requireAssignmentToCustomer

Deprecated.

hasPromotionMessage

protected Boolean hasPromotionMessage

promotionMessageXrefs

protected List<PriceListPromotionMessageXref> promotionMessageXrefs

Constructor Detail

PriceListImpl

public PriceListImpl()

Method Detail

getFriendlyName

public String getFriendlyName()

Description copied from interface: PriceList

Return the friendly name of the PriceList

Specified by:

getFriendlyName in interface PriceList

Returns:

setFriendlyName

public void setFriendlyName(String friendlyName)

Description copied from interface: PriceList

Set the friendly name of this PriceList

Specified by:

setFriendlyName in interface PriceList

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getId

public Long getId()

Description copied from interface: PriceList

Returns the unique id for this PriceList

Specified by:

getId in interface PriceList

Returns:

setId

public void setId(Long id)

Description copied from interface: PriceList

Unique id for this PriceList

Specified by:

setId in interface PriceList

getType

public org.broadleafcommerce.common.BroadleafEnumerationType getType()

Description copied from interface: PriceList

Returns the PriceListType for this PriceList. If null, the returned type will be PriceListType.STANDARD

Specified by:

getType in interface PriceList

Specified by:

getType in interface org.broadleafcommerce.common.admin.domain.TypedEntity

setType

public void setType(org.broadleafcommerce.common.BroadleafEnumerationType priceListType)

Description copied from interface: PriceList

Sets the PriceListType.

Specified by:

setType in interface PriceList

Specified by:

setType in interface org.broadleafcommerce.common.admin.domain.TypedEntity

getCurrency

public org.broadleafcommerce.common.currency.domain.BroadleafCurrency getCurrency()

Description copied from interface: PriceList

Returns the currency associated with this pricelist

Specified by:

getCurrency in interface PriceList

Returns:

setCurrency

public void setCurrency(org.broadleafcommerce.common.currency.domain.BroadleafCurrency currency)

Description copied from interface: PriceList

sets the currency associated with this PriceList

Specified by:

setCurrency in interface PriceList

getCurrencyCode

public String getCurrencyCode()

Specified by:

getCurrencyCode in interface org.broadleafcommerce.common.currency.util.CurrencyCodeIdentifiable

getParentPriceList

public PriceList getParentPriceList()

Description copied from interface: PriceList

Retuns the parent PriceList if applicable. Parent PriceLists are used if no value has been set for this PriceList. In which case the Parent's price will be used.

Specified by:

getParentPriceList in interface PriceList

Returns:

setParentPriceList

public void setParentPriceList(PriceList parentPriceList)

Description copied from interface: PriceList

Sets the parent PriceList if applicable. Parent PriceLists are used if no value has been set for this PriceList. In which case the Parent's price will be used.

Specified by:

setParentPriceList in interface PriceList

getValidParentPriceList

public PriceList getValidParentPriceList()

Description copied from interface: PriceList

Provides a safe way to recursively request parent price lists. Returns the parentPriceList after ensuring that the parentPriceList structure is not recursive.

Specified by:

getValidParentPriceList in interface PriceList

Returns:

checkParentPriceListHierarchy

public boolean checkParentPriceListHierarchy()

getPriceModifierList

public List<PriceModifier> getPriceModifierList()

Description copied from interface: PriceList

Returns a list of price modifiers based on the priority order

Specified by:

getPriceModifierList in interface PriceList

Returns:

setPriceModifierList

public void setPriceModifierList(List<PriceModifier> priceModifierList)

Description copied from interface: PriceList

Sets the list of PriceModifiers to use with this PriceList

Specified by:

setPriceModifierList in interface PriceList

getActiveStartDate

public Date getActiveStartDate()

Description copied from interface: PriceList

Returns the activeStartDate of this PriceList. If null, this PriceList is NOT active.

Specified by:

getActiveStartDate in interface PriceList

Returns:

setActiveStartDate

public void setActiveStartDate(Date startDate)

Description copied from interface: PriceList

Sets the active start date for the PriceList. If null, this PriceList is NOT active.

Specified by:

setActiveStartDate in interface PriceList

getActiveEndDate

public Date getActiveEndDate()

Description copied from interface: PriceList

Returns the active end date of this PriceList. If not set, the PriceList has no end date.

Specified by:

getActiveEndDate in interface PriceList

Returns:

setActiveEndDate

public void setActiveEndDate(Date endDate)

Description copied from interface: PriceList

Sets the active end date for the PriceList. If null, this PriceList does not have an end date.

Specified by:

setActiveEndDate in interface PriceList

setPriority

public void setPriority(Long priority)

Description copied from interface: PriceList

If two PriceLists are active for the same PricingContext, than the one with the lowest priority will apply.

Specified by:

setPriority in interface PriceList

getPriority

public Long getPriority()

Description copied from interface: PriceList

Returns the priority of this PriceList. If multiple PriceLists qualify for a request, the one with the lowest priority will be used.

Specified by:

getPriority in interface PriceList

Returns:

getPriceListMatchRules

public Map<String,PriceListRuleXref> getPriceListMatchRules()

Description copied from interface: PriceList

List of Rules that determine if this PriceList should be used.

Specified by:

getPriceListMatchRules in interface PriceList

Returns:

setPriceListMatchRules

public void setPriceListMatchRules(Map<String,PriceListRuleXref> priceListMatchRules)

Description copied from interface: PriceList

Sets the list of Rules that determine if this PriceList should be used.

Specified by:

setPriceListMatchRules in interface PriceList

getSkuPriceDataList

public List<SkuPriceData> getSkuPriceDataList()

Description copied from interface: PriceList

Returns the list of SkuPriceData objects which represent the SKU prices that have been overridden for this PriceList.

Specified by:

getSkuPriceDataList in interface PriceList

Returns:

setSkuPriceDataList

public void setSkuPriceDataList(List<SkuPriceData> skuPriceDataList)

Description copied from interface: PriceList

Sets the list of SkuPriceData objects which represent the SKU prices that have been overridden for this PriceList.

Specified by:

setSkuPriceDataList in interface PriceList

getSkuBundleItemPriceDataList

public List<SkuBundleItemPriceData> getSkuBundleItemPriceDataList()

Description copied from interface: PriceList

Returns the list of SkuBundleItemPriceData objects which represent the prices that have been overridden for this PriceList.

Specified by:

getSkuBundleItemPriceDataList in interface PriceList

Returns:

setSkuBundleItemPriceDataList

public void setSkuBundleItemPriceDataList(List<SkuBundleItemPriceData> skuBundleItemPriceDataList)

Description copied from interface: PriceList

Sets the list of SkuPriceData objects which represent the SKU prices that have been overridden for this PriceList.

Specified by:

setSkuBundleItemPriceDataList in interface PriceList

getProductOptionPriceAdjustmentList

public List<PriceAdjustment> getProductOptionPriceAdjustmentList()

Description copied from interface: PriceList

Returns the list of SkuBundleItemPriceData objects which represent the prices that have been overridden for this PriceList.

Specified by:

getProductOptionPriceAdjustmentList in interface PriceList

Returns:

setProductOptionPriceAdjustmentList

public void setProductOptionPriceAdjustmentList(List<PriceAdjustment> productOptionPriceAdjustmentList)

Description copied from interface: PriceList

Sets the list of SkuPriceData objects which represent the SKU prices that have been overridden for this PriceList.

Specified by:

setProductOptionPriceAdjustmentList in interface PriceList

setRequireAssignmentToCustomer

public void setRequireAssignmentToCustomer(boolean requireAssignmentToCustomer)

Description copied from interface: PriceList

Setting this to true indicates that the PriceList will only be in play if it is directly attached to a customer (possibly via an account or other custom entity and resolver).

Specified by:

setRequireAssignmentToCustomer in interface PriceList

getRequireAssignmentToCustomer

public boolean getRequireAssignmentToCustomer()

Description copied from interface: PriceList

A return value of true indicates that the PriceList will only be in play if it is directly attached to a customer (possibly via an account or other custom entity and resolver).

Specified by:

getRequireAssignmentToCustomer in interface PriceList

Returns:

updateRequireAssignmentToCustomer

public void updateRequireAssignmentToCustomer()

Description copied from interface: PriceList

Updates the value of requireAssignmentToCustomer based on the customerQualificationType. If customerQualificationType == SPECIFIC_CUSTOMERS_ONLY, requireAssignmentToCustomer = true. Else, requireAssignmentToCustomer = false.

Specified by:

updateRequireAssignmentToCustomer in interface PriceList

getCustomerQualificationType

public String getCustomerQualificationType()

Description copied from interface: PriceList

A return value of ALL_CUSTOMERS indicates that the PriceList will only be in play for all customers. A return value of SPECIFIC_CUSTOMERS_ONLY indicates that the PriceList will only be in play if it is directly attached to a customer (possibly via an account or other custom entity and resolver). A return value of QUALIFIED_CUSTOMERS_AND_SPECIFIC_CUSTOMERS indicates that the PriceList will be in play if it is directly attached to a customer (possibly via an account or other custom entity and resolver) or if customers qualify according to the defined set of rules.

Specified by:

getCustomerQualificationType in interface PriceList

Returns:

setCustomerQualificationType

public void setCustomerQualificationType(String customerQualificationType)

Description copied from interface: PriceList

Setting this to ALL_CUSTOMERS indicates that the PriceList will only be in play for all customers. Setting this to SPECIFIC_CUSTOMERS_ONLY indicates that the PriceList will only be in play if it is directly attached to a customer (possibly via an account or other custom entity and resolver). Setting this to QUALIFIED_CUSTOMERS_AND_SPECIFIC_CUSTOMERS indicates that the PriceList will be in play if it is directly attached to a customer (possibly via an account or other custom entity and resolver) or if customers qualify according to the defined set of rules.

Specified by:

setCustomerQualificationType in interface PriceList

isDecendantOf

public boolean isDecendantOf(PriceList parent)

Description copied from interface: PriceList

Returns true if the passed in PriceList is a parent of this PriceList or if the passed in PriceList matches this PriceList.

Specified by:

isDecendantOf in interface PriceList

Returns:

getHasPromotionMessage

public Boolean getHasPromotionMessage()

Description copied from interface: PriceList

Returns whether or not the PriceList has any associated PromotionMessages

Specified by:

getHasPromotionMessage in interface PriceList

Returns:

setHasPromotionMessage

public void setHasPromotionMessage(Boolean hasPromotionMessage)

Description copied from interface: PriceList

Sets whether or not the PriceList has any associated PromotionMessages

Specified by:

setHasPromotionMessage in interface PriceList

getPromotionMessageXrefs

public List<PriceListPromotionMessageXref> getPromotionMessageXrefs()

Description copied from interface: PriceList

Returns the list of promotion message xrefs associated with this pricelist

Specified by:

getPromotionMessageXrefs in interface PriceList

Returns:

setPromotionMessageXrefs

public void setPromotionMessageXrefs(List<PriceListPromotionMessageXref> promotionMessageXrefs)

Description copied from interface: PriceList

Sets a list of promotion message xrefs associated with this pricelist

Specified by:

setPromotionMessageXrefs in interface PriceList

getPromotionMessages

public List<org.broadleafcommerce.core.promotionMessage.domain.PromotionMessage> getPromotionMessages()

Description copied from interface: PriceList

Returns the list of promotion messages associated with this pricelist

Specified by:

getPromotionMessages in interface PriceList

Returns:

all PromotionMessages

getActivePromotionMessagesByPlacement

public List<org.broadleafcommerce.core.promotionMessage.domain.PromotionMessage> getActivePromotionMessagesByPlacement(org.broadleafcommerce.core.promotionMessage.domain.type.PromotionMessagePlacementType placementType)

Description copied from interface: PriceList

Returns the active PromotionMessages for this offer by PromotionMessagePlacementType

Specified by:

getActivePromotionMessagesByPlacement in interface PriceList

Returns:

filtered PromotionMessages

getMainEntityName

public String getMainEntityName()

Specified by:

getMainEntityName in interface org.broadleafcommerce.common.admin.domain.AdminMainEntity

createOrRetrieveCopyInstance

public <G extends PriceList> org.broadleafcommerce.common.copy.CreateResponse<G> createOrRetrieveCopyInstance(org.broadleafcommerce.common.copy.MultiTenantCopyContext context)
                                                                                                       throws CloneNotSupportedException

Specified by:

createOrRetrieveCopyInstance in interface org.broadleafcommerce.common.copy.MultiTenantCloneable<PriceList>

Throws:

CloneNotSupportedException

getTypeFieldName

public String getTypeFieldName()

Specified by:

getTypeFieldName in interface org.broadleafcommerce.common.admin.domain.TypedEntity

getDefaultType

public String getDefaultType()

Specified by:

getDefaultType in interface org.broadleafcommerce.common.admin.domain.TypedEntity