org.broadleafcommerce.core.order.domain
Interface OrderItem

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

BundleOrderItem, DiscreteOrderItem, DynamicPriceDiscreteOrderItem, GiftWrapOrderItem

All Known Implementing Classes:

BundleOrderItemImpl, DiscreteOrderItemDecorator, DiscreteOrderItemImpl, DynamicPriceDiscreteOrderItemImpl, GiftWrapOrderItemImpl, OrderItemImpl

public interface OrderItem
extends java.io.Serializable

Method Summary

void	addCandidateItemOffer(CandidateItemOffer candidateItemOffer)
void	addOrderItemAdjustment(OrderItemAdjustment orderItemAdjustment) Adds the adjustment to the order item's adjustment list and discounts the order item's adjustment price by the value of the adjustment.
void	addPromotionDiscount(CandidateItemOffer candidatePromotion, OfferItemCriteria itemCriteria, int quantity)
void	addPromotionQualifier(CandidateItemOffer candidatePromotion, OfferItemCriteria itemCriteria, int quantity)
void	assignFinalPrice()
void	clearAllDiscount()
void	clearAllNonFinalizedQuantities()
void	clearAllQualifiers()
OrderItem	clone()
void	finalizeQuantities()
Money	getAdjustmentPrice()
Money	getAdjustmentValue()
java.util.List<CandidateItemOffer>	getCandidateItemOffers()
Category	getCategory()
Money	getCurrentPrice()
GiftWrapOrderItem	getGiftWrapOrderItem()
java.lang.Long	getId()
boolean	getIsDiscounted()
boolean	getIsOnSale()
int	getMarkedForOffer()
java.lang.String	getName()
Order	getOrder()
java.util.List<OrderItemAdjustment>	getOrderItemAdjustments() Returns a unmodifiable List of OrderItemAdjustment.
OrderItemType	getOrderItemType()
PersonalMessage	getPersonalMessage()
Money	getPrice()
Money	getPriceBeforeAdjustments(boolean allowSalesPrice)
java.util.List<PromotionDiscount>	getPromotionDiscounts()
java.util.List<PromotionQualifier>	getPromotionQualifiers()
int	getQuantity()
int	getQuantityAvailableToBeUsedAsQualifier(Offer promotion)
int	getQuantityAvailableToBeUsedAsTarget(Offer promotion)
Money	getRetailPrice()
Money	getSalePrice()
Money	getTaxablePrice()
boolean	isAllQuantityMarkedForOffer()
boolean	isHasOrderItemAdjustments()
boolean	isInCategory(java.lang.String categoryName)
boolean	isNotCombinableOfferApplied()
boolean	markForOffer()
int	removeAllAdjustments() Removes all adjustment for this order item and reset the adjustment price.
void	removeAllCandidateItemOffers()
void	setAdjustmentPrice(Money adjustmentPrice)
void	setCandidateItemOffers(java.util.List<CandidateItemOffer> candidateItemOffers)
void	setCategory(Category category)
void	setGiftWrapOrderItem(GiftWrapOrderItem giftWrapOrderItem)
void	setId(java.lang.Long id)
void	setName(java.lang.String name)
void	setOrder(Order order)
void	setOrderItemType(OrderItemType orderItemType)
void	setPersonalMessage(PersonalMessage personalMessage)
void	setPrice(Money price)
void	setPromotionDiscounts(java.util.List<PromotionDiscount> promotionDiscounts)
void	setPromotionQualifiers(java.util.List<PromotionQualifier> promotionQualifiers)
void	setQuantity(int quantity)
void	setRetailPrice(Money retailPrice)
void	setSalePrice(Money salePrice)
java.util.List<OrderItem>	split()
boolean	unmarkForOffer()
boolean	updatePrices()

Method Detail

getId

java.lang.Long getId()

setId

void setId(java.lang.Long id)

getOrder

Order getOrder()

setOrder

void setOrder(Order order)

getRetailPrice

Money getRetailPrice()

setRetailPrice

void setRetailPrice(Money retailPrice)

getSalePrice

Money getSalePrice()

setSalePrice

void setSalePrice(Money salePrice)

getAdjustmentValue

Money getAdjustmentValue()

getAdjustmentPrice

Money getAdjustmentPrice()

setAdjustmentPrice

void setAdjustmentPrice(Money adjustmentPrice)

getPrice

Money getPrice()

setPrice

void setPrice(Money price)

assignFinalPrice

void assignFinalPrice()

getCurrentPrice

Money getCurrentPrice()

getQuantity

int getQuantity()

setQuantity

void setQuantity(int quantity)

getCategory

Category getCategory()

setCategory

void setCategory(Category category)

getCandidateItemOffers

java.util.List<CandidateItemOffer> getCandidateItemOffers()

setCandidateItemOffers

void setCandidateItemOffers(java.util.List<CandidateItemOffer> candidateItemOffers)

addCandidateItemOffer

void addCandidateItemOffer(CandidateItemOffer candidateItemOffer)

removeAllCandidateItemOffers

void removeAllCandidateItemOffers()

markForOffer

boolean markForOffer()

getMarkedForOffer

int getMarkedForOffer()

unmarkForOffer

boolean unmarkForOffer()

isAllQuantityMarkedForOffer

boolean isAllQuantityMarkedForOffer()

getOrderItemAdjustments

java.util.List<OrderItemAdjustment> getOrderItemAdjustments()

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

Returns:

a unmodifiable List of OrderItemAdjustment

addOrderItemAdjustment

void addOrderItemAdjustment(OrderItemAdjustment orderItemAdjustment)

Adds the adjustment to the order item's adjustment list and discounts the order item's adjustment price by the value of the adjustment.

Parameters:

orderItemAdjustment -

removeAllAdjustments

int removeAllAdjustments()

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

getPersonalMessage

PersonalMessage getPersonalMessage()

setPersonalMessage

void setPersonalMessage(PersonalMessage personalMessage)

isInCategory

boolean isInCategory(java.lang.String categoryName)

getGiftWrapOrderItem

GiftWrapOrderItem getGiftWrapOrderItem()

setGiftWrapOrderItem

void setGiftWrapOrderItem(GiftWrapOrderItem giftWrapOrderItem)

getOrderItemType

OrderItemType getOrderItemType()

setOrderItemType

void setOrderItemType(OrderItemType orderItemType)

getTaxablePrice

Money getTaxablePrice()

getIsOnSale

boolean getIsOnSale()

getIsDiscounted

boolean getIsDiscounted()

isNotCombinableOfferApplied

boolean isNotCombinableOfferApplied()

isHasOrderItemAdjustments

boolean isHasOrderItemAdjustments()

updatePrices

boolean updatePrices()

getName

java.lang.String getName()

setName

void setName(java.lang.String name)

getPromotionDiscounts

java.util.List<PromotionDiscount> getPromotionDiscounts()

setPromotionDiscounts

void setPromotionDiscounts(java.util.List<PromotionDiscount> promotionDiscounts)

getPromotionQualifiers

java.util.List<PromotionQualifier> getPromotionQualifiers()

setPromotionQualifiers

void setPromotionQualifiers(java.util.List<PromotionQualifier> promotionQualifiers)

getQuantityAvailableToBeUsedAsQualifier

int getQuantityAvailableToBeUsedAsQualifier(Offer promotion)

getQuantityAvailableToBeUsedAsTarget

int getQuantityAvailableToBeUsedAsTarget(Offer promotion)

getPriceBeforeAdjustments

Money getPriceBeforeAdjustments(boolean allowSalesPrice)

addPromotionQualifier

void addPromotionQualifier(CandidateItemOffer candidatePromotion,
                           OfferItemCriteria itemCriteria,
                           int quantity)

addPromotionDiscount

void addPromotionDiscount(CandidateItemOffer candidatePromotion,
                          OfferItemCriteria itemCriteria,
                          int quantity)

clearAllNonFinalizedQuantities

void clearAllNonFinalizedQuantities()

finalizeQuantities

void finalizeQuantities()

clone

OrderItem clone()

split

java.util.List<OrderItem> split()

clearAllDiscount

void clearAllDiscount()

clearAllQualifiers

void clearAllQualifiers()