java.lang.Object
- com.broadleafcommerce.promotion.offer.web.context.EnhancedLineItem

All Implemented Interfaces:

com.broadleafcommerce.promotion.offer.client.web.context.LineItem, Serializable

Direct Known Subclasses:

EnhancedFulfillmentLineItem, EnhancedOrderLineItem
```
public class EnhancedLineItem
extends Object
implements com.broadleafcommerce.promotion.offer.client.web.context.LineItem, Serializable
```
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

EnhancedLineItem()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`javax.money.MonetaryAmount`	`calculateTotalAdjustmentValue(boolean useSaleAdjustments)`
`javax.money.MonetaryAmount`	`calculateTotalWithAdjustments()`
`protected boolean`	`canEqual(Object other)`
`LineItemOfferDetail`	`createNewDetail(com.broadleafcommerce.common.extension.TypeFactory offerFactory, int quantity)`	Creates a new `LineItemOfferDetail` for this item.
`boolean`	`equals(Object o)`
`void`	`finalizePrice()`	Sets `getFinalPrice()` to the `average price` of each item, which includes adjustments.
`javax.money.MonetaryAmount`	`getAdjustedTotalWithoutFutureCredits()`
`Map<String,Object>`	`getAttributes()`
`javax.money.MonetaryAmount`	`getAveragePrice()`
`javax.money.CurrencyUnit`	`getCurrency()`
`javax.money.MonetaryAmount`	`getFinalPrice()`	The final price, including adjustments, for a single merchandising item represented by this order line item.
`javax.money.MonetaryAmount`	`getFinalTotalAdjustmentValue()`
`javax.money.MonetaryAmount`	`getFutureCreditAdjustmentValue()`
`javax.money.MonetaryAmount`	`getFutureCredits()`
`String`	`getId()`
`String`	`getLineNumber()`
`List<LineItemOfferDetail>`	`getOfferDetails()`	DTOs containing information about `offers` applicable to this item.
`javax.money.MonetaryAmount`	`getPrice(boolean useSalePrice)`	Convenience method to get either the `getSalePrice()` or `getStandardPrice()` depending on the flag.
`List<com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment>`	`getProratedAdjustments()`	Prorated offer adjustment information for this line item.
`int`	`getQuantity()`
`javax.money.MonetaryAmount`	`getSalePrice()`
`javax.money.MonetaryAmount`	`getStandardPrice()`
`javax.money.MonetaryAmount`	`getTotalPrice()`	Gets the total combined price of this order item, including any adjustments.
`javax.money.MonetaryAmount`	`getTotalPriceWithoutAdjustments()`
`javax.money.MonetaryAmount`	`getTotalStandardPrice()`
`javax.money.MonetaryAmount`	`getUnadjustedSalePrice()`
`boolean`	`hasAdjustments()`
`int`	`hashCode()`
`void`	`initializePriceDetails(com.broadleafcommerce.common.extension.TypeFactory offerFactory)`	Ensures that an `LineItemOfferDetail` is present so that the offer engine engages correctly.
`boolean`	`isDependent()`	Whether this item is an Add-on/dependant type, that is, an item that cannot be sold or fulfilled on its own but as a child of another item.
`boolean`	`isDiscountable()`
`boolean`	`isOnSale()`
`boolean`	`isSubscription()`
`protected void`	`mergeDetails(LineItemOfferDetail firstDetail, LineItemOfferDetail secondDetail)`
`void`	`mergeLikeDetails()`	Merges any priceDetails that share the same orderAdjustments.
`void`	`resetOfferDetails()`	Removes all `LineItemOfferDetails` except the first, which just gets reset.
`void`	`resetPriceDetails(com.broadleafcommerce.common.extension.TypeFactory offerFactory)`	Clears all `offerDetails` and re-initializes them.
`void`	`setAttributes(Map<String,Object> attributes)`
`void`	`setCurrency(javax.money.CurrencyUnit currency)`
`void`	`setDiscountable(boolean discountable)`
`void`	`setFinalPrice(javax.money.MonetaryAmount finalPrice)`	The final price, including adjustments, for a single merchandising item represented by this order line item.
`void`	`setId(String id)`	Matches the line number unless the line number isn't available in which case it will represent a uuid.
`void`	`setLineNumber(String lineNumber)`
`void`	`setOfferDetails(List<LineItemOfferDetail> offerDetails)`	DTOs containing information about `offers` applicable to this item.
`void`	`setProratedAdjustments(List<com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment> proratedAdjustments)`	Prorated offer adjustment information for this line item.
`void`	`setQuantity(int quantity)`
`void`	`setSalePrice(javax.money.MonetaryAmount salePrice)`
`void`	`setStandardPrice(javax.money.MonetaryAmount standardPrice)`
`void`	`setSubscription(boolean isSubscription)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - EnhancedLineItem
```
public EnhancedLineItem()
```
- Method Detail
  - getUnadjustedSalePrice
```
public javax.money.MonetaryAmount getUnadjustedSalePrice()
```
    Returns:
    
    the getSalePrice() if present with no adjustments, otherwise the getStandardPrice().
  - getTotalStandardPrice
```
public javax.money.MonetaryAmount getTotalStandardPrice()
```
    Returns:
    
    getStandardPrice() multiplied by getQuantity().
  - getPrice
```
public javax.money.MonetaryAmount getPrice(boolean useSalePrice)
```
    Convenience method to get either the getSalePrice() or getStandardPrice() depending on the flag. If salePrice == null, then returns getStandardPrice() no matter the value of the flag.
    
    Parameters:
    
    useSalePrice - whether to return getSalePrice() if it exists or getStandardPrice() ()}
    
    Returns:
    
    either the getSalePrice() or getStandardPrice() depending on the flag
  - isDependent
```
public boolean isDependent()
```
    Whether this item is an Add-on/dependant type, that is, an item that cannot be sold or fulfilled on its own but as a child of another item.
    
    Returns:
    
    Whether this item is an Add-on/dependant type
  - calculateTotalWithAdjustments
```
public javax.money.MonetaryAmount calculateTotalWithAdjustments()
```
    Returns:
    
    the item total including all LineItemOfferDetail.getAdjustments().
  - isOnSale
```
public boolean isOnSale()
```
    Returns:
    
    whether this item has a sale price and that it is less than the standard price
  - resetPriceDetails
```
public void resetPriceDetails(@NonNull
                              com.broadleafcommerce.common.extension.TypeFactory offerFactory)
```
    Clears all offerDetails and re-initializes them.
    
    Parameters:
    
    offerFactory - the TypeFactory to use to create any new LineItemOfferDetails during re-initialization.
  - initializePriceDetails
```
public void initializePriceDetails(@NonNull
                                   com.broadleafcommerce.common.extension.TypeFactory offerFactory)
```
    Ensures that an LineItemOfferDetail is present so that the offer engine engages correctly.
    
    Parameters:
    
    offerFactory - the TypeFactory to use to create a new LineItemOfferDetail
  - createNewDetail
```
public LineItemOfferDetail createNewDetail(@NonNull
                                           com.broadleafcommerce.common.extension.TypeFactory offerFactory,
                                           int quantity)
```
    Creates a new LineItemOfferDetail for this item.
    
    Parameters:
    
    offerFactory - the TypeFactory to use to create any new LineItemOfferDetails
    
    quantity - the item quantity to associate with the new detail
    
    Returns:
    
    the new LineItemOfferDetail
  - mergeLikeDetails
```
public void mergeLikeDetails()
```
    Merges any priceDetails that share the same orderAdjustments.
  - getFinalTotalAdjustmentValue
```
public javax.money.MonetaryAmount getFinalTotalAdjustmentValue()
```
    Returns:
    
    the total of all adjustments not including dependent items
  - getFutureCreditAdjustmentValue
```
public javax.money.MonetaryAmount getFutureCreditAdjustmentValue()
```
  - calculateTotalAdjustmentValue
```
public javax.money.MonetaryAmount calculateTotalAdjustmentValue(boolean useSaleAdjustments)
```
  - resetOfferDetails
```
public void resetOfferDetails()
```
    Removes all LineItemOfferDetails except the first, which just gets reset.
  - finalizePrice
```
public void finalizePrice()
```
    Sets getFinalPrice() to the average price of each item, which includes adjustments.
  - getAveragePrice
```
public javax.money.MonetaryAmount getAveragePrice()
```
    Returns:
    
    the total combined price of this order item, including any orderAdjustments but not dependent items, divided by getQuantity().
  - getTotalPriceWithoutAdjustments
```
public javax.money.MonetaryAmount getTotalPriceWithoutAdjustments()
```
    Returns:
    
    the price without adjustments multiplied by the quantity of items, using the sale price if present.
  - getTotalPrice
```
public javax.money.MonetaryAmount getTotalPrice()
```
    Gets the total combined price of this order item, including any adjustments.
    
    Returns:
    
    the total combined price of this order item, including any adjustments.
  - mergeDetails
```
protected void mergeDetails(LineItemOfferDetail firstDetail,
                            LineItemOfferDetail secondDetail)
```
  - getFutureCredits
```
public javax.money.MonetaryAmount getFutureCredits()
```
  - getAdjustedTotalWithoutFutureCredits
```
public javax.money.MonetaryAmount getAdjustedTotalWithoutFutureCredits()
```
  - getId
```
public String getId()
```
  - hasAdjustments
```
public boolean hasAdjustments()
```
  - getCurrency
```
public javax.money.CurrencyUnit getCurrency()
```
  - getLineNumber
```
public String getLineNumber()
```
    Specified by:
    
    getLineNumber in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
  - getStandardPrice
```
public javax.money.MonetaryAmount getStandardPrice()
```
    Specified by:
    
    getStandardPrice in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
  - getSalePrice
```
public javax.money.MonetaryAmount getSalePrice()
```
    Specified by:
    
    getSalePrice in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
  - getQuantity
```
public int getQuantity()
```
    Specified by:
    
    getQuantity in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
  - isDiscountable
```
public boolean isDiscountable()
```
    Specified by:
    
    isDiscountable in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
  - isSubscription
```
public boolean isSubscription()
```
    Specified by:
    
    isSubscription in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
  - getAttributes
```
public Map<String,Object> getAttributes()
```
    Specified by:
    
    getAttributes in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
  - getFinalPrice
```
public javax.money.MonetaryAmount getFinalPrice()
```
    The final price, including adjustments, for a single merchandising item represented by this order line item.
    
    Returns:
    
    The final price, including adjustments, for a single merchandising item represented by this order line item.
  - getOfferDetails
```
public List<LineItemOfferDetail> getOfferDetails()
```
    DTOs containing information about offers applicable to this item.
    
    Returns:
    
    DTOs containing information about offers applicable to this item.
  - getProratedAdjustments
```
public List<com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment> getProratedAdjustments()
```
    Prorated offer adjustment information for this line item.
    This is typically used to communicate the adjustments prorated to this item from order-level or fulfillment group-level offer adjustments.
    
    Returns:
    
    DTOs containing prorated offer adjustment information for this line item
  - setCurrency
```
public void setCurrency(javax.money.CurrencyUnit currency)
```
  - setLineNumber
```
public void setLineNumber(String lineNumber)
```
    Specified by:
    
    setLineNumber in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
  - setStandardPrice
```
public void setStandardPrice(javax.money.MonetaryAmount standardPrice)
```
    Specified by:
    
    setStandardPrice in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
  - setSalePrice
```
public void setSalePrice(javax.money.MonetaryAmount salePrice)
```
    Specified by:
    
    setSalePrice in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
  - setQuantity
```
public void setQuantity(int quantity)
```
    Specified by:
    
    setQuantity in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
  - setDiscountable
```
public void setDiscountable(boolean discountable)
```
    Specified by:
    
    setDiscountable in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
  - setSubscription
```
public void setSubscription(boolean isSubscription)
```
    Specified by:
    
    setSubscription in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
  - setAttributes
```
public void setAttributes(Map<String,Object> attributes)
```
    Specified by:
    
    setAttributes in interface com.broadleafcommerce.promotion.offer.client.web.context.LineItem
  - setFinalPrice
```
public void setFinalPrice(javax.money.MonetaryAmount finalPrice)
```
    The final price, including adjustments, for a single merchandising item represented by this order line item.
    
    Parameters:
    
    finalPrice - The final price, including adjustments, for a single merchandising item represented by this order line item.
  - setOfferDetails
```
public void setOfferDetails(List<LineItemOfferDetail> offerDetails)
```
    DTOs containing information about offers applicable to this item.
    
    Parameters:
    
    offerDetails - DTOs containing information about offers applicable to this item.
  - setProratedAdjustments
```
public void setProratedAdjustments(List<com.broadleafcommerce.promotion.offer.client.web.context.info.ProratedOfferAdjustment> proratedAdjustments)
```
    Prorated offer adjustment information for this line item.
    This is typically used to communicate the adjustments prorated to this item from order-level or fulfillment group-level offer adjustments.
    
    Parameters:
    
    proratedAdjustments - DTOs containing prorated offer adjustment information for this line item
  - setId
```
public void setId(String id)
```
    Matches the line number unless the line number isn't available in which case it will represent a uuid.
  - 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

Class EnhancedLineItem

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

EnhancedLineItem

Method Detail

getUnadjustedSalePrice

getTotalStandardPrice

getPrice

isDependent

calculateTotalWithAdjustments

isOnSale

resetPriceDetails

initializePriceDetails

createNewDetail

mergeLikeDetails

getFinalTotalAdjustmentValue

getFutureCreditAdjustmentValue

calculateTotalAdjustmentValue

resetOfferDetails

finalizePrice

getAveragePrice

getTotalPriceWithoutAdjustments

getTotalPrice

mergeDetails

getFutureCredits

getAdjustedTotalWithoutFutureCredits

getId

hasAdjustments

getCurrency

getLineNumber

getStandardPrice

getSalePrice

getQuantity

isDiscountable

isSubscription

getAttributes

getFinalPrice

getOfferDetails

getProratedAdjustments

setCurrency

setLineNumber

setStandardPrice

setSalePrice

setQuantity

setDiscountable

setSubscription

setAttributes

setFinalPrice

setOfferDetails

setProratedAdjustments

setId

toString

equals

canEqual

hashCode