Serialized Form

Package com.broadleafcommerce.pricing.domain

Class com.broadleafcommerce.pricing.domain.ModifiableFields

class ModifiableFields extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

fields

Set<String> fields

type

String type

Class com.broadleafcommerce.pricing.domain.PriceData

class PriceData extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

activeEndDate

Instant activeEndDate

Defines the ending time for which this price data is active

activeStartDate

Instant activeStartDate

Defines the beginning time for which this price data is active.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

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

id

String id

price

javax.money.MonetaryAmount price

priceListId

String priceListId

The contextId of the parent price list.

See Also:

• PriceList.getId()

priceListName

String priceListName

See Also:

• PriceList.getName()

target

com.broadleafcommerce.pricing.client.domain.PriceableTargetRef target

See Also:

• PriceableTargetRef
• PriceableTarget

tiers

List<PriceDataTier> tiers

Defines specific pricing for minimum quantities.

Class com.broadleafcommerce.pricing.domain.PriceDataTier

class PriceDataTier extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextState

com.broadleafcommerce.data.tracking.core.EmbeddedContextState contextState

A subset of Tracking information to expose the context state for this object. This value is not persisted, and instead it is dynamically calculated and populated when the ChangeDetails for the parent object's entire attributes map are compared.

minQuantity

Integer minQuantity

The quantity that defines the minimum threshold of this tier.

price

javax.money.MonetaryAmount price

The price for targets items when this tier is met.

Class com.broadleafcommerce.pricing.domain.PriceList

class PriceList extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

activeEndDate

Instant activeEndDate

Defines the ending time for which this price list is active

activeStartDate

Instant activeStartDate

Defines the beginning time for which this price list is active.

allowVendorsToAddPriceData

boolean allowVendorsToAddPriceData

A flag determining whether vendors are allowed to view this price list or add vendor price data to it. This is most relevant to price lists which are themselves not in a vendor but want to control whether vendors can contribute to them.

contextState

com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState

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

currency

javax.money.CurrencyUnit currency

The currency to which this price list applies.

id

String id

modifiableFields

Set<String> modifiableFields

Fields that modifiers can modify for this price list.

Modifiable fields for each type:

• Standard Price Lists:
  • PriceableFieldProperties.basePrice
  • PriceableFieldProperties.baseCost
• Sale Price Lists:
  • PriceableFieldProperties.basePrice
  • PriceableFieldProperties.baseCost
  • Standard Price List price (standardPrice)
• Contract Price Lists:
  • PriceableFieldProperties.basePrice
  • PriceableFieldProperties.baseCost
  • Standard Price List price (standardPrice)
  • Sale Price List price (salePrice)

name

String name

priceContextCriteria

String priceContextCriteria

String expression used to determine whether a price list applies to a PriceContext. This could be a string representation of a SpelExpression, e.g., name == 'some-name' || id == '1', or that of some other expression language.

priceModifier

PriceModifier priceModifier

Optionally describes how this price list will modify existing prices.

priority

Integer priority

When multiple price lists match a PriceContext, the price list with the higher priority wins out, where smaller integer values represent higher priorities. Nulls are implicitly given lower precedence than any other value - they will appear last.

storeRef

String storeRef

Key to external system indicating that this PriceList is specific to a store. This can be populated to support security controls based on a store based claim.

type

String type

See Also:

• for examples

useModifier

boolean useModifier

Whether this price list uses a price modifier instead of price data

userTargets

Set<UserTarget> userTargets

Specific users that this price list targets. Expects an ID and a type of user. This could include such types as "customer" or "account".

vendorRef

String vendorRef

Key to external system indicating that this PriceList is specific to a vendor. This can be populated to support security controls based on a vendor based claim.

Class com.broadleafcommerce.pricing.domain.PriceListPriceDetail

class PriceListPriceDetail extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

price

javax.money.MonetaryAmount price

Price determined from a price list.

priceSource

String priceSource

The source of this price within the price list, e.g. price list formula, price list price data, etc.

See Also:

• DefaultPriceListPriceSources

Class com.broadleafcommerce.pricing.domain.PriceModifier

class PriceModifier extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

amount

BigDecimal amount

The amount by which we are modifying the target

criteria

String criteria

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

fieldToModify

String fieldToModify

Name of field to modify. This must match a map key in PriceableTarget.priceableFields.

See Also:

• PriceableFieldProperties

modificationType

String modificationType

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

See Also:

• PriceModificationType

Class com.broadleafcommerce.pricing.domain.UserTarget

class UserTarget extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

contextState

com.broadleafcommerce.data.tracking.core.EmbeddedContextState contextState

A subset of Tracking information to expose the context state for this object. This value is not persisted, and instead it is dynamically calculated and populated when the ChangeDetails for the parent object's entire attributes map are compared.

targetType

String targetType

This could be "customer", "account", etc.

targetValue

String targetValue

Package com.broadleafcommerce.pricing.provider.jpa.datafeed

Class com.broadleafcommerce.pricing.provider.jpa.datafeed.IncrementalDataFeedEntityUpdateEvent

class IncrementalDataFeedEntityUpdateEvent extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

affectedProductReferenceType

String affectedProductReferenceType

See Also:

• DefaultIncrementalEventProductReferenceTypes

affectedProductReferenceValue

String affectedProductReferenceValue

applicationId

String applicationId

originalEventTime

Instant originalEventTime

tenantId

String tenantId

Package com.broadleafcommerce.pricing.provider.jpa.domain

Class com.broadleafcommerce.pricing.provider.jpa.domain.JpaPriceData

class JpaPriceData extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

_id

String _id

activeEndDate

Instant activeEndDate

See Also:

• PriceData.getActiveEndDate()

activeStartDate

Instant activeStartDate

See Also:

• PriceData.getActiveStartDate()

contextId

String contextId

See Also:

• Trackable.getContextId()

currency

javax.money.CurrencyUnit currency

Transient property that holds the parent price list currency in order to convert price to a MonetaryAmount.

price

BigDecimal price

See Also:

• PriceData.getPrice()

priceListId

String priceListId

See Also:

• PriceData.getPriceListId()

priceListName

String priceListName

See Also:

• PriceData.getPriceListName()

targetContextId

String targetContextId

targetType

String targetType

See Also:

• PriceableTarget.getTargetType()

targetVendorRef

String targetVendorRef

tiers

List<JpaPriceDataTier> tiers

See Also:

• PriceData.getTiers()

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.ApplicationJpaTracking tracking

See Also:

• ApplicationJpaTracking

Class com.broadleafcommerce.pricing.provider.jpa.domain.JpaPriceDataTier

class JpaPriceDataTier extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

currency

javax.money.CurrencyUnit currency

Transient property that holds the parent price list currency in order to convert price to a MonetaryAmount.

minQuantity

Integer minQuantity

price

BigDecimal price

Class com.broadleafcommerce.pricing.provider.jpa.domain.JpaPriceList

class JpaPriceList extends Object implements Serializable

serialVersionUID:

2L

Serialized Fields

_id

String _id

activeEndDate

Instant activeEndDate

See Also:

• PriceList.getActiveEndDate()

activeStartDate

Instant activeStartDate

See Also:

• PriceList.getActiveStartDate()

allowVendorsToAddPriceData

boolean allowVendorsToAddPriceData

See Also:

• PriceList.isAllowVendorsToAddPriceData()

contextId

String contextId

See Also:

• Trackable.getContextId()

currency

javax.money.CurrencyUnit currency

See Also:

• PriceList.getCurrency()

fieldToModify

String fieldToModify

See Also:

• PriceModifier.getFieldToModify()

modificationAmount

BigDecimal modificationAmount

See Also:

• PriceModifier.getAmount()

modificationCriteria

String modificationCriteria

See Also:

• PriceModifier.getCriteria()

modificationType

String modificationType

See Also:

• PriceModifier.getModificationType()

name

String name

See Also:

• PriceList.getName()

priceContextCriteria

String priceContextCriteria

See Also:

• PriceList.getPriceContextCriteria()

priority

Integer priority

See Also:

• PriceList.getPriority()

tracking

com.broadleafcommerce.data.tracking.jpa.filtering.domain.ApplicationJpaTracking tracking

See Also:

• ApplicationJpaTracking

type

String type

See Also:

• PriceList.getType()

useModifier

boolean useModifier

See Also:

• PriceList.isUseModifier()

userTargets

Set<JpaPriceUserTarget> userTargets

See Also:

• PriceList.getUserTargets()

useTargets

boolean useTargets

Column that is automatically set to true or false based on the existence of user targets. This helps to optimize performance for sites that create a lot of user targeted price lists.

See Also:

• to see how this is populated

vendorRef

String vendorRef

See Also:

• PriceList.getVendorRef()

Class com.broadleafcommerce.pricing.provider.jpa.domain.JpaPriceUserTarget

class JpaPriceUserTarget extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

priceList

JpaPriceList priceList

targetType

String targetType

targetValue

String targetValue

Class com.broadleafcommerce.pricing.provider.jpa.domain.JpaPriceUserTargetId

class JpaPriceUserTargetId extends Object implements Serializable

serialVersionUID:

1L

Serialized Fields

priceList

String priceList

targetType

String targetType

targetValue

String targetValue