org.broadleafcommerce.core.order.domain
Class OrderItemImpl

java.lang.Object
  org.broadleafcommerce.core.order.domain.OrderItemImpl

All Implemented Interfaces:

Serializable, Cloneable, OrderItem

Direct Known Subclasses:

BundleOrderItemImpl, DiscreteOrderItemImpl

@Entity
public class OrderItemImpl
extends Object
implements OrderItem, Cloneable

See Also:

Serialized Form

Field Summary

protected List<CandidateItemOffer>	candidateItemOffers
protected Category	category
protected GiftWrapOrderItem	giftWrapOrderItem
protected Long	id
protected Boolean	itemTaxable
protected String	name
protected Order	order
protected List<OrderItemAdjustment>	orderItemAdjustments
protected Map<String,OrderItemAttribute>	orderItemAttributeMap
protected String	orderItemType
protected PersonalMessage	personalMessage
protected BigDecimal	price
protected int	quantity
protected BigDecimal	retailPrice
protected BigDecimal	salePrice
protected Long	splitParentItemId

Constructor Summary

OrderItemImpl()

Method Summary

void	accept(OrderItemVisitor visitor)
void	addCandidateItemOffer(CandidateItemOffer candidateItemOffer)
void	assignFinalPrice()
void	checkCloneable(OrderItem orderItem)
OrderItem	clone()
protected OrderItemType	convertOrderItemType(String type)
protected Money	convertToMoney(BigDecimal amount)
boolean	equals(Object obj)
Money	getAdjustmentValue() Summation of all of the adjustments associated with this OrderItem
List<CandidateItemOffer>	getCandidateItemOffers()
Category	getCategory()
Money	getCurrentPrice()
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)
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()
Long	getSplitParentItemId() If the system automatically split an item to accommodate the promotion logic (e.g.
Money	getTaxablePrice()
int	hashCode()
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	setCandidateItemOffers(List<CandidateItemOffer> candidateItemOffers)
void	setCategory(Category category)
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 finalPrice) Sets the price of this OrderItem while taking into account all taxes, fees, promotions and whether or not the item is on sale.
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	setSplitParentItemId(Long splitParentItemId)
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

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

protected Long id

category

protected Category category

order

protected Order order

retailPrice

protected BigDecimal retailPrice

salePrice

protected BigDecimal salePrice

price

protected BigDecimal price

quantity

protected int quantity

name

protected String name

personalMessage

protected PersonalMessage personalMessage

giftWrapOrderItem

protected GiftWrapOrderItem giftWrapOrderItem

orderItemAdjustments

protected List<OrderItemAdjustment> orderItemAdjustments

candidateItemOffers

protected List<CandidateItemOffer> candidateItemOffers

orderItemType

protected String orderItemType

itemTaxable

protected Boolean itemTaxable

orderItemAttributeMap

protected Map<String,OrderItemAttribute> orderItemAttributeMap

splitParentItemId

protected Long splitParentItemId

Constructor Detail

OrderItemImpl

public OrderItemImpl()

Method Detail

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:

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:

setSalePrice

public void setSalePrice(Money salePrice)

Specified by:

setSalePrice in interface OrderItem

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 finalPrice)

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

getTaxablePrice

public Money getTaxablePrice()

Specified by:

getTaxablePrice 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

getPersonalMessage

public PersonalMessage getPersonalMessage()

Specified by:

getPersonalMessage in interface OrderItem

setPersonalMessage

public void setPersonalMessage(PersonalMessage personalMessage)

Specified by:

setPersonalMessage in interface OrderItem

getOrder

public Order getOrder()

Specified by:

getOrder in interface OrderItem

setOrder

public void setOrder(Order order)

Specified by:

setOrder in interface OrderItem

getId

public Long getId()

Specified by:

getId in interface OrderItem

setId

public void setId(Long id)

Specified by:

setId in interface OrderItem

getName

public String getName()

Specified by:

getName in interface OrderItem

setName

public void setName(String name)

Specified by:

setName in interface OrderItem

isInCategory

public boolean isInCategory(String categoryName)

Specified by:

isInCategory 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

setOrderItemAdjustments

public void setOrderItemAdjustments(List<OrderItemAdjustment> orderItemAdjustments)

Specified by:

setOrderItemAdjustments 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:

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:

assignFinalPrice

public void assignFinalPrice()

Specified by:

assignFinalPrice in interface OrderItem

getCurrentPrice

public Money getCurrentPrice()

Specified by:

getCurrentPrice in interface OrderItem

getPriceBeforeAdjustments

public Money getPriceBeforeAdjustments(boolean allowSalesPrice)

Specified by:

getPriceBeforeAdjustments 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

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 -

checkCloneable

public void checkCloneable(OrderItem orderItem)
                    throws CloneNotSupportedException,
                           SecurityException,
                           NoSuchMethodException

Throws:

CloneNotSupportedException

SecurityException

NoSuchMethodException

convertToMoney

protected Money convertToMoney(BigDecimal amount)

convertOrderItemType

protected OrderItemType convertOrderItemType(String type)

clone

public OrderItem clone()

Specified by:

clone in interface OrderItem

Overrides:

clone in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

accept

public void accept(OrderItemVisitor visitor)
            throws PricingException

Specified by:

accept in interface OrderItem

Throws:

PricingException

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()

Description copied from interface: OrderItem

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 splitParentItemId)

Specified by:

setSplitParentItemId in interface OrderItem