com.broadleafcommerce.cartoperation.service.util.offer

Class CartItemOfferUtils

java.lang.Object

com.broadleafcommerce.cartoperation.service.util.offer.CartItemOfferUtils

public class CartItemOfferUtils
extends Object

Utility class to aid in processing CartItems regarding offers.

Author:

Sunny Yu

Constructor Summary

Constructors

Constructor and Description
CartItemOfferUtils(com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Summary

Modifier and Type	Method and Description
void	addTargetCartItemDetail(com.broadleafcommerce.cart.client.domain.CartItem cartItem, com.broadleafcommerce.order.common.domain.OfferItemDetail targetItemDetail) Adds the offer target OfferItemDetail to the given CartItem.
protected List<com.broadleafcommerce.order.common.domain.OfferItemDetail>	convertItemDetails(Object details) Converts the given Object to a List of OfferItemDetails.
protected Optional<com.broadleafcommerce.order.common.domain.OfferItemDetail>	findMatchingDetail(List<com.broadleafcommerce.order.common.domain.OfferItemDetail> offerItemDetails, com.broadleafcommerce.order.common.domain.OfferItemDetail offerItemDetail) Finds the matching OfferItemDetail based on OfferItemDetail.getItemId() and OfferItemDetail.getOfferId() from the given list of OfferItemDetails.
protected com.fasterxml.jackson.databind.ObjectMapper	getMapper()
String	getOriginOfferId(com.broadleafcommerce.cart.client.domain.CartItem cartItem) Gets the id of the offer that this CartItem was a target of.
List<com.broadleafcommerce.order.common.domain.OfferItemDetail>	getQualifierCartItemDetails(com.broadleafcommerce.cart.client.domain.CartItem cartItem) Gets the offer qualifier OfferItemDetails that the given CartItem was a target of.
List<String>	getQualifierCartItemIds(com.broadleafcommerce.cart.client.domain.CartItem cartItem) The ids of the offer qualifier CartItems that the given CartItem was added from.
List<com.broadleafcommerce.order.common.domain.OfferItemDetail>	getTargetCartItemDetails(com.broadleafcommerce.cart.client.domain.CartItem cartItem) Gets the offer target OfferItemDetails that the given CartItem was a qualifier of.
List<String>	getTargetCartItemIds(com.broadleafcommerce.cart.client.domain.CartItem cartItem) The ids of the offer target CartItems that the given CartItem was a qualifier of.
boolean	isFreeGiftItem(com.broadleafcommerce.cart.client.domain.CartItem cartItem) Identifies if the given CartItem is a free gift item.
void	removeIsFreeGiftItemFlag(com.broadleafcommerce.cart.client.domain.CartItem cartItem) Removes the CartItemAttributeConstants.Internal.IS_FREE_GIFT_ITEM attribute from the given CartItem.getInternalAttributes().
void	removeQualifierAndTargetDetails(com.broadleafcommerce.cart.client.domain.CartItem cartItem, String itemIdToRemove) Remove all qualifier and target OfferItemDetails that match the given OfferItemDetail.getItemId().
void	setQualifierCartItemDetails(com.broadleafcommerce.cart.client.domain.CartItem cartItem, List<com.broadleafcommerce.order.common.domain.OfferItemDetail> qualifierItemDetails) Sets the offer qualifier OfferItemDetails that the given CartItem was a target of.
void	setTargetCartItemDetails(com.broadleafcommerce.cart.client.domain.CartItem cartItem, List<com.broadleafcommerce.order.common.domain.OfferItemDetail> targetItemDetails) Sets the offer target OfferItemDetails that the given CartItem was a qualifier of.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CartItemOfferUtils

public CartItemOfferUtils(com.fasterxml.jackson.databind.ObjectMapper mapper)

Method Detail

isFreeGiftItem

public boolean isFreeGiftItem(com.broadleafcommerce.cart.client.domain.CartItem cartItem)

Identifies if the given CartItem is a free gift item.

Parameters:

cartItem - CartItem to check against

Returns:

true if the given CartItem is a free gift item, otherwise false

removeIsFreeGiftItemFlag

public void removeIsFreeGiftItemFlag(com.broadleafcommerce.cart.client.domain.CartItem cartItem)

Removes the CartItemAttributeConstants.Internal.IS_FREE_GIFT_ITEM attribute from the given CartItem.getInternalAttributes().

Parameters:

cartItem - CartItem to remove the CartItemAttributeConstants.Internal.IS_FREE_GIFT_ITEM from

getQualifierCartItemIds

public List<String> getQualifierCartItemIds(com.broadleafcommerce.cart.client.domain.CartItem cartItem)

The ids of the offer qualifier CartItems that the given CartItem was added from.

Parameters:

cartItem - CartItem to get the offer qualifier cart item ids from

Returns:

The ids of the offer qualifier CartItems that the given CartItem was added from

See Also:

CartItemAttributeConstants.Internal.QUALIFIER_CART_ITEM_DETAILS

getQualifierCartItemDetails

public List<com.broadleafcommerce.order.common.domain.OfferItemDetail> getQualifierCartItemDetails(com.broadleafcommerce.cart.client.domain.CartItem cartItem)

Gets the offer qualifier OfferItemDetails that the given CartItem was a target of.

Parameters:

cartItem - the CartItem to get the offer qualifier OfferItemDetails from

Returns:

the offer qualifier OfferItemDetails that the given CartItem was a target of

See Also:

CartItemAttributeConstants.Internal.QUALIFIER_CART_ITEM_DETAILS

setQualifierCartItemDetails

public void setQualifierCartItemDetails(com.broadleafcommerce.cart.client.domain.CartItem cartItem,
                                        List<com.broadleafcommerce.order.common.domain.OfferItemDetail> qualifierItemDetails)

Sets the offer qualifier OfferItemDetails that the given CartItem was a target of.

Parameters:

cartItem - CartItem to set the offer qualifier OfferItemDetails for

qualifierItemDetails - the offer qualifier OfferItemDetails

See Also:

CartItemAttributeConstants.Internal.QUALIFIER_CART_ITEM_DETAILS

getTargetCartItemIds

public List<String> getTargetCartItemIds(com.broadleafcommerce.cart.client.domain.CartItem cartItem)

The ids of the offer target CartItems that the given CartItem was a qualifier of.

Parameters:

cartItem - CartItem to get the offer target cart item ids from

Returns:

The ids of the offer target CartItems that the given CartItem was a qualifier of

See Also:

CartItemAttributeConstants.Internal.TARGET_CART_ITEM_DETAILS

getTargetCartItemDetails

public List<com.broadleafcommerce.order.common.domain.OfferItemDetail> getTargetCartItemDetails(com.broadleafcommerce.cart.client.domain.CartItem cartItem)

Gets the offer target OfferItemDetails that the given CartItem was a qualifier of.

Parameters:

cartItem - the CartItem to get the offer target OfferItemDetails from

Returns:

the offer target OfferItemDetails that the given CartItem was a qualifier of

See Also:

CartItemAttributeConstants.Internal.TARGET_CART_ITEM_DETAILS

addTargetCartItemDetail

public void addTargetCartItemDetail(com.broadleafcommerce.cart.client.domain.CartItem cartItem,
                                    com.broadleafcommerce.order.common.domain.OfferItemDetail targetItemDetail)

Adds the offer target OfferItemDetail to the given CartItem.

Parameters:

cartItem - the CartItem to add the offer target OfferItemDetail to

findMatchingDetail

protected Optional<com.broadleafcommerce.order.common.domain.OfferItemDetail> findMatchingDetail(List<com.broadleafcommerce.order.common.domain.OfferItemDetail> offerItemDetails,
                                                                                                 com.broadleafcommerce.order.common.domain.OfferItemDetail offerItemDetail)

Finds the matching OfferItemDetail based on OfferItemDetail.getItemId() and OfferItemDetail.getOfferId() from the given list of OfferItemDetails.

Parameters:

offerItemDetails - the list of OfferItemDetails to look against

offerItemDetail - the OfferItemDetail to look for

Returns:

the matching OfferItemDetail based on OfferItemDetail.getItemId() and OfferItemDetail.getOfferId() from the given list of OfferItemDetails

setTargetCartItemDetails

public void setTargetCartItemDetails(com.broadleafcommerce.cart.client.domain.CartItem cartItem,
                                     List<com.broadleafcommerce.order.common.domain.OfferItemDetail> targetItemDetails)

Sets the offer target OfferItemDetails that the given CartItem was a qualifier of.

Parameters:

cartItem - CartItem to set the offer target OfferItemDetails for

targetItemDetails - the offer target OfferItemDetails

See Also:

CartItemAttributeConstants.Internal.TARGET_CART_ITEM_DETAILS

convertItemDetails

protected List<com.broadleafcommerce.order.common.domain.OfferItemDetail> convertItemDetails(Object details)

Converts the given Object to a List of OfferItemDetails.

Parameters:

details - the Object to convert from

Returns:

a List of OfferItemDetails converted from Object

removeQualifierAndTargetDetails

public void removeQualifierAndTargetDetails(com.broadleafcommerce.cart.client.domain.CartItem cartItem,
                                            String itemIdToRemove)

Remove all qualifier and target OfferItemDetails that match the given OfferItemDetail.getItemId().

Parameters:

cartItem - the CartItem to remove the qualifier and target OfferItemDetails from

itemIdToRemove - the item id of the OfferItemDetails to remove

getOriginOfferId

public String getOriginOfferId(com.broadleafcommerce.cart.client.domain.CartItem cartItem)

Gets the id of the offer that this CartItem was a target of. In other words, this id identifies which offer this CartItem was added from.

Parameters:

cartItem - CartItem to get the target offer id from

Returns:

the id of the offer that this CartItem was a target of

See Also:

CartItemAttributeConstants.Internal.ORIGIN_OFFER_ID

getMapper

protected com.fasterxml.jackson.databind.ObjectMapper getMapper()