Package com.broadleafcommerce.pricing.domain

Class PriceData

java.lang.Object
com.broadleafcommerce.pricing.domain.PriceData
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable, Comparable<PriceData>
public class PriceData extends Object implements Serializable, Comparable<PriceData>, com.broadleafcommerce.data.tracking.core.ContextStateAware
Data storing a specific price for a specific PriceableTarget.
Author:
Chad Harchar (charchar)
See Also:

  • Field Details

  • Constructor Details

    • PriceData

      public PriceData()

  • Method Details

    • compareTo

      public int compareTo(@Nullable PriceData o)
      Compares price. Null is more than non-null.
      Specified by:
      compareTo in interface Comparable<PriceData>

    • isActive

      public boolean isActive()
      Whether this PriceInfo is active based on the activeStartDate and activeEndDate.

    • getCharacteristics

      public Map<String,String> getCharacteristics()

    • setCharacteristics

      public void setCharacteristics(Map<String,String> newCharacteristics)

    • getTerm

      public String getTerm()

    • getFrequency

      public String getFrequency()

    • getVendorRef

      public String getVendorRef()

    • getNumberOfCharacteristics

      public int getNumberOfCharacteristics()

    • hasLimitedQuantity

      public boolean hasLimitedQuantity()

    • getId

      public String getId()

    • getPriceListId

      public String getPriceListId()
      The contextId of the parent price list.
      See Also:

    • getPriceListName

      public String getPriceListName()
      See Also:

    • getTarget

      public com.broadleafcommerce.pricing.client.domain.PriceableTargetRef getTarget()
      See Also:
      • PriceableTargetRef
      • PriceableTarget

    • isSpecifyUpfrontPrice

      public boolean isSpecifyUpfrontPrice()
      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 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 price. Otherwise, the upfront price defaults to zero.

    • getPrice

      public javax.money.MonetaryAmount getPrice()
      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.

    • getAdjustmentAmount

      public BigDecimal getAdjustmentAmount()
      The amount to adjust a price Only valid for a PriceListType.ADJUSTMENT type price list.

    • getAdjustmentOperationType

      public String getAdjustmentOperationType()
      Indicates the type of operation to use when #isForMarkup() is true}.
      See Also:

    • getAdjustmentPriceListRelationType

      public String getAdjustmentPriceListRelationType()
      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:

    • getRecurringPrice

      public javax.money.MonetaryAmount getRecurringPrice()
      The amount of the recurring price. Optional. Requires recurringPeriodFrequency, recurringPeriodType, termDurationLength, and termDurationType.
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0

    • getUsagePrice

      public javax.money.MonetaryAmount getUsagePrice()
      The amount of the usage price. Optional. Requires usageUnits and usageAmount.
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0

    • getActiveStartDate

      public Instant getActiveStartDate()
      Defines the beginning time for which this price data is active.

    • getActiveEndDate

      public Instant getActiveEndDate()
      Defines the ending time for which this price data is active

    • getTiers

      public List<PriceDataTier> getTiers()
      Defines specific pricing for minimum quantities.

    • getStartingQuantity

      public Integer getStartingQuantity()
      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.

    • getAvailableQuantity

      public Integer getAvailableQuantity()
      Defines the actual quantity available for this price data as the sale progresses. Initially it is set to the startingQuantity and is deducted as it gets used.
      See Also:

    • getName

      public String getName()
      The name for this price data.

    • getDescription

      public String getDescription()
      The description for this price data.

    • getUsageAmount

      public BigDecimal getUsageAmount()
      The unit of measure's amount for the usage price. Required for usagePrice. Requires usageUnits.
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0
      See Also:
      • usagePrice
      • usageUnits

    • getUsageUnits

      public String getUsageUnits()
      The type of units used for the usage price. Required for usagePrice.
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0
      See Also:
      • usagePrice
      • usageAmount

    • getPaymentStrategy

      public String getPaymentStrategy()
      The payment strategy of the price data, e.g. ONE_TIME, PREPAID, POSTPAID
      Since:
      Pricing Service 2.1.0
      See Also:
      • recurringPrice
      • termDurationLength
      • DefaultPaymentStrategy

    • getRecurringPeriodFrequency

      public Integer getRecurringPeriodFrequency()
      The frequency with which to charge the recurringPrice.
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0
      See Also:
      • recurringPrice
      • recurringPeriodType

    • getRecurringPeriodType

      public String getRecurringPeriodType()
      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:
      • recurringPrice
      • recurringPeriodFrequency
      • DefaultRecurringPeriodType

    • getRecurringPeriodLimit

      public Integer getRecurringPeriodLimit()
      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:
      • recurringPrice
      • recurringPeriodType
      • recurringPeriodFrequency

    • getTermDurationLength

      public Integer getTermDurationLength()
      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:
      • recurringPrice
      • termDurationType

    • getTermDurationType

      public String getTermDurationType()
      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:
      • recurringPrice
      • termDurationLength
      • DefaultTermDurationType

    • getPriority

      public Integer getPriority()
      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

    • getAttributes

      public Map<String,Object> getAttributes()
      Additional miscellaneous attributes to store about this price data.
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0

    • getTierPricingStrategy

      public String getTierPricingStrategy()
      The strategy used to determine tier pricing.
      Since:
      Pricing Service 2.2.0, Release Train 2.3.0
      See Also:

    • getTierAttributeName

      public String getTierAttributeName()
      The name of the attribute used for two-tier pricing.
      Since:
      Pricing Service 2.2.0, Release Train 2.3.0

    • getContextState

      public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Returns:
      a subset of Tracking information to expose the context state for this object

    • getCancellationPolicyRef

      public String getCancellationPolicyRef()
      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

    • setId

      public void setId(String id)

    • setPriceListId

      public void setPriceListId(String priceListId)
      The contextId of the parent price list.
      See Also:

    • setPriceListName

      public void setPriceListName(String priceListName)
      See Also:

    • setTarget

      public void setTarget(com.broadleafcommerce.pricing.client.domain.PriceableTargetRef target)
      See Also:
      • PriceableTargetRef
      • PriceableTarget

    • setSpecifyUpfrontPrice

      public void setSpecifyUpfrontPrice(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 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 price. Otherwise, the upfront price defaults to zero.

    • setPrice

      public void setPrice(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.

    • setAdjustmentAmount

      public void setAdjustmentAmount(BigDecimal adjustmentAmount)
      The amount to adjust a price Only valid for a PriceListType.ADJUSTMENT type price list.

    • setAdjustmentOperationType

      public void setAdjustmentOperationType(String adjustmentOperationType)
      Indicates the type of operation to use when #isForMarkup() is true}.
      See Also:

    • setAdjustmentPriceListRelationType

      public void setAdjustmentPriceListRelationType(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:

    • setRecurringPrice

      public void setRecurringPrice(javax.money.MonetaryAmount recurringPrice)
      The amount of the recurring price. Optional. Requires recurringPeriodFrequency, recurringPeriodType, termDurationLength, and termDurationType.
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0

    • setUsagePrice

      public void setUsagePrice(javax.money.MonetaryAmount usagePrice)
      The amount of the usage price. Optional. Requires usageUnits and usageAmount.
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0

    • setActiveStartDate

      public void setActiveStartDate(Instant activeStartDate)
      Defines the beginning time for which this price data is active.

    • setActiveEndDate

      public void setActiveEndDate(Instant activeEndDate)
      Defines the ending time for which this price data is active

    • setTiers

      public void setTiers(List<PriceDataTier> tiers)
      Defines specific pricing for minimum quantities.

    • setStartingQuantity

      public void setStartingQuantity(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.

    • setAvailableQuantity

      public void setAvailableQuantity(Integer availableQuantity)
      Defines the actual quantity available for this price data as the sale progresses. Initially it is set to the startingQuantity and is deducted as it gets used.
      See Also:

    • setName

      public void setName(String name)
      The name for this price data.

    • setDescription

      public void setDescription(String description)
      The description for this price data.

    • setUsageAmount

      public void setUsageAmount(BigDecimal usageAmount)
      The unit of measure's amount for the usage price. Required for usagePrice. Requires usageUnits.
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0
      See Also:
      • usagePrice
      • usageUnits

    • setUsageUnits

      public void setUsageUnits(String usageUnits)
      The type of units used for the usage price. Required for usagePrice.
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0
      See Also:
      • usagePrice
      • usageAmount

    • setPaymentStrategy

      public void setPaymentStrategy(String paymentStrategy)
      The payment strategy of the price data, e.g. ONE_TIME, PREPAID, POSTPAID
      Since:
      Pricing Service 2.1.0
      See Also:
      • recurringPrice
      • termDurationLength
      • DefaultPaymentStrategy

    • setRecurringPeriodFrequency

      public void setRecurringPeriodFrequency(Integer recurringPeriodFrequency)
      The frequency with which to charge the recurringPrice.
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0
      See Also:
      • recurringPrice
      • recurringPeriodType

    • setRecurringPeriodType

      public void setRecurringPeriodType(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:
      • recurringPrice
      • recurringPeriodFrequency
      • DefaultRecurringPeriodType

    • setRecurringPeriodLimit

      public void setRecurringPeriodLimit(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:
      • recurringPrice
      • recurringPeriodType
      • recurringPeriodFrequency

    • setTermDurationLength

      public void setTermDurationLength(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:
      • recurringPrice
      • termDurationType

    • setTermDurationType

      public void setTermDurationType(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:
      • recurringPrice
      • termDurationLength
      • DefaultTermDurationType

    • setPriority

      public void setPriority(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

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Additional miscellaneous attributes to store about this price data.
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0

    • setTierPricingStrategy

      public void setTierPricingStrategy(String tierPricingStrategy)
      The strategy used to determine tier pricing.
      Since:
      Pricing Service 2.2.0, Release Train 2.3.0
      See Also:

    • setTierAttributeName

      public void setTierAttributeName(String tierAttributeName)
      The name of the attribute used for two-tier pricing.
      Since:
      Pricing Service 2.2.0, Release Train 2.3.0

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Parameters:
      contextState - a subset of Tracking information to expose the context state for this object

    • setCancellationPolicyRef

      public void setCancellationPolicyRef(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

    • 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