Package com.broadleafcommerce.pricing.domain

Class PriceListPriceDetail

java.lang.Object
com.broadleafcommerce.pricing.domain.PriceListPriceDetail
All Implemented Interfaces:
com.broadleafcommerce.pricing.client.domain.PriceDetailComparable, Serializable
public class PriceListPriceDetail extends Object implements Serializable, com.broadleafcommerce.pricing.client.domain.PriceDetailComparable
DTO containing the details of a price from a price list.
Since:
1.7.14, 2.0.1
Author:
Sunny Yu
See Also:

  • Constructor Details

    • PriceListPriceDetail

      public PriceListPriceDetail()

  • Method Details

    • hasLimitedQuantity

      public boolean hasLimitedQuantity()

    • getPrice

      public javax.money.MonetaryAmount getPrice()
      Price determined from a PriceList.getPriceModifier() or PriceData.getPrice() for a particular list.
      Specified by:
      getPrice in interface com.broadleafcommerce.pricing.client.domain.PriceDetailComparable
      See Also:
      • PriceDetailComparable.getPrice()

    • getRecurringPriceDetail

      public com.broadleafcommerce.pricing.client.domain.RecurringPriceDetail getRecurringPriceDetail()
      Specified by:
      getRecurringPriceDetail in interface com.broadleafcommerce.pricing.client.domain.PriceDetailComparable
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0
      See Also:
      • PriceDetailComparable.getRecurringPriceDetail()

    • getUsagePriceDetail

      public com.broadleafcommerce.pricing.client.domain.UsagePriceDetail getUsagePriceDetail()
      Specified by:
      getUsagePriceDetail in interface com.broadleafcommerce.pricing.client.domain.PriceDetailComparable
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0
      See Also:
      • PriceDetailComparable.getUsagePriceDetail()

    • getPriceSource

      public String getPriceSource()
      The source of this price within the price list, e.g. price list formula, price list price data, etc.
      See Also:
      • DefaultPriceListPriceSources

    • getPriceDataId

      public String getPriceDataId()
      Id of the specific PriceData that this price came from.

      Only applicable if the priceSource is DefaultPriceListPriceSources.BLC_PRICE_LIST_PRICE_DATA.

    • getPriority

      public Integer getPriority()
      Specified by:
      getPriority in interface com.broadleafcommerce.pricing.client.domain.PriceDetailComparable
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0
      See Also:
      • PriceDetailComparable.getPriority()

    • getPriceListPriority

      public Integer getPriceListPriority()
      Specified by:
      getPriceListPriority in interface com.broadleafcommerce.pricing.client.domain.PriceDetailComparable
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0
      See Also:
      • PriceDetailComparable.getPriceListPriority()

    • getActiveStartDate

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

    • getActiveEndDate

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

    • getStartingQuantity

      public Integer getStartingQuantity()
      Defines the initial quantity available for this price data before a pricing event such as a flash sale. It only serves an informational purpose.

    • getAvailableQuantity

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

    • setPrice

      public void setPrice(javax.money.MonetaryAmount price)
      Price determined from a PriceList.getPriceModifier() or PriceData.getPrice() for a particular list.
      See Also:
      • PriceDetailComparable.getPrice()

    • setRecurringPriceDetail

      public void setRecurringPriceDetail(com.broadleafcommerce.pricing.client.domain.RecurringPriceDetail recurringPriceDetail)
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0
      See Also:
      • PriceDetailComparable.getRecurringPriceDetail()

    • setUsagePriceDetail

      public void setUsagePriceDetail(com.broadleafcommerce.pricing.client.domain.UsagePriceDetail usagePriceDetail)
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0
      See Also:
      • PriceDetailComparable.getUsagePriceDetail()

    • setPriceSource

      public void setPriceSource(String priceSource)
      The source of this price within the price list, e.g. price list formula, price list price data, etc.
      See Also:
      • DefaultPriceListPriceSources

    • setPriceDataId

      public void setPriceDataId(String priceDataId)
      Id of the specific PriceData that this price came from.

      Only applicable if the priceSource is DefaultPriceListPriceSources.BLC_PRICE_LIST_PRICE_DATA.

    • setPriority

      public void setPriority(Integer priority)
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0
      See Also:
      • PriceDetailComparable.getPriority()

    • setPriceListPriority

      public void setPriceListPriority(Integer priceListPriority)
      Since:
      Pricing Service 2.1.0, Release Train 2.2.0
      See Also:
      • PriceDetailComparable.getPriceListPriority()

    • setActiveStartDate

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

    • setActiveEndDate

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

    • 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 only serves an informational purpose.

    • setAvailableQuantity

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

    • 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

    • toString

      public String toString()
      Overrides:
      toString in class Object