org.broadleafcommerce.core.order.domain
Class FulfillmentGroupImpl

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

All Implemented Interfaces:

Serializable, CurrencyCodeIdentifiable, FulfillmentGroup

@Entity
public class FulfillmentGroupImpl
extends Object
implements FulfillmentGroup, CurrencyCodeIdentifiable

See Also:

Serialized Form

Nested Class Summary

static class

FulfillmentGroupImpl.Presentation

Field Summary

protected Address	address
protected List<CandidateFulfillmentGroupOffer>	candidateOffers
protected String	deliveryInstruction
protected List<FulfillmentGroupAdjustment>	fulfillmentGroupAdjustments
protected List<FulfillmentGroupFee>	fulfillmentGroupFees
protected List<FulfillmentGroupItem>	fulfillmentGroupItems
protected FulfillmentOption	fulfillmentOption
protected BigDecimal	fulfillmentPrice
protected Long	id
protected Boolean	isShippingPriceTaxable
protected BigDecimal	merchandiseTotal
protected String	method Deprecated.
protected Order	order
protected PersonalMessage	personalMessage
protected Phone	phone
protected boolean	primary
protected String	referenceNumber
protected BigDecimal	retailFulfillmentPrice
protected BigDecimal	saleFulfillmentPrice
protected Integer	sequence
protected String	service Deprecated.
protected String	status
protected List<TaxDetail>	taxes
protected BigDecimal	total
protected BigDecimal	totalFeeTax
protected BigDecimal	totalFulfillmentGroupTax
protected BigDecimal	totalItemTax
protected BigDecimal	totalTax
protected String	type

Constructor Summary

FulfillmentGroupImpl()

Method Summary

void	addCandidateFulfillmentGroupOffer(CandidateFulfillmentGroupOffer candidateOffer)
void	addFulfillmentGroupFee(FulfillmentGroupFee fulfillmentGroupFee)
void	addFulfillmentGroupItem(FulfillmentGroupItem fulfillmentGroupItem)
boolean	equals(Object obj)
Address	getAddress()
List<CandidateFulfillmentGroupOffer>	getCandidateFulfillmentGroupOffers()
String	getCurrencyCode()
String	getDeliveryInstruction()
List<DiscreteOrderItem>	getDiscreteOrderItems()
List<FulfillmentGroupAdjustment>	getFulfillmentGroupAdjustments()
Money	getFulfillmentGroupAdjustmentsValue()
List<FulfillmentGroupFee>	getFulfillmentGroupFees()
List<FulfillmentGroupItem>	getFulfillmentGroupItems()
FulfillmentOption	getFulfillmentOption()
Money	getFulfillmentPrice() Gets the price to charge for this fulfillmentGroup.
Long	getId()
Money	getMerchandiseTotal()
String	getMethod() Deprecated.
Order	getOrder()
PersonalMessage	getPersonalMessage()
Phone	getPhone()
String	getReferenceNumber()
Money	getRetailFulfillmentPrice() Returns the retail price for this fulfillmentGroup.
Money	getRetailShippingPrice()
Money	getSaleFulfillmentPrice() Returns the sale price for this fulfillmentGroup.
Money	getSaleShippingPrice()
Integer	getSequence()
String	getService() Deprecated.
Money	getShippingPrice()
FulfillmentGroupStatusType	getStatus()
List<TaxDetail>	getTaxes() Gets a list of TaxDetail objects, which are taxes that apply directly to this fulfillment group.
Money	getTotal()
Money	getTotalFeeTax() Gets the total fee tax for this fulfillment group, which is the sum of the taxes on all fulfillment group fees.
Money	getTotalFulfillmentGroupTax() Gets the total fulfillment group tax for this fulfillment group, which is the sum of the taxes on this fulfillment group itself (such as a shipping tax) only.
Money	getTotalItemTax() Gets the total item tax for this fulfillment group, which is the sum of the taxes on all fulfillment group items.
Money	getTotalTax() Gets the total tax for this fulfillment group, which is the sum of the taxes on all fulfillment group items, fees, and taxes on this fulfillment group itself (such as a shipping tax).
FulfillmentType	getType()
int	hashCode()
boolean	isPrimary()
Boolean	isShippingPriceTaxable()
void	removeAllAdjustments()
void	removeAllCandidateOffers()
void	removeAllFulfillmentGroupFees()
void	setAddress(Address address)
void	setCandidateFulfillmentGroupOffer(List<CandidateFulfillmentGroupOffer> candidateOffers)
void	setDeliveryInstruction(String deliveryInstruction)
void	setFulfillmentGroupAdjustments(List<FulfillmentGroupAdjustment> fulfillmentGroupAdjustments)
void	setFulfillmentGroupFees(List<FulfillmentGroupFee> fulfillmentGroupFees)
void	setFulfillmentGroupItems(List<FulfillmentGroupItem> fulfillmentGroupItems)
void	setFulfillmentOption(FulfillmentOption fulfillmentOption)
void	setFulfillmentPrice(Money fulfillmentPrice) Sets the price to charge for this fulfillmentGroup.
void	setId(Long id)
void	setIsShippingPriceTaxable(Boolean isShippingPriceTaxable)
void	setMerchandiseTotal(Money merchandiseTotal)
void	setMethod(String fulfillmentMethod) Deprecated.
void	setOrder(Order order)
void	setPersonalMessage(PersonalMessage personalMessage)
void	setPhone(Phone phone)
void	setPrimary(boolean primary)
void	setReferenceNumber(String referenceNumber)
void	setRetailFulfillmentPrice(Money retailFulfillmentPrice) Sets the retail price for this fulfillmentGroup.
void	setRetailShippingPrice(Money retailShippingPrice)
void	setSaleFulfillmentPrice(Money saleFulfillmentPrice) Sets the sale price for this fulfillmentGroup.
void	setSaleShippingPrice(Money saleShippingPrice)
void	setSequence(Integer sequence)
void	setService(String service) Deprecated.
void	setShippingPrice(Money shippingPrice)
void	setStatus(FulfillmentGroupStatusType status)
void	setTaxes(List<TaxDetail> taxes) Gets the list of TaxDetail objects, which are taxes that apply directly to this fulfillment group.
void	setTotal(Money orderTotal)
void	setTotalFeeTax(Money totalFeeTax) Sets the total fee tax for this fulfillment group, which is the sum of the taxes on all fulfillment group fees.
void	setTotalFulfillmentGroupTax(Money totalFulfillmentGroupTax) Sets the total fulfillment group tax for this fulfillment group, which is the sum of the taxes on this fulfillment group itself (such as a shipping tax) only.
void	setTotalItemTax(Money totalItemTax) Sets the total item tax for this fulfillment group, which is the sum of the taxes on all fulfillment group items.
void	setTotalTax(Money totalTax) Sets the total tax for this fulfillment group, which is the sum of the taxes on all fulfillment group items, fees, and taxes on this fulfillment group itself (such as a shipping tax).
void	setType(FulfillmentType type)

Methods inherited from class java.lang.Object

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

Field Detail

id

protected Long id

referenceNumber

protected String referenceNumber

method

@Deprecated
protected String method

Deprecated.

service

@Deprecated
protected String service

Deprecated.

retailFulfillmentPrice

protected BigDecimal retailFulfillmentPrice

saleFulfillmentPrice

protected BigDecimal saleFulfillmentPrice

fulfillmentPrice

protected BigDecimal fulfillmentPrice

type

protected String type

totalTax

protected BigDecimal totalTax

totalItemTax

protected BigDecimal totalItemTax

totalFeeTax

protected BigDecimal totalFeeTax

totalFulfillmentGroupTax

protected BigDecimal totalFulfillmentGroupTax

deliveryInstruction

protected String deliveryInstruction

primary

protected boolean primary

merchandiseTotal

protected BigDecimal merchandiseTotal

total

protected BigDecimal total

status

protected String status

isShippingPriceTaxable

protected Boolean isShippingPriceTaxable

fulfillmentOption

protected FulfillmentOption fulfillmentOption

order

protected Order order

sequence

protected Integer sequence

address

protected Address address

phone

protected Phone phone

personalMessage

protected PersonalMessage personalMessage

fulfillmentGroupItems

protected List<FulfillmentGroupItem> fulfillmentGroupItems

fulfillmentGroupFees

protected List<FulfillmentGroupFee> fulfillmentGroupFees

candidateOffers

protected List<CandidateFulfillmentGroupOffer> candidateOffers

fulfillmentGroupAdjustments

protected List<FulfillmentGroupAdjustment> fulfillmentGroupAdjustments

taxes

protected List<TaxDetail> taxes

Constructor Detail

FulfillmentGroupImpl

public FulfillmentGroupImpl()

Method Detail

getId

public Long getId()

Specified by:

getId in interface FulfillmentGroup

setId

public void setId(Long id)

Specified by:

setId in interface FulfillmentGroup

getOrder

public Order getOrder()

Specified by:

getOrder in interface FulfillmentGroup

setOrder

public void setOrder(Order order)

Specified by:

setOrder in interface FulfillmentGroup

getFulfillmentOption

public FulfillmentOption getFulfillmentOption()

Specified by:

getFulfillmentOption in interface FulfillmentGroup

setFulfillmentOption

public void setFulfillmentOption(FulfillmentOption fulfillmentOption)

Specified by:

setFulfillmentOption in interface FulfillmentGroup

getReferenceNumber

public String getReferenceNumber()

Specified by:

getReferenceNumber in interface FulfillmentGroup

setReferenceNumber

public void setReferenceNumber(String referenceNumber)

Specified by:

setReferenceNumber in interface FulfillmentGroup

getFulfillmentGroupItems

public List<FulfillmentGroupItem> getFulfillmentGroupItems()

Specified by:

getFulfillmentGroupItems in interface FulfillmentGroup

getDiscreteOrderItems

public List<DiscreteOrderItem> getDiscreteOrderItems()

Specified by:

getDiscreteOrderItems in interface FulfillmentGroup

setFulfillmentGroupItems

public void setFulfillmentGroupItems(List<FulfillmentGroupItem> fulfillmentGroupItems)

Specified by:

setFulfillmentGroupItems in interface FulfillmentGroup

addFulfillmentGroupItem

public void addFulfillmentGroupItem(FulfillmentGroupItem fulfillmentGroupItem)

Specified by:

addFulfillmentGroupItem in interface FulfillmentGroup

getAddress

public Address getAddress()

Specified by:

getAddress in interface FulfillmentGroup

setAddress

public void setAddress(Address address)

Specified by:

setAddress in interface FulfillmentGroup

getPhone

public Phone getPhone()

Specified by:

getPhone in interface FulfillmentGroup

setPhone

public void setPhone(Phone phone)

Specified by:

setPhone in interface FulfillmentGroup

getMethod

@Deprecated
public String getMethod()

Deprecated.

Specified by:

getMethod in interface FulfillmentGroup

See Also:

FulfillmentOption}

setMethod

@Deprecated
public void setMethod(String fulfillmentMethod)

Deprecated.

Specified by:

setMethod in interface FulfillmentGroup

See Also:

FulfillmentOption}

getRetailFulfillmentPrice

public Money getRetailFulfillmentPrice()

Description copied from interface: FulfillmentGroup

Returns the retail price for this fulfillmentGroup. The retail and sale concepts used for item pricing are not generally used with fulfillmentPricing but supported nonetheless. Typically only a retail price would be set on a fulfillment group.

Specified by:

getRetailFulfillmentPrice in interface FulfillmentGroup

Returns:

setRetailFulfillmentPrice

public void setRetailFulfillmentPrice(Money retailFulfillmentPrice)

Description copied from interface: FulfillmentGroup

Sets the retail price for this fulfillmentGroup.

Specified by:

setRetailFulfillmentPrice in interface FulfillmentGroup

getRetailShippingPrice

public Money getRetailShippingPrice()

Specified by:

getRetailShippingPrice in interface FulfillmentGroup

Returns:

setRetailShippingPrice

public void setRetailShippingPrice(Money retailShippingPrice)

Specified by:

setRetailShippingPrice in interface FulfillmentGroup

getType

public FulfillmentType getType()

Specified by:

getType in interface FulfillmentGroup

setType

public void setType(FulfillmentType type)

Specified by:

setType in interface FulfillmentGroup

addCandidateFulfillmentGroupOffer

public void addCandidateFulfillmentGroupOffer(CandidateFulfillmentGroupOffer candidateOffer)

Specified by:

addCandidateFulfillmentGroupOffer in interface FulfillmentGroup

getCandidateFulfillmentGroupOffers

public List<CandidateFulfillmentGroupOffer> getCandidateFulfillmentGroupOffers()

Specified by:

getCandidateFulfillmentGroupOffers in interface FulfillmentGroup

setCandidateFulfillmentGroupOffer

public void setCandidateFulfillmentGroupOffer(List<CandidateFulfillmentGroupOffer> candidateOffers)

Specified by:

setCandidateFulfillmentGroupOffer in interface FulfillmentGroup

removeAllCandidateOffers

public void removeAllCandidateOffers()

Specified by:

removeAllCandidateOffers in interface FulfillmentGroup

getFulfillmentGroupAdjustments

public List<FulfillmentGroupAdjustment> getFulfillmentGroupAdjustments()

Specified by:

getFulfillmentGroupAdjustments in interface FulfillmentGroup

getFulfillmentGroupAdjustmentsValue

public Money getFulfillmentGroupAdjustmentsValue()

Specified by:

getFulfillmentGroupAdjustmentsValue in interface FulfillmentGroup

removeAllAdjustments

public void removeAllAdjustments()

Specified by:

removeAllAdjustments in interface FulfillmentGroup

setFulfillmentGroupAdjustments

public void setFulfillmentGroupAdjustments(List<FulfillmentGroupAdjustment> fulfillmentGroupAdjustments)

Specified by:

setFulfillmentGroupAdjustments in interface FulfillmentGroup

getSaleFulfillmentPrice

public Money getSaleFulfillmentPrice()

Description copied from interface: FulfillmentGroup

Returns the sale price for this fulfillmentGroup. Typically this will be null or equal to the retailFulfillmentPrice

Specified by:

getSaleFulfillmentPrice in interface FulfillmentGroup

Returns:

setSaleFulfillmentPrice

public void setSaleFulfillmentPrice(Money saleFulfillmentPrice)

Description copied from interface: FulfillmentGroup

Sets the sale price for this fulfillmentGroup. Typically not used.

Specified by:

setSaleFulfillmentPrice in interface FulfillmentGroup

See Also:

FulfillmentGroup.setRetailFulfillmentPrice(Money)

getSaleShippingPrice

public Money getSaleShippingPrice()

Specified by:

getSaleShippingPrice in interface FulfillmentGroup

Returns:

setSaleShippingPrice

public void setSaleShippingPrice(Money saleShippingPrice)

Specified by:

setSaleShippingPrice in interface FulfillmentGroup

getFulfillmentPrice

public Money getFulfillmentPrice()

Description copied from interface: FulfillmentGroup

Gets the price to charge for this fulfillmentGroup. Includes the effects of any adjustments such as those that might have been applied by the promotion engine (e.g. free shipping)

Specified by:

getFulfillmentPrice in interface FulfillmentGroup

Returns:

setFulfillmentPrice

public void setFulfillmentPrice(Money fulfillmentPrice)

Description copied from interface: FulfillmentGroup

Sets the price to charge for this fulfillmentGroup. Typically set internally by the Broadleaf pricing and promotion engines.

Specified by:

setFulfillmentPrice in interface FulfillmentGroup

getShippingPrice

public Money getShippingPrice()

Specified by:

getShippingPrice in interface FulfillmentGroup

Returns:

setShippingPrice

public void setShippingPrice(Money shippingPrice)

Specified by:

setShippingPrice in interface FulfillmentGroup

getTaxes

public List<TaxDetail> getTaxes()

Description copied from interface: FulfillmentGroup

Gets a list of TaxDetail objects, which are taxes that apply directly to this fulfillment group. An example of a such a tax would be a shipping tax.

Specified by:

getTaxes in interface FulfillmentGroup

Returns:

a list of taxes that apply to this fulfillment group

setTaxes

public void setTaxes(List<TaxDetail> taxes)

Description copied from interface: FulfillmentGroup

Gets the list of TaxDetail objects, which are taxes that apply directly to this fulfillment group. An example of a such a tax would be a shipping tax.

Specified by:

setTaxes in interface FulfillmentGroup

Parameters:

taxes - the list of taxes on this fulfillment group

getTotalTax

public Money getTotalTax()

Description copied from interface: FulfillmentGroup

Gets the total tax for this fulfillment group, which is the sum of the taxes on all fulfillment group items, fees, and taxes on this fulfillment group itself (such as a shipping tax). This total is calculated in the TotalActivity stage of the pricing workflow.

Specified by:

getTotalTax in interface FulfillmentGroup

Returns:

the total tax for the fulfillment group

setTotalTax

public void setTotalTax(Money totalTax)

Description copied from interface: FulfillmentGroup

Sets the total tax for this fulfillment group, which is the sum of the taxes on all fulfillment group items, fees, and taxes on this fulfillment group itself (such as a shipping tax). This total should only be set during the TotalActivity stage of the pricing workflow.

Specified by:

setTotalTax in interface FulfillmentGroup

getTotalItemTax

public Money getTotalItemTax()

Description copied from interface: FulfillmentGroup

Gets the total item tax for this fulfillment group, which is the sum of the taxes on all fulfillment group items. This total is calculated in the TotalActivity stage of the pricing workflow.

Specified by:

getTotalItemTax in interface FulfillmentGroup

Returns:

the total tax for this fulfillment group

setTotalItemTax

public void setTotalItemTax(Money totalItemTax)

Description copied from interface: FulfillmentGroup

Sets the total item tax for this fulfillment group, which is the sum of the taxes on all fulfillment group items. This total should only be set during the TotalActivity stage of the pricing workflow.

Specified by:

setTotalItemTax in interface FulfillmentGroup

getTotalFeeTax

public Money getTotalFeeTax()

Description copied from interface: FulfillmentGroup

Gets the total fee tax for this fulfillment group, which is the sum of the taxes on all fulfillment group fees. This total is calculated in the TotalActivity stage of the pricing workflow.

Specified by:

getTotalFeeTax in interface FulfillmentGroup

Returns:

the total tax for this fulfillment group

setTotalFeeTax

public void setTotalFeeTax(Money totalFeeTax)

Description copied from interface: FulfillmentGroup

Sets the total fee tax for this fulfillment group, which is the sum of the taxes on all fulfillment group fees. This total should only be set during the TotalActivity stage of the pricing workflow.

Specified by:

setTotalFeeTax in interface FulfillmentGroup

getTotalFulfillmentGroupTax

public Money getTotalFulfillmentGroupTax()

Description copied from interface: FulfillmentGroup

Gets the total fulfillment group tax for this fulfillment group, which is the sum of the taxes on this fulfillment group itself (such as a shipping tax) only. It does not include the taxes on items or fees in this fulfillment group. This total is calculated in the TotalActivity stage of the pricing workflow.

Specified by:

getTotalFulfillmentGroupTax in interface FulfillmentGroup

Returns:

the total tax for this fulfillment group

setTotalFulfillmentGroupTax

public void setTotalFulfillmentGroupTax(Money totalFulfillmentGroupTax)

Description copied from interface: FulfillmentGroup

Sets the total fulfillment group tax for this fulfillment group, which is the sum of the taxes on this fulfillment group itself (such as a shipping tax) only. It does not include the taxes on items or fees in this fulfillment group. This total should only be set during the TotalActivity stage of the pricing workflow.

Specified by:

setTotalFulfillmentGroupTax in interface FulfillmentGroup

getDeliveryInstruction

public String getDeliveryInstruction()

Specified by:

getDeliveryInstruction in interface FulfillmentGroup

setDeliveryInstruction

public void setDeliveryInstruction(String deliveryInstruction)

Specified by:

setDeliveryInstruction in interface FulfillmentGroup

getPersonalMessage

public PersonalMessage getPersonalMessage()

Specified by:

getPersonalMessage in interface FulfillmentGroup

setPersonalMessage

public void setPersonalMessage(PersonalMessage personalMessage)

Specified by:

setPersonalMessage in interface FulfillmentGroup

isPrimary

public boolean isPrimary()

Specified by:

isPrimary in interface FulfillmentGroup

setPrimary

public void setPrimary(boolean primary)

Specified by:

setPrimary in interface FulfillmentGroup

getMerchandiseTotal

public Money getMerchandiseTotal()

Specified by:

getMerchandiseTotal in interface FulfillmentGroup

setMerchandiseTotal

public void setMerchandiseTotal(Money merchandiseTotal)

Specified by:

setMerchandiseTotal in interface FulfillmentGroup

getTotal

public Money getTotal()

Specified by:

getTotal in interface FulfillmentGroup

setTotal

public void setTotal(Money orderTotal)

Specified by:

setTotal in interface FulfillmentGroup

getStatus

public FulfillmentGroupStatusType getStatus()

Specified by:

getStatus in interface FulfillmentGroup

setStatus

public void setStatus(FulfillmentGroupStatusType status)

Specified by:

setStatus in interface FulfillmentGroup

getFulfillmentGroupFees

public List<FulfillmentGroupFee> getFulfillmentGroupFees()

Specified by:

getFulfillmentGroupFees in interface FulfillmentGroup

setFulfillmentGroupFees

public void setFulfillmentGroupFees(List<FulfillmentGroupFee> fulfillmentGroupFees)

Specified by:

setFulfillmentGroupFees in interface FulfillmentGroup

addFulfillmentGroupFee

public void addFulfillmentGroupFee(FulfillmentGroupFee fulfillmentGroupFee)

Specified by:

addFulfillmentGroupFee in interface FulfillmentGroup

removeAllFulfillmentGroupFees

public void removeAllFulfillmentGroupFees()

Specified by:

removeAllFulfillmentGroupFees in interface FulfillmentGroup

isShippingPriceTaxable

public Boolean isShippingPriceTaxable()

Specified by:

isShippingPriceTaxable in interface FulfillmentGroup

setIsShippingPriceTaxable

public void setIsShippingPriceTaxable(Boolean isShippingPriceTaxable)

Specified by:

setIsShippingPriceTaxable in interface FulfillmentGroup

setSequence

public void setSequence(Integer sequence)

Specified by:

setSequence in interface FulfillmentGroup

getSequence

public Integer getSequence()

Specified by:

getSequence in interface FulfillmentGroup

getService

@Deprecated
public String getService()

Deprecated.

Specified by:

getService in interface FulfillmentGroup

See Also:

FulfillmentOption}

setService

@Deprecated
public void setService(String service)

Deprecated.

Specified by:

setService in interface FulfillmentGroup

See Also:

FulfillmentOption}

getCurrencyCode

public String getCurrencyCode()

Specified by:

getCurrencyCode in interface CurrencyCodeIdentifiable

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object