Package com.broadleafcommerce.fulfillment.common.domain

Class FulfillmentPricingGroup

java.lang.Object
com.broadleafcommerce.fulfillment.common.domain.FulfillmentPricingGroup
All Implemented Interfaces:
Serializable
public class FulfillmentPricingGroup extends Object implements Serializable
This is synonymous with a Cart's Fulfillment Group but with only those details that are important for fulfillment pricing.
See Also:

  • Constructor Details

    • FulfillmentPricingGroup

      public FulfillmentPricingGroup()

  • Method Details

    • getId

      @NonNull public @NonNull String getId()
      The reference number of the FulfillmentGroup that this group represents.

    • getGroupSubtotal

      @Nullable public javax.money.MonetaryAmount getGroupSubtotal()
      Optional merchandise subtotal of the Fulfillment Group. System will attempt to calculate from the contained fulfillment items if not provided.

    • getTotalGroupWeight

      @Nullable public Weight getTotalGroupWeight()
      Optional aggregate weight of all items in the group. System will attempt to calculate from the contained fulfillment items if not provided.

    • getAddress

      @NonNull public @NonNull Address getAddress()
      The fulfillment address. This could be either a Ship-To address or a Store address. Calculators are configured to work with certain destinations and will use the passed in address to select the best calculator. Some implementations may work without any address information, most will require at least a country. Some calculator configurations may require state and even postal code to compute the correct shipping options and prices.

    • getFulfillmentType

      @NonNull public @NonNull String getFulfillmentType()
      The fulfillment type of this group. This is typically SHIP or PICKUP, but may otherwise be defined by the implementor, as needed. This provides context for the address. All items in this group are expected to have the same fulfillment type.

    • getServiceLevel

      @Nullable public String getServiceLevel()
      Service level for the group. Applicable if pricing for the group; otherwise can work as a default for item level pricing where the service level is not set.

    • getItems

      @NonNull public @NonNull List<FulfillmentPricingItem> getItems()
      List of items in this group that need to be fulfilled.

    • setId

      public void setId(@NonNull @NonNull String id)
      The reference number of the FulfillmentGroup that this group represents.

    • setGroupSubtotal

      public void setGroupSubtotal(@Nullable javax.money.MonetaryAmount groupSubtotal)
      Optional merchandise subtotal of the Fulfillment Group. System will attempt to calculate from the contained fulfillment items if not provided.

    • setTotalGroupWeight

      public void setTotalGroupWeight(@Nullable Weight totalGroupWeight)
      Optional aggregate weight of all items in the group. System will attempt to calculate from the contained fulfillment items if not provided.

    • setAddress

      public void setAddress(@NonNull @NonNull Address address)
      The fulfillment address. This could be either a Ship-To address or a Store address. Calculators are configured to work with certain destinations and will use the passed in address to select the best calculator. Some implementations may work without any address information, most will require at least a country. Some calculator configurations may require state and even postal code to compute the correct shipping options and prices.

    • setFulfillmentType

      public void setFulfillmentType(@NonNull @NonNull String fulfillmentType)
      The fulfillment type of this group. This is typically SHIP or PICKUP, but may otherwise be defined by the implementor, as needed. This provides context for the address. All items in this group are expected to have the same fulfillment type.

    • setServiceLevel

      public void setServiceLevel(@Nullable String serviceLevel)
      Service level for the group. Applicable if pricing for the group; otherwise can work as a default for item level pricing where the service level is not set.

    • setItems

      public void setItems(@NonNull @NonNull List<FulfillmentPricingItem> items)
      List of items in this group that need to be fulfilled.