Serialized Form

  • Package com.broadleafcommerce.pricing.domain

    • Class com.broadleafcommerce.pricing.domain.Fee

      class Fee extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • activeEndDate
          Instant activeEndDate
          The date where the fee stops being active.
        • activeStartDate
          Instant activeStartDate
          The date from which the fee should be active.
        • applyBeforeDiscounts
          boolean applyBeforeDiscounts
          Whether to apply the fee before or after offers/discounts are applied onto the cart.
        • currency
          javax.money.CurrencyUnit currency
          The currency of this fee.
        • feeCalculationMethod
          String feeCalculationMethod
          Where to apply the fee during cart pricing. By default, is applied onto the Cart subtotal.
        • feeCalculationOperation
          String feeCalculationOperation
          How to calculate the fee to be applied onto the cart. By default, is calculated by getting a percentage based on the cart subtotal.
        • feeCode
          String feeCode
          The unique code for the fee.
        • fixedAmount
          javax.money.MonetaryAmount fixedAmount
          The fixed amount of the fee to be applied. Only populated when Fee.feeCalculationOperation is FeeCalculationOperation.FIXED_AMOUNT.
        • id
          String id
        • label
          String label
          The label of the fee to be displayed as the cart item name on the cart.
        • priority
          int priority
          The priority with which to apply the fee onto the cart pricing.
        • rate
          BigDecimal rate
          The percentage of the cart subtotal to be used to determine the fee to be applied. Only populated when Fee.feeCalculationOperation is FeeCalculationOperation.RATE.
        • refundable
          boolean refundable
          Whether the fee is refundable.
        • taxCode
          String taxCode
          The tax code identifier for this fee.

    • Class com.broadleafcommerce.pricing.domain.ModifiableFields

      class ModifiableFields extends Object implements Serializable
      serialVersionUID:
      1L

    • 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.
        • adjustmentAmount
          BigDecimal adjustmentAmount
          The amount to adjust a PriceData.price Only valid for a PriceListType.ADJUSTMENT type price list.
        • adjustmentOperationType
          String adjustmentOperationType
          Indicates the type of operation to use when #isForMarkup() is true}.
          See Also:
        • adjustmentPriceListRelationType
          String adjustmentPriceListRelationType
          For PriceData's whose #isForMarkup() is true}, indicates how the markup relates to a PriceList markup. By default, only the PriceData markup will be used but this value can be used to run both the PriceList and PriceData markups from the same PriceList.
          See Also:
        • attributes
          Map<String,Object> attributes
          Additional miscellaneous attributes to store about this price data.
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
        • availableQuantity
          Integer availableQuantity
          Defines the actual quantity available for this price data as the sale progresses. Initially it is set to the PriceData.startingQuantity and is deducted as it gets used.
          See Also:
        • cancellationPolicyRef
          String cancellationPolicyRef
          A reference (typically the Id) of the CancellationPolicy for this priceData that governs how this priceData's subscription would be cancelled.
          Since:
          Pricing Services 2.2.0, Release Train 2.3.0
        • characteristics
          Map<String,String> characteristics
          Attributes to use to filter price data by. Evaluated against a target's characteristics.
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • description
          String description
          The description for this price data.
        • id
          String id
        • name
          String name
          The name for this price data.
        • paymentStrategy
          String paymentStrategy
          The payment strategy of the price data, e.g. ONE_TIME, PREPAID, POSTPAID
          Since:
          Pricing Service 2.1.0
          See Also:
          • PriceData.recurringPrice
          • PriceData.termDurationLength
          • DefaultPaymentStrategy
        • price
          javax.money.MonetaryAmount price
          The one-time price. This is typically used during checkout. Not used for a price data that is part of an PriceListType.ADJUSTMENT price list.
        • priceListId
          String priceListId
          The contextId of the parent price list.
          See Also:
        • priceListName
          String priceListName
          See Also:
        • priority
          Integer priority
          The priority of this price data. This helps determine which the best price data is when multiple can apply to a target.
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
        • recurringPeriodFrequency
          Integer recurringPeriodFrequency
          The frequency with which to charge the PriceData.recurringPrice.
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
          See Also:
          • PriceData.recurringPrice
          • PriceData.recurringPeriodType
        • recurringPeriodLimit
          Integer recurringPeriodLimit
          Defines the number of periods the price should recur. Only applicable for non-standard price lists, particularly sales where a discount may be applied for the first 'n' periods after which the price reverts to a standard price list's.
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
          See Also:
          • PriceData.recurringPrice
          • PriceData.recurringPeriodType
          • PriceData.recurringPeriodFrequency
        • recurringPeriodType
          String recurringPeriodType
          The period type for the recurring price, e.g. MONTHLY, QUARTERLY, ANNUALLY.
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
          See Also:
          • PriceData.recurringPrice
          • PriceData.recurringPeriodFrequency
          • DefaultRecurringPeriodType
        • recurringPrice
          javax.money.MonetaryAmount recurringPrice
          The amount of the recurring price. Optional. Requires PriceData.recurringPeriodFrequency, PriceData.recurringPeriodType, PriceData.termDurationLength, and PriceData.termDurationType.
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
        • specifyUpfrontPrice
          boolean specifyUpfrontPrice
          Whether this price data specifies an upfront price.

          This is only relevant for price data with DefaultPaymentStrategy.PREPAID and DefaultPaymentStrategy.POSTPAID strategies.

          For DefaultPaymentStrategy.PREPAID, this means whether the upfront price is different from the recurring price. If true, the upfront price is specified in PriceData.price. Otherwise the upfront price is the same as the recurring price.

          For DefaultPaymentStrategy.POSTPAID, this means whether an upfront price should be charged. If true, the upfront price is specified in PriceData.price. Otherwise, the upfront price defaults to zero.

        • startingQuantity
          Integer startingQuantity
          Defines the initial quantity available for this price data before a pricing event such as a flash sale. It is set only once during creation. After that it is read-only and serves an informational purpose.
        • target
          com.broadleafcommerce.pricing.client.domain.PriceableTargetRef target
          See Also:
          • PriceableTargetRef
          • PriceableTarget
        • termDurationLength
          Integer termDurationLength
          The length of the pricing terms, e.g., 36 for a 36 month contract.
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
          See Also:
          • PriceData.recurringPrice
          • PriceData.termDurationType
        • termDurationType
          String termDurationType
          The duration type for the recurring price, e.g. DAYS, WEEKS, MONTHS, YEARS.
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
          See Also:
          • PriceData.recurringPrice
          • PriceData.termDurationLength
          • DefaultTermDurationType
        • tierAttributeName
          String tierAttributeName
          The name of the attribute used for two-tier pricing.
          Since:
          Pricing Service 2.2.0, Release Train 2.3.0
        • tierPricingStrategy
          String tierPricingStrategy
          The strategy used to determine tier pricing.
          Since:
          Pricing Service 2.2.0, Release Train 2.3.0
          See Also:
        • tiers
          List<PriceDataTier> tiers
          Defines specific pricing for minimum quantities.
        • usageAmount
          BigDecimal usageAmount
          The unit of measure's amount for the usage price. Required for PriceData.usagePrice. Requires PriceData.usageUnits.
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
          See Also:
          • PriceData.usagePrice
          • PriceData.usageUnits
        • usagePrice
          javax.money.MonetaryAmount usagePrice
          The amount of the usage price. Optional. Requires PriceData.usageUnits and PriceData.usageAmount.
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
        • usageUnits
          String usageUnits
          The type of units used for the usage price. Required for PriceData.usagePrice.
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
          See Also:
          • PriceData.usagePrice
          • PriceData.usageAmount

    • Class com.broadleafcommerce.pricing.domain.PriceDataTier

      class PriceDataTier extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • attributeMinValue
          Integer attributeMinValue
          The minimum value for an attribute used for tiered pricing.
          Since:
          Pricing Service 2.2.0, Release Train 2.3.0
        • 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.
        • recurringPrice
          javax.money.MonetaryAmount recurringPrice
          The amount of the recurring price. Optional.
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
        • usagePrice
          javax.money.MonetaryAmount usagePrice
          The amount of the usage price. Optional.
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0

    • Class com.broadleafcommerce.pricing.domain.PriceDataUsageDetail

      class PriceDataUsageDetail extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • contextState
          com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState
          A subset of Tracking information to expose the context state for this object.
        • customerReferenceId
          String customerReferenceId
          The ID of the customer this audit is for.
        • customerReferenceType
          String customerReferenceType
          The customer type this audit is for, for example "CUSTOMER".
        • id
          String id
          The context ID of the PriceData Usage Detail.
        • priceDataId
          String priceDataId
          The ID of the priceData this audit is for.
        • revertible
          boolean revertible
          The revertible flag, if true indicates that this record is eligible for rolling back by PricingDetailTimeoutRollbackJobListener job
        • transactionReferenceId
          String transactionReferenceId
          The ID of the transaction this audit is for, for example cartId, orderId
        • transactionReferenceType
          String transactionReferenceType
          The transaction type this audit is for, for example "BLC_CART".
        • usageDate
          Instant usageDate
          The usage date for this audit.
        • usageQuantity
          Integer usageQuantity
          The quantity usage detail of this priceData

    • 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.
        • adjustmentPhase
          String adjustmentPhase
          See Also:
        • 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:

        • 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.
        • pricingCategoryAmountOverrides
          List<PricingCategoryDto> pricingCategoryAmountOverrides
          Price modification factor expressed as a BigDecimal associated with a pricing category key. Refer to the catalog domain for Product#pricingCategory for additional reference on pricing category.
        • 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:
        • 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

        • activeEndDate
          Instant activeEndDate
          Defines the ending time for which this price is active
        • activeStartDate
          Instant activeStartDate
          Defines the beginning time for which this price is active.
        • availableQuantity
          Integer availableQuantity
          Defines the actual quantity available of a product as the sale progresses. Initially it is set equal to the startingQuantity and is deducted as and when it gets used.
        • backupPriceDetail
          Optional<PriceListPriceDetail> backupPriceDetail
          Transfers the backupPriceSummary from the Summary to this price detail.
        • cancellationPolicyRef
          String cancellationPolicyRef
          A reference (typically the Id) of the CancellationPolicy for this priceData that governs how this priceData's subscription would be cancelled.
          Since:
          Pricing Services 2.2.0, Release Train 2.3.0
        • derivedFromFieldType
          String derivedFromFieldType
          A PriceInfo can be the result of a formula based pricing algorithm. For example, a sale price might be 10% off of the retail price. For proper sorting by the caller, it can be important to know the way that the price was derived. By default, for price infos and details returned from a formula, the derivedFromField will be either VARIANT_BASE_FIELD, or BASE_FIELD.
        • paymentStrategy
          String paymentStrategy
          Only relevant for price that came from a specific PriceData.

          Represents the payment strategy, specifically when payment is billed for a recurring price.

          See Also:
          • DefaultPaymentStrategy
        • price
          javax.money.MonetaryAmount price
          Price determined from a PriceList.getPriceModifier() or PriceData.getPrice() for a particular list.
          See Also:
          • PriceDetailComparable.getPrice()
        • priceData
          PriceData priceData
          Store the priceData on this intermediary object to allow for consistent sorting of PriceListPriceDetail objects.
        • priceDataId
          String priceDataId
          Id of the specific PriceData that this price came from.

          Only applicable if the PriceListPriceDetail.priceSource is DefaultPriceListPriceSources.BLC_PRICE_LIST_PRICE_DATA.

        • priceDataTierList
          List<com.broadleafcommerce.pricing.client.domain.PriceDataTierRef> priceDataTierList
          When a price list modifies an underlying price data that uses tiered pricing, also modify each tiered price and store it on this price detail.
          Since:
          Pricing Service 2.2.0, Release Train 2.3.0
          See Also:
          • PriceDataTierRef
        • priceListPriority
          Integer priceListPriority
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
          See Also:
          • PriceDetailComparable.getPriceListPriority()
        • 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
        • priority
          Integer priority
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
          See Also:
          • PriceDetailComparable.getPriority()
        • recurringPriceDetail
          com.broadleafcommerce.pricing.client.domain.RecurringPriceDetail recurringPriceDetail
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
          See Also:
          • PriceDetailComparable.getRecurringPriceDetail()
        • startingQuantity
          Integer startingQuantity
          Defines the initial quantity available for this price data before a pricing event such as a flash sale. It only serves an informational purpose.
        • usagePriceDetail
          com.broadleafcommerce.pricing.client.domain.UsagePriceDetail usagePriceDetail
          Since:
          Pricing Service 2.1.0, Release Train 2.2.0
          See Also:
          • PriceDetailComparable.getUsagePriceDetail()

    • Class com.broadleafcommerce.pricing.domain.PriceModifier

      class PriceModifier extends Object implements Serializable
      serialVersionUID:
      1L

    • Class com.broadleafcommerce.pricing.domain.PriceSummary

      class PriceSummary extends Object implements Serializable
      serialVersionUID:
      1L

      • Serialized Fields

        • activeEndDate
          Instant activeEndDate
          Defines the ending time for which this price is active
        • activeStartDate
          Instant activeStartDate
          Defines the beginning time for which this price is active.
        • availableQuantity
          Integer availableQuantity
          The available quantity that can use this price data. This is used for events such as a flash sale where the sale price is limited to a certain amount of quantity.
        • backupPriceSummary
          Optional<PriceSummary> backupPriceSummary
          This field is used for summaries based on a limited quantity PriceData. It allows the system to provide a backup to the front-end to show pricing if the user desires to purchase more quantity than is available at the limited quantity price. For summary objects that do not have a limited quantity, the summary will be stored here for convenience in determining if this PriceSummary might be used as a backup to another limited quantity summary.
        • cancellationPolicyRef
          String cancellationPolicyRef
          A reference (typically the Id) of the CancellationPolicy for this priceData that governs how this priceData's subscription would be cancelled.
          Since:
          Pricing Services 2.2.0, Release Train 2.3.0
        • paymentStrategy
          String paymentStrategy
          Only relevant for price that came from a specific PriceData.

          Represents the payment strategy, specifically when payment is billed for a recurring price.

          See Also:
          • DefaultPaymentStrategy
        • price
          javax.money.MonetaryAmount price
          The one-time price. This is typically used during checkout.
        • priceData
          PriceData priceData
          Used to store the price data object used to create this summary if applicable.
        • priceDataId
          String priceDataId
          Id of the specific PriceData that this price came from.

          Only applicable if the price was from a PriceData.

        • priceDataTiers
          List<PriceDataTier> priceDataTiers
          Used to store the priceDataTiers relevant for the related target
          Since:
          Pricing Service 2.2.0, Release Train 2.3.0
        • priority
          Integer priority
          The relative priority of this price detail vs others that might apply to the same target.
        • recurringPriceDetail
          com.broadleafcommerce.pricing.client.domain.RecurringPriceDetail recurringPriceDetail
          Represents the details related to a recurring (or subscription) price include the terms.
        • startingQuantity
          Integer startingQuantity
          Defines the initial quantity available for this price data before a pricing event such as a flash sale. It only serves an informational purpose.
        • usagePriceDetail
          com.broadleafcommerce.pricing.client.domain.UsagePriceDetail usagePriceDetail
          Represents the details related to a usage price including the units.

    • Class com.broadleafcommerce.pricing.domain.PricingCategoryDto

      class PricingCategoryDto extends Object implements Serializable

      • Serialized Fields

    • 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.exception

  • Package com.broadleafcommerce.pricing.provider.external.domain

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

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

  • Package com.broadleafcommerce.pricing.service

  • Package com.broadleafcommerce.pricing.service.messaging.cache

  • Package com.broadleafcommerce.pricing.service.messaging.ordercreated

  • Package com.broadleafcommerce.pricing.service.messaging.rollback