org.broadleafcommerce.core.order.domain
Interface Order

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

OrderImpl

public interface Order
extends java.io.Serializable

Method Summary

void	addAddedOfferCode(OfferCode addedOfferCode)
void	addCandidateOrderOffer(CandidateOrderOffer candidateOrderOffer)
void	addOrderAdjustments(OrderAdjustment orderAdjustment) Adds the adjustment to the order's adjustment list and discounts the order's adjustment price by the value of the adjustment.
void	addOrderItem(OrderItem orderItem)
void	assignOrderItemsFinalPrice()
Money	calculateOrderItemsCurrentPrice()
Money	calculateOrderItemsFinalPrice(boolean includeNonTaxableItems)
Money	calculateOrderItemsPriceWithoutAdjustments()
boolean	containsNotStackableFulfillmentGroupOffer()
boolean	containsNotStackableOrderOffer()
java.util.List<OfferCode>	getAddedOfferCodes()
java.util.Map<Offer,OfferInfo>	getAdditionalOfferInformation()
Money	getAdjustmentPrice() Returns the price of the order with the order offers applied (item offers are not applied).
Auditable	getAuditable()
java.util.List<CandidateOrderOffer>	getCandidateOrderOffers()
Money	getCityTax()
Money	getCountryTax()
Money	getCountyTax()
Customer	getCustomer()
java.util.List<DiscreteOrderItem>	getDiscountableDiscreteOrderItems()
java.util.List<DiscreteOrderItem>	getDiscreteOrderItems()
Money	getDistrictTax()
java.lang.String	getEmailAddress()
java.util.List<FulfillmentGroup>	getFulfillmentGroups()
java.lang.String	getFulfillmentStatus()
java.lang.Long	getId()
Money	getItemAdjustmentsValue() Returns the discount value of all the applied item offers for this order.
java.lang.String	getName()
java.util.List<OrderAdjustment>	getOrderAdjustments() Returns a unmodifiable List of OrderAdjustment.
Money	getOrderAdjustmentsValue() Returns the discount value of all the applied order offers.
java.util.List<OrderItem>	getOrderItems()
java.lang.String	getOrderNumber()
java.util.List<PaymentInfo>	getPaymentInfos()
Money	getRemainingTotal()
java.util.List<OrderItemSplitContainer>	getSplitItems()
Money	getStateTax()
OrderStatus	getStatus()
java.util.Date	getSubmitDate()
Money	getSubTotal() Returns the subtotal price for the order.
Money	getTotal()
Money	getTotalAdjustmentsValue() Returns the total discount value for all applied item and order offers in the order.
Money	getTotalShipping()
Money	getTotalTax()
boolean	hasCategoryItem(java.lang.String categoryName)
boolean	isHasOrderAdjustments()
boolean	isNotCombinableOfferApplied()
boolean	isNotCombinableOfferAppliedAtAnyLevel()
boolean	isTotalitarianOfferApplied()
void	removeAllAddedOfferCodes()
void	removeAllAdjustments() Removes all order, order item, and fulfillment adjustments from the order and resets the adjustment price.
void	removeAllCandidateFulfillmentGroupOffers()
void	removeAllCandidateOffers()
void	removeAllCandidateOrderOffers()
void	removeAllFulfillmentAdjustments()
void	removeAllItemAdjustments() Removes all adjustments from the order's order items and resets the adjustment price for each item.
void	removeAllOrderAdjustments() Removes all order adjustments from the order and resets the adjustment price.
void	resetTotalitarianOfferApplied()
java.util.List<OrderItem>	searchSplitItems(OrderItem key)
void	setAdditionalOfferInformation(java.util.Map<Offer,OfferInfo> additionalOfferInformation)
void	setAdjustmentPrice(Money adjustmentPrice)
void	setAuditable(Auditable auditable)
void	setCandidateOrderOffers(java.util.List<CandidateOrderOffer> candidateOrderOffers)
void	setCityTax(Money cityTax)
void	setCountryTax(Money countryTax)
void	setCountyTax(Money countyTax)
void	setCustomer(Customer customer)
void	setDistrictTax(Money districtTax)
void	setEmailAddress(java.lang.String emailAddress)
void	setFulfillmentGroups(java.util.List<FulfillmentGroup> fulfillmentGroups)
void	setId(java.lang.Long id)
void	setMarkedForOffer(boolean markForOffer) Deprecated.
void	setName(java.lang.String name)
void	setNotCombinableOfferAppliedAtAnyLevel(boolean notCombinableOfferAppliedAtAnyLevel)
void	setOrderItems(java.util.List<OrderItem> orderItems)
void	setOrderNumber(java.lang.String orderNumber)
void	setPaymentInfos(java.util.List<PaymentInfo> paymentInfos)
void	setSplitItems(java.util.List<OrderItemSplitContainer> splitItems)
void	setStateTax(Money stateTax)
void	setStatus(OrderStatus status)
void	setSubmitDate(java.util.Date submitDate)
void	setSubTotal(Money subTotal) Sets the subtotal price for the order.
void	setTotal(Money orderTotal)
void	setTotalitarianOfferApplied(boolean totalitarianOfferApplied)
void	setTotalShipping(Money totalShipping)
void	setTotalTax(Money totalTax)
boolean	updatePrices()

Method Detail

getId

java.lang.Long getId()

setId

void setId(java.lang.Long id)

getName

java.lang.String getName()

setName

void setName(java.lang.String name)

getAuditable

Auditable getAuditable()

setAuditable

void setAuditable(Auditable auditable)

getSubTotal

Money getSubTotal()

Returns the subtotal price for the order. The subtotal price is the price of all order items with item offers applied. The subtotal does not take into account the order offers.

Returns:

the total item price with offers applied

setSubTotal

void setSubTotal(Money subTotal)

Sets the subtotal price for the order. The subtotal price is the price of all order items with item offers applied. The subtotal does not take into account the order offers.

Parameters:

subTotal -

assignOrderItemsFinalPrice

void assignOrderItemsFinalPrice()

calculateOrderItemsCurrentPrice

Money calculateOrderItemsCurrentPrice()

calculateOrderItemsFinalPrice

Money calculateOrderItemsFinalPrice(boolean includeNonTaxableItems)

calculateOrderItemsPriceWithoutAdjustments

Money calculateOrderItemsPriceWithoutAdjustments()

getTotal

Money getTotal()

getRemainingTotal

Money getRemainingTotal()

setTotal

void setTotal(Money orderTotal)

getCustomer

Customer getCustomer()

setCustomer

void setCustomer(Customer customer)

getStatus

OrderStatus getStatus()

setStatus

void setStatus(OrderStatus status)

getOrderItems

java.util.List<OrderItem> getOrderItems()

setOrderItems

void setOrderItems(java.util.List<OrderItem> orderItems)

addOrderItem

void addOrderItem(OrderItem orderItem)

getFulfillmentGroups

java.util.List<FulfillmentGroup> getFulfillmentGroups()

setFulfillmentGroups

void setFulfillmentGroups(java.util.List<FulfillmentGroup> fulfillmentGroups)

setCandidateOrderOffers

void setCandidateOrderOffers(java.util.List<CandidateOrderOffer> candidateOrderOffers)

addCandidateOrderOffer

void addCandidateOrderOffer(CandidateOrderOffer candidateOrderOffer)

getCandidateOrderOffers

java.util.List<CandidateOrderOffer> getCandidateOrderOffers()

removeAllCandidateOffers

void removeAllCandidateOffers()

removeAllCandidateOrderOffers

void removeAllCandidateOrderOffers()

removeAllCandidateFulfillmentGroupOffers

void removeAllCandidateFulfillmentGroupOffers()

setMarkedForOffer

@Deprecated
void setMarkedForOffer(boolean markForOffer)

Deprecated.

getSubmitDate

java.util.Date getSubmitDate()

setSubmitDate

void setSubmitDate(java.util.Date submitDate)

getCityTax

Money getCityTax()

setCityTax

void setCityTax(Money cityTax)

getCountyTax

Money getCountyTax()

setCountyTax

void setCountyTax(Money countyTax)

getStateTax

Money getStateTax()

setStateTax

void setStateTax(Money stateTax)

getDistrictTax

Money getDistrictTax()

setDistrictTax

void setDistrictTax(Money districtTax)

getCountryTax

Money getCountryTax()

setCountryTax

void setCountryTax(Money countryTax)

getTotalTax

Money getTotalTax()

setTotalTax

void setTotalTax(Money totalTax)

getTotalShipping

Money getTotalShipping()

setTotalShipping

void setTotalShipping(Money totalShipping)

getAdjustmentPrice

Money getAdjustmentPrice()

Returns the price of the order with the order offers applied (item offers are not applied).

Returns:

the order price with the order offers applied (item offers are not applied)

setAdjustmentPrice

void setAdjustmentPrice(Money adjustmentPrice)

getPaymentInfos

java.util.List<PaymentInfo> getPaymentInfos()

setPaymentInfos

void setPaymentInfos(java.util.List<PaymentInfo> paymentInfos)

hasCategoryItem

boolean hasCategoryItem(java.lang.String categoryName)

getOrderAdjustments

java.util.List<OrderAdjustment> getOrderAdjustments()

Returns a unmodifiable List of OrderAdjustment. To modify the List of OrderAdjustment, please use the addOrderAdjustments or removeAllOrderAdjustments methods.

Returns:

a unmodifiable List of OrderItemAdjustment

addOrderAdjustments

void addOrderAdjustments(OrderAdjustment orderAdjustment)

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

Parameters:

orderAdjustment -

removeAllAdjustments

void removeAllAdjustments()

Removes all order, order item, and fulfillment adjustments from the order and resets the adjustment price.

removeAllOrderAdjustments

void removeAllOrderAdjustments()

Removes all order adjustments from the order and resets the adjustment price. This method does not remove order item or fulfillment adjustments from the order.

removeAllItemAdjustments

void removeAllItemAdjustments()

Removes all adjustments from the order's order items and resets the adjustment price for each item. This method does not remove order or fulfillment adjustments from the order.

containsNotStackableOrderOffer

boolean containsNotStackableOrderOffer()

getDiscreteOrderItems

java.util.List<DiscreteOrderItem> getDiscreteOrderItems()

getDiscountableDiscreteOrderItems

java.util.List<DiscreteOrderItem> getDiscountableDiscreteOrderItems()

getAddedOfferCodes

java.util.List<OfferCode> getAddedOfferCodes()

addAddedOfferCode

void addAddedOfferCode(OfferCode addedOfferCode)

removeAllAddedOfferCodes

void removeAllAddedOfferCodes()

getFulfillmentStatus

java.lang.String getFulfillmentStatus()

getOrderNumber

java.lang.String getOrderNumber()

setOrderNumber

void setOrderNumber(java.lang.String orderNumber)

getEmailAddress

java.lang.String getEmailAddress()

setEmailAddress

void setEmailAddress(java.lang.String emailAddress)

getAdditionalOfferInformation

java.util.Map<Offer,OfferInfo> getAdditionalOfferInformation()

setAdditionalOfferInformation

void setAdditionalOfferInformation(java.util.Map<Offer,OfferInfo> additionalOfferInformation)

getItemAdjustmentsValue

Money getItemAdjustmentsValue()

Returns the discount value of all the applied item offers for this order. The value is already deducted from the order subTotal.

Returns:

the discount value of all the applied item offers for this order

getOrderAdjustmentsValue

Money getOrderAdjustmentsValue()

Returns the discount value of all the applied order offers. The value returned from this method should be subtracted from the getSubTotal() to get the order price with all item and order offers applied.

Returns:

the discount value of all applied order offers.

getTotalAdjustmentsValue

Money getTotalAdjustmentsValue()

Returns the total discount value for all applied item and order offers in the order. The return value should not be used with getSubTotal() to calculate the final price, since getSubTotal() already takes into account the applied item offers.

Returns:

the total discount of all applied item and order offers

isNotCombinableOfferApplied

boolean isNotCombinableOfferApplied()

isHasOrderAdjustments

boolean isHasOrderAdjustments()

updatePrices

boolean updatePrices()

getSplitItems

java.util.List<OrderItemSplitContainer> getSplitItems()

setSplitItems

void setSplitItems(java.util.List<OrderItemSplitContainer> splitItems)

searchSplitItems

java.util.List<OrderItem> searchSplitItems(OrderItem key)

removeAllFulfillmentAdjustments

void removeAllFulfillmentAdjustments()

containsNotStackableFulfillmentGroupOffer

boolean containsNotStackableFulfillmentGroupOffer()

resetTotalitarianOfferApplied

void resetTotalitarianOfferApplied()

isTotalitarianOfferApplied

boolean isTotalitarianOfferApplied()

setTotalitarianOfferApplied

void setTotalitarianOfferApplied(boolean totalitarianOfferApplied)

isNotCombinableOfferAppliedAtAnyLevel

boolean isNotCombinableOfferAppliedAtAnyLevel()

setNotCombinableOfferAppliedAtAnyLevel

void setNotCombinableOfferAppliedAtAnyLevel(boolean notCombinableOfferAppliedAtAnyLevel)