org.broadleafcommerce.core.order.service.manipulation
Class DiscreteOrderItemDecorator

java.lang.Object
  org.broadleafcommerce.core.order.service.manipulation.DiscreteOrderItemDecorator

All Implemented Interfaces:

Serializable, DiscreteOrderItem, OrderItem, SkuAccessor

public class DiscreteOrderItemDecorator
extends Object
implements DiscreteOrderItem

See Also:

Serialized Form

Constructor Summary

DiscreteOrderItemDecorator(DiscreteOrderItem discreteOrderItem, int quantity)

Method Summary

void	accept(OrderItemVisitor visitor)
void	addCandidateItemOffer(CandidateItemOffer candidateItemOffer)
void	assignFinalPrice()
OrderItem	clone()
Map<String,String>	getAdditionalAttributes()
Money	getAdjustmentValue() Summation of all of the adjustments associated with this OrderItem
Money	getBaseRetailPrice()
Money	getBaseSalePrice()
BundleOrderItem	getBundleOrderItem() If this item is part of a bundle, this method will return the containing bundle item.
List<CandidateItemOffer>	getCandidateItemOffers()
Category	getCategory()
Money	getCurrentPrice()
List<DiscreteOrderItemFeePrice>	getDiscreteOrderItemFeePrices()
GiftWrapOrderItem	getGiftWrapOrderItem()
Long	getId()
boolean	getIsDiscounted() Whethe or not this
boolean	getIsOnSale() Default implementation uses OrderItem.getSalePrice() < OrderItem.getRetailPrice()
String	getName()
Order	getOrder()
List<OrderItemAdjustment>	getOrderItemAdjustments() Returns a unmodifiable List of OrderItemAdjustment.
Map<String,OrderItemAttribute>	getOrderItemAttributes() A list of arbitrary attributes added to this item.
OrderItemType	getOrderItemType()
PersonalMessage	getPersonalMessage()
Money	getPrice() The final price associated with this OrderItem.
Money	getPriceBeforeAdjustments(boolean allowSalesPrice)
Product	getProduct()
int	getQuantity() The quantity of this OrderItem.
Money	getRetailPrice() The retail price of the item that was added to the Order at the time that this was added.
Money	getSalePrice()
Sku	getSku()
SkuBundleItem	getSkuBundleItem() If this item is part of a bundle that was created via a ProductBundle, then this method returns a reference to the corresponding SkuBundleItem.
Long	getSplitParentItemId() If the system automatically split an item to accommodate the promotion logic (e.g.
Money	getTaxablePrice()
boolean	isInCategory(String categoryName)
Boolean	isTaxable() Returns whether or not this item is taxable.
int	removeAllAdjustments() Removes all adjustment for this order item and reset the adjustment price.
void	removeAllCandidateItemOffers()
void	setAdditionalAttributes(Map<String,String> additionalAttributes)
void	setBaseRetailPrice(Money baseRetailPrice)
void	setBaseSalePrice(Money baseSalePrice)
void	setBundleOrderItem(BundleOrderItem bundleOrderItem) Sets the parent bundle item.
void	setCandidateItemOffers(List<CandidateItemOffer> candidateItemOffers)
void	setCategory(Category category)
void	setDiscreteOrderItemFeePrices(List<DiscreteOrderItemFeePrice> orderItemFeePrices)
void	setGiftWrapOrderItem(GiftWrapOrderItem giftWrapOrderItem)
void	setId(Long id)
void	setName(String name)
void	setOrder(Order order)
void	setOrderItemAdjustments(List<OrderItemAdjustment> orderItemAdjustments)
void	setOrderItemAttributes(Map<String,OrderItemAttribute> orderItemAttributes) Sets the map of order item attributes.
void	setOrderItemType(OrderItemType orderItemType)
void	setPersonalMessage(PersonalMessage personalMessage)
void	setPrice(Money price) Sets the price of this OrderItem while taking into account all taxes, fees, promotions and whether or not the item is on sale.
void	setProduct(Product product)
void	setQuantity(int quantity)
void	setRetailPrice(Money retailPrice) Sets the retail price of the item at the time that it is added to the Order
void	setSalePrice(Money salePrice)
void	setSku(Sku sku)
void	setSkuBundleItem(SkuBundleItem skuBundleItem) Sets the associated skuBundleItem.
void	setSplitParentItemId(Long id)
void	setTaxable(Boolean taxable) Sets whether or not this item is taxable
boolean	updatePrices() Post-condition should be that OrderItem.getPrice() should be the most up-to-date.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiscreteOrderItemDecorator

public DiscreteOrderItemDecorator(DiscreteOrderItem discreteOrderItem,
                                  int quantity)

Method Detail

getSku

public Sku getSku()

Specified by:

getSku in interface DiscreteOrderItem

Specified by:

getSku in interface SkuAccessor

setSku

public void setSku(Sku sku)

Specified by:

setSku in interface DiscreteOrderItem

getProduct

public Product getProduct()

Specified by:

getProduct in interface DiscreteOrderItem

setProduct

public void setProduct(Product product)

Specified by:

setProduct in interface DiscreteOrderItem

getBundleOrderItem

public BundleOrderItem getBundleOrderItem()

Description copied from interface: DiscreteOrderItem

If this item is part of a bundle, this method will return the containing bundle item.

Specified by:

getBundleOrderItem in interface DiscreteOrderItem

Returns:

setBundleOrderItem

public void setBundleOrderItem(BundleOrderItem bundleOrderItem)

Description copied from interface: DiscreteOrderItem

Sets the parent bundle item. Setting to null removes this item from the bundle.

Specified by:

setBundleOrderItem in interface DiscreteOrderItem

getSkuBundleItem

public SkuBundleItem getSkuBundleItem()

If this item is part of a bundle that was created via a ProductBundle, then this method returns a reference to the corresponding SkuBundleItem.

For manually created

For all others, this method returns null.

Specified by:

getSkuBundleItem in interface DiscreteOrderItem

Returns:

setSkuBundleItem

public void setSkuBundleItem(SkuBundleItem skuBundleItem)

Sets the associated skuBundleItem.

Specified by:

setSkuBundleItem in interface DiscreteOrderItem

Parameters:

skuBundleItem -

getTaxablePrice

public Money getTaxablePrice()

Specified by:

getTaxablePrice in interface DiscreteOrderItem

Specified by:

getTaxablePrice in interface OrderItem

getAdditionalAttributes

public Map<String,String> getAdditionalAttributes()

Specified by:

getAdditionalAttributes in interface DiscreteOrderItem

setAdditionalAttributes

public void setAdditionalAttributes(Map<String,String> additionalAttributes)

Specified by:

setAdditionalAttributes in interface DiscreteOrderItem

getBaseRetailPrice

public Money getBaseRetailPrice()

Specified by:

getBaseRetailPrice in interface DiscreteOrderItem

setBaseRetailPrice

public void setBaseRetailPrice(Money baseRetailPrice)

Specified by:

setBaseRetailPrice in interface DiscreteOrderItem

getId

public Long getId()

Specified by:

getId in interface OrderItem

setId

public void setId(Long id)

Specified by:

setId in interface OrderItem

getBaseSalePrice

public Money getBaseSalePrice()

Specified by:

getBaseSalePrice in interface DiscreteOrderItem

getOrder

public Order getOrder()

Specified by:

getOrder in interface OrderItem

setBaseSalePrice

public void setBaseSalePrice(Money baseSalePrice)

Specified by:

setBaseSalePrice in interface DiscreteOrderItem

setOrder

public void setOrder(Order order)

Specified by:

setOrder in interface OrderItem

getRetailPrice

public Money getRetailPrice()

Description copied from interface: OrderItem

The retail price of the item that was added to the Order at the time that this was added. This is preferable to use as opposed to checking the price of the item that was added from the catalog domain (like in DiscreteOrderItem, using DiscreteOrderItem.getSku()'s retail price) since the price in the catalog domain could have changed since the item was added to the Order.

Specified by:

getRetailPrice in interface OrderItem

Returns:

getDiscreteOrderItemFeePrices

public List<DiscreteOrderItemFeePrice> getDiscreteOrderItemFeePrices()

Specified by:

getDiscreteOrderItemFeePrices in interface DiscreteOrderItem

setRetailPrice

public void setRetailPrice(Money retailPrice)

Description copied from interface: OrderItem

Sets the retail price of the item at the time that it is added to the Order

Specified by:

setRetailPrice in interface OrderItem

getSalePrice

public Money getSalePrice()

Specified by:

getSalePrice in interface OrderItem

Returns:

setDiscreteOrderItemFeePrices

public void setDiscreteOrderItemFeePrices(List<DiscreteOrderItemFeePrice> orderItemFeePrices)

Specified by:

setDiscreteOrderItemFeePrices in interface DiscreteOrderItem

setSalePrice

public void setSalePrice(Money salePrice)

Specified by:

setSalePrice in interface OrderItem

getAdjustmentValue

public Money getAdjustmentValue()

Description copied from interface: OrderItem

Summation of all of the adjustments associated with this OrderItem

Specified by:

getAdjustmentValue in interface OrderItem

Returns:

getPrice

public Money getPrice()

Description copied from interface: OrderItem

The final price associated with this OrderItem. Note that this takes into account all of the taxes, fees and promotions that are applied on this OrderItem. This will also use OrderItem.getSalePrice() as a base rather than OrderItem.getRetailPrice() when OrderItem.getIsOnSale() is true.

Specified by:

getPrice in interface OrderItem

Returns:

setPrice

public void setPrice(Money price)

Description copied from interface: OrderItem

Sets the price of this OrderItem while taking into account all taxes, fees, promotions and whether or not the item is on sale.

Specified by:

setPrice in interface OrderItem

assignFinalPrice

public void assignFinalPrice()

Specified by:

assignFinalPrice in interface OrderItem

getCurrentPrice

public Money getCurrentPrice()

Specified by:

getCurrentPrice in interface OrderItem

getQuantity

public int getQuantity()

Description copied from interface: OrderItem

The quantity of this OrderItem.

Specified by:

getQuantity in interface OrderItem

Returns:

setQuantity

public void setQuantity(int quantity)

Specified by:

setQuantity in interface OrderItem

getCategory

public Category getCategory()

Specified by:

getCategory in interface OrderItem

setCategory

public void setCategory(Category category)

Specified by:

setCategory in interface OrderItem

getCandidateItemOffers

public List<CandidateItemOffer> getCandidateItemOffers()

Specified by:

getCandidateItemOffers in interface OrderItem

setCandidateItemOffers

public void setCandidateItemOffers(List<CandidateItemOffer> candidateItemOffers)

Specified by:

setCandidateItemOffers in interface OrderItem

getOrderItemAdjustments

public List<OrderItemAdjustment> getOrderItemAdjustments()

Description copied from interface: OrderItem

Returns a unmodifiable List of OrderItemAdjustment. To modify the List of OrderItemAdjustment, please use the addOrderItemAdjustment or removeAllAdjustments methods.

Specified by:

getOrderItemAdjustments in interface OrderItem

Returns:

a unmodifiable List of OrderItemAdjustment

getPersonalMessage

public PersonalMessage getPersonalMessage()

Specified by:

getPersonalMessage in interface OrderItem

setPersonalMessage

public void setPersonalMessage(PersonalMessage personalMessage)

Specified by:

setPersonalMessage in interface OrderItem

isInCategory

public boolean isInCategory(String categoryName)

Specified by:

isInCategory in interface OrderItem

getGiftWrapOrderItem

public GiftWrapOrderItem getGiftWrapOrderItem()

Specified by:

getGiftWrapOrderItem in interface OrderItem

setGiftWrapOrderItem

public void setGiftWrapOrderItem(GiftWrapOrderItem giftWrapOrderItem)

Specified by:

setGiftWrapOrderItem in interface OrderItem

getOrderItemType

public OrderItemType getOrderItemType()

Specified by:

getOrderItemType in interface OrderItem

setOrderItemType

public void setOrderItemType(OrderItemType orderItemType)

Specified by:

setOrderItemType in interface OrderItem

getIsOnSale

public boolean getIsOnSale()

Description copied from interface: OrderItem

Default implementation uses OrderItem.getSalePrice() < OrderItem.getRetailPrice()

Specified by:

getIsOnSale in interface OrderItem

Returns:

getIsDiscounted

public boolean getIsDiscounted()

Description copied from interface: OrderItem

Whethe or not this

Specified by:

getIsDiscounted in interface OrderItem

Returns:

updatePrices

public boolean updatePrices()

Description copied from interface: OrderItem

Post-condition should be that OrderItem.getPrice() should be the most up-to-date.

Specified by:

updatePrices in interface OrderItem

Returns:

getName

public String getName()

Specified by:

getName in interface OrderItem

setName

public void setName(String name)

Specified by:

setName in interface OrderItem

getPriceBeforeAdjustments

public Money getPriceBeforeAdjustments(boolean allowSalesPrice)

Specified by:

getPriceBeforeAdjustments in interface OrderItem

clone

public OrderItem clone()

Specified by:

clone in interface OrderItem

Overrides:

clone in class Object

setOrderItemAdjustments

public void setOrderItemAdjustments(List<OrderItemAdjustment> orderItemAdjustments)

Specified by:

setOrderItemAdjustments in interface OrderItem

addCandidateItemOffer

public void addCandidateItemOffer(CandidateItemOffer candidateItemOffer)

Specified by:

addCandidateItemOffer in interface OrderItem

removeAllCandidateItemOffers

public void removeAllCandidateItemOffers()

Specified by:

removeAllCandidateItemOffers in interface OrderItem

removeAllAdjustments

public int removeAllAdjustments()

Description copied from interface: OrderItem

Removes all adjustment for this order item and reset the adjustment price.

Specified by:

removeAllAdjustments in interface OrderItem

accept

public void accept(OrderItemVisitor visitor)
            throws PricingException

Specified by:

accept in interface OrderItem

Throws:

PricingException

getOrderItemAttributes

public Map<String,OrderItemAttribute> getOrderItemAttributes()

A list of arbitrary attributes added to this item.

Specified by:

getOrderItemAttributes in interface OrderItem

setOrderItemAttributes

public void setOrderItemAttributes(Map<String,OrderItemAttribute> orderItemAttributes)

Sets the map of order item attributes.

Specified by:

setOrderItemAttributes in interface OrderItem

Parameters:

orderItemAttributes -

isTaxable

public Boolean isTaxable()

Description copied from interface: OrderItem

Returns whether or not this item is taxable. If this flag is not set, it returns true by default

Specified by:

isTaxable in interface OrderItem

Returns:

the taxable flag. If null, returns true

setTaxable

public void setTaxable(Boolean taxable)

Description copied from interface: OrderItem

Sets whether or not this item is taxable

Specified by:

setTaxable in interface OrderItem

getSplitParentItemId

public Long getSplitParentItemId()

If the system automatically split an item to accommodate the promotion logic (e.g. buy one get one free), then this value is set to the originalItemId.

Returns null otherwise.

Specified by:

getSplitParentItemId in interface OrderItem

Returns:

setSplitParentItemId

public void setSplitParentItemId(Long id)

Specified by:

setSplitParentItemId in interface OrderItem