Package com.broadleafcommerce.pricing.client.domain

Class PriceTypeDetail

java.lang.Object
com.broadleafcommerce.pricing.client.domain.PriceTypeDetail
All Implemented Interfaces:
Serializable
public class PriceTypeDetail extends Object implements Serializable
Aggregation of PriceDetails for a specific type of price along with the price and currency of the "best" of all the candidate PriceLists.
Author:
Nathan Moore (nathandmoore)
See Also:

  • Constructor Details

    • PriceTypeDetail

      public PriceTypeDetail()

  • Method Details

    • getType

      public String getType()
      The corresponding type of the price: salePrice, standardPrice, contractPrice, etc.
      Returns:
      The corresponding type of the price: salePrice, standardPrice, contractPrice, etc.

    • getBestPrice

      public javax.money.MonetaryAmount getBestPrice()
      The determined best price value for this type of price from amongst all the candidates.
      Returns:
      The determined best price value for this type of price from amongst all the candidates.

    • getBestRecurringPriceDetail

      public RecurringPriceDetail getBestRecurringPriceDetail()
      Represents the details related to a recurring (or subscription) price include the terms.
      Since:
      Pricing Client 2.0.3

    • getBestUsagePriceDetail

      public UsagePriceDetail getBestUsagePriceDetail()
      Represents the details related to a usage price including the units.
      Since:
      Pricing Client 2.0.3

    • getPriceListId

      public String getPriceListId()
      String representation of the PriceList that provided bestPrice.
      Returns:
      String representation of the PriceList that provided bestPrice.
      See Also:

    • getPriceDetails

      public Map<String,PriceDetail> getPriceDetails()
      A map for every candidate PriceList for the type, with the key being a PriceListRef.getId().
      Returns:
      A map for every candidate PriceList for the type, with the key being a PriceListRef.getId().
      See Also:

    • setType

      public void setType(String type)
      The corresponding type of the price: salePrice, standardPrice, contractPrice, etc.
      Parameters:
      type - The corresponding type of the price: salePrice, standardPrice, contractPrice, etc.

    • setBestPrice

      public void setBestPrice(javax.money.MonetaryAmount bestPrice)
      The determined best price value for this type of price from amongst all the candidates.
      Parameters:
      bestPrice - The determined best price value for this type of price from amongst all the candidates.

    • setBestRecurringPriceDetail

      public void setBestRecurringPriceDetail(RecurringPriceDetail bestRecurringPriceDetail)
      Represents the details related to a recurring (or subscription) price include the terms.
      Since:
      Pricing Client 2.0.3

    • setBestUsagePriceDetail

      public void setBestUsagePriceDetail(UsagePriceDetail bestUsagePriceDetail)
      Represents the details related to a usage price including the units.
      Since:
      Pricing Client 2.0.3

    • setPriceListId

      public void setPriceListId(String priceListId)
      String representation of the PriceList that provided bestPrice.
      Parameters:
      priceListId - String representation of the PriceList that provided bestPrice.
      See Also:

    • setPriceDetails

      public void setPriceDetails(Map<String,PriceDetail> priceDetails)
      A map for every candidate PriceList for the type, with the key being a PriceListRef.getId().
      Parameters:
      priceDetails - A map for every candidate PriceList for the type, with the key being a PriceListRef.getId().
      See Also:

    • 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