Package com.broadleafcommerce.order.client.domain

Class OrderFulfillment

java.lang.Object
com.broadleafcommerce.order.client.domain.OrderFulfillment
All Implemented Interfaces:
com.broadleafcommerce.data.tracking.core.ContextStateAware, com.broadleafcommerce.money.CurrencyConsumer, Serializable, javax.money.CurrencySupplier
public class OrderFulfillment extends Object implements com.broadleafcommerce.data.tracking.core.ContextStateAware, Serializable, com.broadleafcommerce.money.CurrencyConsumer, javax.money.CurrencySupplier
A group of item(s) from an Order that are fulfilled together.
Author:
Samarth Dhruva (samarthd)
See Also:

  • Constructor Summary

    Constructors
    Constructor
    Description
    OrderFulfillment()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    protected boolean
    canEqual(Object other)
     
    boolean
    equals(Object o)
     
    List<Shipment>
    getAdditionalShipments()
    All additional shipment details for this fulfillment.
    com.broadleafcommerce.order.common.domain.Address
    getAddress()
    The shipping address for this fulfillment.
    List<com.broadleafcommerce.order.common.domain.Adjustment>
    getAdjustments()
    Adjustments to fulfillment pricing that should be applied to getFulfillmentCharge().
    Map<String,Object>
    getAttributes()
    Additional attributes for this order fulfillment.
    com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState
    getContextState()
    A subset of Tracking information to expose the context state for this object.
    javax.money.CurrencyUnit
    getCurrency()
    The currency unit used for the pricing of this OrderFulfillment.
    String
    getExternalId()
    Intended to hold any unique identifier for this fulfillment as assigned by an external system.
    javax.money.MonetaryAmount
    getFulfillmentAdjustmentsTotal()
    Sum of the fulfillment's adjustments.
    javax.money.MonetaryAmount
    getFulfillmentCharge()
    The shipping charge for this fulfillment before adjustments are applied.
    List<OrderFulfillmentItem>
    getFulfillmentItems()
    Items within this fulfillment, each of which should relate back to a OrderItem.
    com.broadleafcommerce.order.common.domain.FulfillmentOption
    getFulfillmentOption()
    The fulfillment option chosen for the getType().
    javax.money.MonetaryAmount
    getFulfillmentTotal()
    The total shipping price of this fulfillment, including adjustments and item shipping prices.
    javax.money.MonetaryAmount
    getGrandTotal()
    The grand total of this fulfillment, including merchandise costs, all shipping costs including items, and tax.
    String
    getGroupReferenceNumber()
    The reference number of the FulfillmentGroup this fulfillment was created from.
    String
    getId()
    The unique identifier for this fulfillment.
    javax.money.MonetaryAmount
    getIncludedFulfillmentTax()
    The amount of fulfillment taxes that are included in the item subtotal (VAT).
    javax.money.MonetaryAmount
    getIncludedMerchandiseTax()
    The amount of merchandise taxes that are included in the item subtotal (VAT).
    String
    getInventoryLocationReference()
    This is an optional field where the ID or reference number of the expected InventoryLocation is stored.
    javax.money.MonetaryAmount
    getItemMerchandiseSubtotal()
    Sum up the OrderFulfillmentItem#merchandiseTotalAmount across all of the fulfillment's items.
    javax.money.MonetaryAmount
    getMerchandiseTotal()
    The merchandise total for all items in the fulfillment, including item adjustments and prorated order adjustments.
    String
    getOrderFulfillmentNumber()
    The number for this individual fulfillment, unique within the order.
    String
    getOrderId()
    A soft reference to the parent Order this fulfillment belongs to.
    javax.money.MonetaryAmount
    getOrderMerchandiseAdjustmentsTotal()
    Total up the OrderFulfillmentItem.proratedOrderAdjustments for all the items in the fulfillment.
    List<com.broadleafcommerce.order.common.domain.OverrideDetail>
    getOverrideDetails()
    List of details about any price overrides which have been performed on this fulfillment.
    com.broadleafcommerce.order.common.domain.PricedFulfillmentOption
    getPricedFulfillmentOption()
    The PricedFulfillmentOption chosen for the getType().
    javax.money.MonetaryAmount
    getProratedOrderFulfillmentAdjustments()
    Prorated amount of the fulfillment adjustments that applies to the fulfillmentCharge.
    Shipment
    getShipment()
    The primary shipment details for this fulfillment.
    String
    getStatus()
    The status of this fulfillment.
    javax.money.MonetaryAmount
    getTaxTotal()
    The total tax of this fulfillment, including merchandise and fulfillment tax.
    String
    getType()
    The type of means by which this fulfillment is fulfilled.
    String
    getVendorRef()
    A reference to the corresponding vendor for this fulfillment.
    Integer
    getVersion()
    The version of this OrderFulfillment.
    int
    hashCode()
     
    boolean
    isOverrideFulfillmentPriceFlag()
    Whether the total fulfillment price of this OrderFulfillment was specifically overridden, whether from a CSR or an automatic process.
    boolean
    isRequiresCollectOnDelivery()
    Whether this OrderFulfillment requires at least part of the payment to be collected on delivery.
    void
    setAdditionalShipments(List<Shipment> additionalShipments)
    All additional shipment details for this fulfillment.
    void
    setAddress(com.broadleafcommerce.order.common.domain.Address address)
    The shipping address for this fulfillment.
    void
    setAdjustments(List<com.broadleafcommerce.order.common.domain.Adjustment> adjustments)
    Adjustments to fulfillment pricing that should be applied to getFulfillmentCharge().
    void
    setAttributes(Map<String,Object> attributes)
    Additional attributes for this order fulfillment.
    void
    setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
    A subset of Tracking information to expose the context state for this object.
    void
    setCurrency(javax.money.CurrencyUnit currency)
    The currency unit used for the pricing of this OrderFulfillment.
    void
    setExternalId(String externalId)
    Intended to hold any unique identifier for this fulfillment as assigned by an external system.
    void
    setFulfillmentAdjustmentsTotal(javax.money.MonetaryAmount fulfillmentAdjustmentsTotal)
    Sum of the fulfillment's adjustments.
    void
    setFulfillmentCharge(javax.money.MonetaryAmount fulfillmentCharge)
    The shipping charge for this fulfillment before adjustments are applied.
    void
    setFulfillmentItems(List<OrderFulfillmentItem> fulfillmentItems)
    Items within this fulfillment, each of which should relate back to a OrderItem.
    void
    setFulfillmentOption(com.broadleafcommerce.order.common.domain.FulfillmentOption fulfillmentOption)
    The fulfillment option chosen for the getType().
    void
    setFulfillmentTotal(javax.money.MonetaryAmount fulfillmentTotal)
    The total shipping price of this fulfillment, including adjustments and item shipping prices.
    void
    setGrandTotal(javax.money.MonetaryAmount grandTotal)
    The grand total of this fulfillment, including merchandise costs, all shipping costs including items, and tax.
    void
    setGroupReferenceNumber(String groupReferenceNumber)
    The reference number of the FulfillmentGroup this fulfillment was created from.
    void
    setId(String id)
    The unique identifier for this fulfillment.
    void
    setIncludedFulfillmentTax(javax.money.MonetaryAmount includedFulfillmentTax)
    The amount of fulfillment taxes that are included in the item subtotal (VAT).
    void
    setIncludedMerchandiseTax(javax.money.MonetaryAmount includedMerchandiseTax)
    The amount of merchandise taxes that are included in the item subtotal (VAT).
    void
    setInventoryLocationReference(String inventoryLocationReference)
    This is an optional field where the ID or reference number of the expected InventoryLocation is stored.
    void
    setMerchandiseTotal(javax.money.MonetaryAmount merchandiseTotal)
    The merchandise total for all items in the fulfillment, including item adjustments and prorated order adjustments.
    void
    setOrderFulfillmentNumber(String orderFulfillmentNumber)
    The number for this individual fulfillment, unique within the order.
    void
    setOrderId(String orderId)
    A soft reference to the parent Order this fulfillment belongs to.
    void
    setOverrideDetails(List<com.broadleafcommerce.order.common.domain.OverrideDetail> overrideDetails)
    List of details about any price overrides which have been performed on this fulfillment.
    void
    setOverrideFulfillmentPriceFlag(boolean overrideFulfillmentPriceFlag)
    Whether the total fulfillment price of this OrderFulfillment was specifically overridden, whether from a CSR or an automatic process.
    void
    setPricedFulfillmentOption(com.broadleafcommerce.order.common.domain.PricedFulfillmentOption pricedFulfillmentOption)
    The PricedFulfillmentOption chosen for the getType().
    void
    setProratedOrderFulfillmentAdjustments(javax.money.MonetaryAmount proratedOrderFulfillmentAdjustments)
    Prorated amount of the fulfillment adjustments that applies to the fulfillmentCharge.
    void
    setRequiresCollectOnDelivery(boolean requiresCollectOnDelivery)
    Whether this OrderFulfillment requires at least part of the payment to be collected on delivery.
    void
    setShipment(Shipment shipment)
    The primary shipment details for this fulfillment.
    void
    setStatus(String status)
    The status of this fulfillment.
    void
    setTaxTotal(javax.money.MonetaryAmount taxTotal)
    The total tax of this fulfillment, including merchandise and fulfillment tax.
    void
    setType(String type)
    The type of means by which this fulfillment is fulfilled.
    void
    setVendorRef(String vendorRef)
    A reference to the corresponding vendor for this fulfillment.
    void
    setVersion(Integer version)
    The version of this OrderFulfillment.
    String
    toString()
     

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • OrderFulfillment

      public OrderFulfillment()

  • Method Details

    • getItemMerchandiseSubtotal

      public javax.money.MonetaryAmount getItemMerchandiseSubtotal()
      Sum up the OrderFulfillmentItem#merchandiseTotalAmount across all of the fulfillment's items.
      Returns:
      the sum of the fulfillment's items' merchandise totals

    • getOrderMerchandiseAdjustmentsTotal

      public javax.money.MonetaryAmount getOrderMerchandiseAdjustmentsTotal()
      Total up the OrderFulfillmentItem.proratedOrderAdjustments for all the items in the fulfillment.
      Returns:
      the total of prorated order adjustments for all items in the fulfillment

    • getId

      public String getId()
      The unique identifier for this fulfillment.

    • getExternalId

      @Nullable public String getExternalId()
      Intended to hold any unique identifier for this fulfillment as assigned by an external system. For example, many implementations may integrate or import/export data from external systems that manage their own unique identifiers.

    • getOrderFulfillmentNumber

      public String getOrderFulfillmentNumber()
      The number for this individual fulfillment, unique within the order.
      Returns:
      the number for this individual fulfillment

    • getGroupReferenceNumber

      public String getGroupReferenceNumber()
      The reference number of the FulfillmentGroup this fulfillment was created from.

      By default, only one OrderFulfillment is created per FulfillmentGroup, but certain implementations may wish to create multiple OrderFulfillments from a single FulfillmentGroup (ex: to support fulfillment splitting, multi-vendor fulfillment, etc).

      This field would provide traceability into finding which OrderFulfillments came from the same FulfillmentGroup.

      Returns:
      the reference number of the FulfillmentGroup this fulfillment was created from
      See Also:
      • FulfillmentGroup.referenceNumber

    • getOrderId

      public String getOrderId()
      A soft reference to the parent Order this fulfillment belongs to.
      Returns:
      the id of the parent Order this fulfillment belongs to

    • getStatus

      public String getStatus()
      The status of this fulfillment.
      Returns:
      the status of this fulfillment
      See Also:

    • getType

      public String getType()
      The type of means by which this fulfillment is fulfilled. This could be SHIP, PICKUP, or VIRTUAL, for example.
      Returns:
      the type of means by which this fulfillment is fulfilled
      See Also:
      • FulfillmentType

    • getVersion

      public Integer getVersion()
      The version of this OrderFulfillment. Used by components making use of the order fulfillment to ensure it is up-to-date and thus prevent race condition scenarios. This should never be manually incremented/decremented.

    • getFulfillmentOption

      @Nullable public com.broadleafcommerce.order.common.domain.FulfillmentOption getFulfillmentOption()
      The fulfillment option chosen for the getType().
      Returns:
      the fulfillment option chosen for the getType()
      See Also:
      • FulfillmentOption

    • getPricedFulfillmentOption

      @Nullable public com.broadleafcommerce.order.common.domain.PricedFulfillmentOption getPricedFulfillmentOption()
      The PricedFulfillmentOption chosen for the getType().
      Returns:
      the PricedFulfillmentOption chosen for the getType()
      See Also:
      • PricedFulfillmentOption

    • getInventoryLocationReference

      public String getInventoryLocationReference()
      This is an optional field where the ID or reference number of the expected InventoryLocation is stored. Specifically, this is required in situations where a customer will pick up this FulfillmentGroup (i.e. type == FulfillmentType.PICKUP). This could also be provided as a hint in the case that this is a SHIP location and the application knows from where this FulfillmentGroup should be fulfilled.
      Returns:
      the ID of the Inventory Location or null

    • getAddress

      public com.broadleafcommerce.order.common.domain.Address getAddress()
      The shipping address for this fulfillment.
      Returns:
      the shipping address for this fulfillment

    • getShipment

      public Shipment getShipment()
      The primary shipment details for this fulfillment.

      Unused if the fulfillment does not require shipping, or if additionalShipments are being used exclusively.

      Returns:
      primary shipment details for this fulfillment

    • getAdditionalShipments

      public List<Shipment> getAdditionalShipments()
      All additional shipment details for this fulfillment.

      Use this when the fulfillment needs to be shipped in multiple parts. These can be defined in conjunction with a primary shipment, or on their own with no primary shipment.

      Returns:
      additional shipment details for this fulfillment

    • getFulfillmentItems

      public List<OrderFulfillmentItem> getFulfillmentItems()
      Items within this fulfillment, each of which should relate back to a OrderItem.
      Returns:
      items within this fulfillment

    • getMerchandiseTotal

      public javax.money.MonetaryAmount getMerchandiseTotal()
      The merchandise total for all items in the fulfillment, including item adjustments and prorated order adjustments.
      Returns:
      merchandise total for all items in the fulfillment, including item adjustments and prorated order adjustments

    • getFulfillmentCharge

      public javax.money.MonetaryAmount getFulfillmentCharge()
      The shipping charge for this fulfillment before adjustments are applied. This is a charge specifically at the fulfillment level and does not include charges from getFulfillmentItems().
      Returns:
      the shipping charge of this fulfillment before adjustments are applied

    • getFulfillmentAdjustmentsTotal

      public javax.money.MonetaryAmount getFulfillmentAdjustmentsTotal()
      Sum of the fulfillment's adjustments.
      Returns:
      Sum of the fulfillment's adjustments.

    • getProratedOrderFulfillmentAdjustments

      public javax.money.MonetaryAmount getProratedOrderFulfillmentAdjustments()
      Prorated amount of the fulfillment adjustments that applies to the fulfillmentCharge. Fulfillment-level adjustments are prorated between the charges of the Fulfillment and those of the individual items.
      Returns:
      Prorated amount of the fulfillment adjustments that applies to the fulfillmentCharge.

    • getFulfillmentTotal

      public javax.money.MonetaryAmount getFulfillmentTotal()
      The total shipping price of this fulfillment, including adjustments and item shipping prices. This does not include taxes.
      Returns:
      the total shipping price of this fulfillment, including adjustments and item shipping prices

    • getTaxTotal

      public javax.money.MonetaryAmount getTaxTotal()
      The total tax of this fulfillment, including merchandise and fulfillment tax.
      Returns:
      the total tax price of this fulfillment

    • getGrandTotal

      public javax.money.MonetaryAmount getGrandTotal()
      The grand total of this fulfillment, including merchandise costs, all shipping costs including items, and tax.
      Returns:
      the grand total of this fulfillment

    • getAdjustments

      public List<com.broadleafcommerce.order.common.domain.Adjustment> getAdjustments()
      Adjustments to fulfillment pricing that should be applied to getFulfillmentCharge().
      Returns:
      adjustments to fulfillment pricing that should be applied to getFulfillmentCharge()

    • isOverrideFulfillmentPriceFlag

      public boolean isOverrideFulfillmentPriceFlag()
      Whether the total fulfillment price of this OrderFulfillment was specifically overridden, whether from a CSR or an automatic process.
      Returns:
      whether the total fulfillment price of this OrderFulfillment was specifically overridden, whether from a CSR or an automatic process

    • getOverrideDetails

      public List<com.broadleafcommerce.order.common.domain.OverrideDetail> getOverrideDetails()
      List of details about any price overrides which have been performed on this fulfillment.
      Returns:
      list of details about any price overrides which have been performed on this fulfillment

    • getVendorRef

      public String getVendorRef()
      A reference to the corresponding vendor for this fulfillment.
      Returns:
      A reference to the corresponding vendor for this fulfillment.

    • getCurrency

      public javax.money.CurrencyUnit getCurrency()
      The currency unit used for the pricing of this OrderFulfillment.
      Specified by:
      getCurrency in interface javax.money.CurrencySupplier
      Returns:
      The currency unit used for the pricing of this OrderFulfillment.

    • isRequiresCollectOnDelivery

      public boolean isRequiresCollectOnDelivery()
      Whether this OrderFulfillment requires at least part of the payment to be collected on delivery.
      Returns:
      true if this OrderFulfillment requires at least part of the payment to be collected on delivery, or false if not.

    • getIncludedMerchandiseTax

      public javax.money.MonetaryAmount getIncludedMerchandiseTax()
      The amount of merchandise taxes that are included in the item subtotal (VAT).

    • getIncludedFulfillmentTax

      public javax.money.MonetaryAmount getIncludedFulfillmentTax()
      The amount of fulfillment taxes that are included in the item subtotal (VAT).

    • getAttributes

      public Map<String,Object> getAttributes()
      Additional attributes for this order fulfillment.
      Returns:
      Additional attributes for this order fulfillment.

    • getContextState

      public com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState getContextState()
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      getContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Returns:
      a subset of Tracking information to expose the context state for this object

    • setId

      public void setId(String id)
      The unique identifier for this fulfillment.

    • setExternalId

      public void setExternalId(@Nullable String externalId)
      Intended to hold any unique identifier for this fulfillment as assigned by an external system. For example, many implementations may integrate or import/export data from external systems that manage their own unique identifiers.

    • setOrderFulfillmentNumber

      public void setOrderFulfillmentNumber(String orderFulfillmentNumber)
      The number for this individual fulfillment, unique within the order.
      Parameters:
      orderFulfillmentNumber - the number for this individual fulfillment

    • setGroupReferenceNumber

      public void setGroupReferenceNumber(String groupReferenceNumber)
      The reference number of the FulfillmentGroup this fulfillment was created from.

      By default, only one OrderFulfillment is created per FulfillmentGroup, but certain implementations may wish to create multiple OrderFulfillments from a single FulfillmentGroup (ex: to support fulfillment splitting, multi-vendor fulfillment, etc).

      This field would provide traceability into finding which OrderFulfillments came from the same FulfillmentGroup.

      Parameters:
      groupReferenceNumber - the reference number of the FulfillmentGroup this fulfillment was created from
      See Also:
      • FulfillmentGroup.referenceNumber

    • setOrderId

      public void setOrderId(String orderId)
      A soft reference to the parent Order this fulfillment belongs to.
      Parameters:
      orderId - the id of the parent Order this fulfillment belongs to

    • setStatus

      public void setStatus(String status)
      The status of this fulfillment.
      Parameters:
      status - the status of this fulfillment
      See Also:

    • setType

      public void setType(String type)
      The type of means by which this fulfillment is fulfilled. This could be SHIP, PICKUP, or VIRTUAL, for example.
      Parameters:
      type - the type of means by which this fulfillment is fulfilled
      See Also:
      • FulfillmentType

    • setVersion

      public void setVersion(Integer version)
      The version of this OrderFulfillment. Used by components making use of the order fulfillment to ensure it is up-to-date and thus prevent race condition scenarios. This should never be manually incremented/decremented.

    • setFulfillmentOption

      public void setFulfillmentOption(@Nullable com.broadleafcommerce.order.common.domain.FulfillmentOption fulfillmentOption)
      The fulfillment option chosen for the getType().
      Parameters:
      fulfillmentOption - the fulfillment option chosen for the getType()
      See Also:
      • FulfillmentOption

    • setPricedFulfillmentOption

      public void setPricedFulfillmentOption(@Nullable com.broadleafcommerce.order.common.domain.PricedFulfillmentOption pricedFulfillmentOption)
      The PricedFulfillmentOption chosen for the getType().
      Parameters:
      pricedFulfillmentOption - The fulfillment option chosen for the getType()
      See Also:
      • PricedFulfillmentOption

    • setInventoryLocationReference

      public void setInventoryLocationReference(String inventoryLocationReference)
      This is an optional field where the ID or reference number of the expected InventoryLocation is stored. Specifically, this is required in situations where a customer will pick up this FulfillmentGroup (i.e. type == FulfillmentType.PICKUP). This could also be provided as a hint in the case that this is a SHIP location and the application knows from where this FulfillmentGroup should be fulfilled.
      Parameters:
      inventoryLocationReference - the ID of the Inventory Location

    • setAddress

      public void setAddress(com.broadleafcommerce.order.common.domain.Address address)
      The shipping address for this fulfillment.
      Parameters:
      address - the shipping address for this fulfillment

    • setShipment

      public void setShipment(Shipment shipment)
      The primary shipment details for this fulfillment.

      Unused if the fulfillment does not require shipping, or if additionalShipments are being used exclusively.

      Parameters:
      shipment - primary shipment details for this fulfillment

    • setAdditionalShipments

      public void setAdditionalShipments(List<Shipment> additionalShipments)
      All additional shipment details for this fulfillment.

      Use this when the fulfillment needs to be shipped in multiple parts. These can be defined in conjunction with a primary shipment, or on their own with no primary shipment.

      Parameters:
      additionalShipments - additional shipment details for this fulfillment

    • setFulfillmentItems

      public void setFulfillmentItems(List<OrderFulfillmentItem> fulfillmentItems)
      Items within this fulfillment, each of which should relate back to a OrderItem.
      Parameters:
      fulfillmentItems - items within this fulfillment

    • setMerchandiseTotal

      public void setMerchandiseTotal(javax.money.MonetaryAmount merchandiseTotal)
      The merchandise total for all items in the fulfillment, including item adjustments and prorated order adjustments.
      Parameters:
      merchandiseTotal - merchandise total for all items in the fulfillment, including item adjustments and prorated order adjustments

    • setFulfillmentCharge

      public void setFulfillmentCharge(javax.money.MonetaryAmount fulfillmentCharge)
      The shipping charge for this fulfillment before adjustments are applied. This is a charge specifically at the fulfillment level and does not include charges from getFulfillmentItems().
      Parameters:
      fulfillmentCharge - the shipping charge of this fulfillment before adjustments are applied

    • setFulfillmentAdjustmentsTotal

      public void setFulfillmentAdjustmentsTotal(javax.money.MonetaryAmount fulfillmentAdjustmentsTotal)
      Sum of the fulfillment's adjustments.
      Parameters:
      fulfillmentAdjustmentsTotal - Sum of the fulfillment's adjustments.

    • setProratedOrderFulfillmentAdjustments

      public void setProratedOrderFulfillmentAdjustments(javax.money.MonetaryAmount proratedOrderFulfillmentAdjustments)
      Prorated amount of the fulfillment adjustments that applies to the fulfillmentCharge. Fulfillment-level adjustments are prorated between the charges of the Fulfillment and those of the individual items.
      Parameters:
      proratedOrderFulfillmentAdjustments - Prorated amount of the fulfillment adjustments that applies to the fulfillmentCharge

    • setFulfillmentTotal

      public void setFulfillmentTotal(javax.money.MonetaryAmount fulfillmentTotal)
      The total shipping price of this fulfillment, including adjustments and item shipping prices. This does not include taxes.
      Parameters:
      fulfillmentTotal - the total shipping price of this fulfillment, including adjustments and item shipping prices

    • setTaxTotal

      public void setTaxTotal(javax.money.MonetaryAmount taxTotal)
      The total tax of this fulfillment, including merchandise and fulfillment tax.
      Parameters:
      totalTax - the total tax price of this fulfillment

    • setGrandTotal

      public void setGrandTotal(javax.money.MonetaryAmount grandTotal)
      The grand total of this fulfillment, including merchandise costs, all shipping costs including items, and tax.
      Parameters:
      grandTotal - the grand total of this fulfillment

    • setAdjustments

      public void setAdjustments(List<com.broadleafcommerce.order.common.domain.Adjustment> adjustments)
      Adjustments to fulfillment pricing that should be applied to getFulfillmentCharge().
      Parameters:
      adjustments - adjustments to fulfillment pricing that should be applied to getFulfillmentCharge()

    • setOverrideFulfillmentPriceFlag

      public void setOverrideFulfillmentPriceFlag(boolean overrideFulfillmentPriceFlag)
      Whether the total fulfillment price of this OrderFulfillment was specifically overridden, whether from a CSR or an automatic process.
      Parameters:
      overrideFulfillmentPriceFlag - whether the total fulfillment price of this OrderFulfillment was specifically overridden, whether from a CSR or an automatic process

    • setOverrideDetails

      public void setOverrideDetails(List<com.broadleafcommerce.order.common.domain.OverrideDetail> overrideDetails)
      List of details about any price overrides which have been performed on this fulfillment.
      Parameters:
      overrideDetails - list of details about any price overrides which have been performed on this fulfillment

    • setVendorRef

      public void setVendorRef(String vendorRef)
      A reference to the corresponding vendor for this fulfillment.
      Parameters:
      vendorRef - A reference to the corresponding vendor for this fulfillment.

    • setCurrency

      public void setCurrency(javax.money.CurrencyUnit currency)
      The currency unit used for the pricing of this OrderFulfillment.
      Specified by:
      setCurrency in interface com.broadleafcommerce.money.CurrencyConsumer
      Parameters:
      currency - The currency unit used for the pricing of this OrderFulfillment.

    • setRequiresCollectOnDelivery

      public void setRequiresCollectOnDelivery(boolean requiresCollectOnDelivery)
      Whether this OrderFulfillment requires at least part of the payment to be collected on delivery.
      Parameters:
      requiresCollectOnDelivery - Whether this OrderFulfillment requires at least part of the payment to be collected on delivery.

    • setIncludedMerchandiseTax

      public void setIncludedMerchandiseTax(javax.money.MonetaryAmount includedMerchandiseTax)
      The amount of merchandise taxes that are included in the item subtotal (VAT).

    • setIncludedFulfillmentTax

      public void setIncludedFulfillmentTax(javax.money.MonetaryAmount includedFulfillmentTax)
      The amount of fulfillment taxes that are included in the item subtotal (VAT).

    • setAttributes

      public void setAttributes(Map<String,Object> attributes)
      Additional attributes for this order fulfillment.
      Parameters:
      attributes - Additional attributes for this order fulfillment.

    • setContextState

      public void setContextState(com.broadleafcommerce.data.tracking.core.filtering.business.domain.ContextState contextState)
      A subset of Tracking information to expose the context state for this object.
      Specified by:
      setContextState in interface com.broadleafcommerce.data.tracking.core.ContextStateAware
      Parameters:
      contextState - a subset of Tracking information to expose the context state for this object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object