Package com.broadleafcommerce.promotion.offer.client.web.context

Interface LineItem

All Known Subinterfaces:
FulfillmentLineItem, OrderLineItem
All Known Implementing Classes:
FulfillmentLineItemDto, LineItemDto, OrderLineItemDto
public interface LineItem
DTO containing information regarding a item in an Order or FulfillmentGroup. It includes the quantity present, prices, whether the item is discountable, and other attributes like skuCode, name, category, etc.
Author:
Chad Harchar (charchar), Nathan Moore (nathanmoore).
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    Map<String,Object>
    getAttributes()
    Additional, unspecified attributes.
    String
    getLineNumber()
    The line number of this order item.
    int
    getQuantity()
    Number of like merchandising items being sold or fulfilled together in this order.
    javax.money.MonetaryAmount
    getSalePrice()
    Special price at which to sell or fulfill a single merchandising item represented by this order line item.
    default RecurringPriceDetail
    getSaleRecurringPrice()
    Represents the details related to a sale recurring (or subscription) price include the terms.
    default String
    getServiceLevel()
     
    javax.money.MonetaryAmount
    getStandardPrice()
    The standard price at which a single merchandising item represented by this order line item is sold or fulfilled.
    default RecurringPriceDetail
    getStandardRecurringPrice()
    Represents the details related to a recurring (or subscription) price include the terms.
    boolean
    isDiscountable()
    Whether this line item may receive discounts.
    boolean
    isSubscription()
    Whether this is a subscription item and thus qualifies it for future billing discounts.
    void
    setAttributes(Map<String,Object> attributes)
    Additional, unspecified attributes.
    void
    setDiscountable(boolean discountable)
    Whether this line item may receive discounts.
    void
    setLineNumber(String lineNumber)
    The line number of this order item.
    void
    setQuantity(int quantity)
    Number of like merchandising items being sold or fulfilled together in this order.
    void
    setSalePrice(javax.money.MonetaryAmount salePrice)
    Special price at which to sell or fulfill a single merchandising item represented by this order line item.
    default void
    setSaleRecurringPrice(RecurringPriceDetail saleRecurringPrice)
    Set the details related to a sale recurring (or subscription) price include the terms.
    void
    setStandardPrice(javax.money.MonetaryAmount standardPrice)
    The standard price at which a single merchandising item represented by this order line item is sold or fulfilled.
    default void
    setStandardRecurringPrice(RecurringPriceDetail standardRecurringPrice)
    Set the details related to a recurring (or subscription) price include the terms.
    void
    setSubscription(boolean isSubscription)
    Whether this is a subscription item and thus qualifies it for future billing discounts.

  • Method Details

    • getLineNumber

      String getLineNumber()
      The line number of this order item.
      Returns:
      The line number of this order item.

    • setLineNumber

      void setLineNumber(String lineNumber)
      The line number of this order item.
      Parameters:
      lineNumber - The line number of this order item.

    • getStandardPrice

      javax.money.MonetaryAmount getStandardPrice()
      The standard price at which a single merchandising item represented by this order line item is sold or fulfilled. This is typically the field targeted by offers when applying discounts.
      Returns:
      The standard price at which this item is sold or fulfilled.

    • setStandardPrice

      void setStandardPrice(javax.money.MonetaryAmount standardPrice)
      The standard price at which a single merchandising item represented by this order line item is sold or fulfilled. This is typically the field targeted by offers when applying discounts.
      Parameters:
      standardPrice - The standard price at which this item is sold or fulfilled.

    • getSalePrice

      javax.money.MonetaryAmount getSalePrice()
      Special price at which to sell or fulfill a single merchandising item represented by this order line item. This price usually derived from a Sale PriceList. If present, note that not all offers can be applied to it depending on it's configuration.
      Returns:
      Special price at which to sell or fulfill this item.

    • setSalePrice

      void setSalePrice(javax.money.MonetaryAmount salePrice)
      Special price at which to sell or fulfill a single merchandising item represented by this order line item. This price usually derived from a Sale PriceList. If present, note that not all offers can be applied to it depending on it's configuration.
      Parameters:
      salePrice - Special price at which to sell or fulfill this item.

    • getQuantity

      int getQuantity()
      Number of like merchandising items being sold or fulfilled together in this order.
      Returns:
      Number of like merchandising items being sold or fulfilled together in this order.

    • setQuantity

      void setQuantity(int quantity)
      Number of like merchandising items being sold or fulfilled together in this order.
      Parameters:
      quantity - Number of like merchandising items being sold or fulfilled together in this order.

    • isDiscountable

      boolean isDiscountable()
      Whether this line item may receive discounts. If false, then no offer will be applied.
      Returns:
      Whether this item may receive discounts

    • setDiscountable

      void setDiscountable(boolean discountable)
      Whether this line item may receive discounts. If false, then no offer will be applied.
      Parameters:
      discountable - Whether this item may receive discounts.

    • isSubscription

      boolean isSubscription()
      Whether this is a subscription item and thus qualifies it for future billing discounts.
      Returns:
      Whether this is a subscription item and thus qualifies it for future billing discounts.

    • setSubscription

      void setSubscription(boolean isSubscription)
      Whether this is a subscription item and thus qualifies it for future billing discounts.
      Parameters:
      isSubscription - Whether this is a subscription item and thus qualifies it for future billing discounts.

    • getAttributes

      Map<String,Object> getAttributes()
      Additional, unspecified attributes.
      Returns:
      Additional, unspecified attributes

    • setAttributes

      void setAttributes(Map<String,Object> attributes)
      Additional, unspecified attributes.
      Parameters:
      attributes - Additional, unspecified attributes.

    • getServiceLevel

      default String getServiceLevel()

    • getStandardRecurringPrice

      default RecurringPriceDetail getStandardRecurringPrice()
      Represents the details related to a recurring (or subscription) price include the terms. This should come from the same source as getStandardPrice(), and, consequently, getStandardPrice() should not be null even if there is no upfront price, e.g., it should be zero in that case. This method is supported with ReleaseTrain 2.2.0 and beyond with a default implementation that returns null for backward compatibility.
      Returns:
      The details related to a recurring (or subscription) price include the terms.
      Since:
      Offer Client 2.0.2

    • setStandardRecurringPrice

      default void setStandardRecurringPrice(RecurringPriceDetail standardRecurringPrice)
      Set the details related to a recurring (or subscription) price include the terms. This method is supported with ReleaseTrain 2.2.0 and beyond with an empty default implementation for backward compatibility.
      Parameters:
      standardRecurringPrice - The details related to a recurring (or subscription) price include the terms.
      Since:
      Offer Client 2.0.2

    • getSaleRecurringPrice

      default RecurringPriceDetail getSaleRecurringPrice()
      Represents the details related to a sale recurring (or subscription) price include the terms. This should come from the same source as getSalePrice(), and, consequently, getSalePrice() should not be null even if there is no upfront price, e.g., it should be zero in that case. This method is supported with ReleaseTrain 2.2.0 and beyond with a default implementation that returns null for backward compatibility.
      Returns:
      The details related to a recurring (or subscription) price include the terms.
      Since:
      Offer Client 2.0.2

    • setSaleRecurringPrice

      default void setSaleRecurringPrice(RecurringPriceDetail saleRecurringPrice)
      Set the details related to a sale recurring (or subscription) price include the terms. This method is supported with ReleaseTrain 2.2.0 and beyond with an empty default implementation for backward compatibility.
      Parameters:
      saleRecurringPrice - The details related to a recurring (or subscription) price include the terms.
      Since:
      Offer Client 2.0.2