Package com.broadleafcommerce.fulfillment.common.domain

Class FulfillmentOptionRequest

java.lang.Object
com.broadleafcommerce.fulfillment.common.domain.FulfillmentOptionRequest
public class FulfillmentOptionRequest extends Object
Contains cart data needed by FulfillmentServices to produce fulfillment options.

  • Constructor Details

    • FulfillmentOptionRequest

      public FulfillmentOptionRequest()

  • Method Details

    • getCartSubtotal

      @Nullable public javax.money.MonetaryAmount getCartSubtotal()
      This is an optional field. If not provided, the system will attempt to populate it by summing the values of all fulfillmentPriceGroups.

    • getTotalCartWeight

      @Nullable public Weight getTotalCartWeight()
      Optional total weight of the items in the cart. If not provided, the system will attempt to populate it by summing the values of all of the items in the fulfillmentPriceGroups.

    • getFulfillmentPriceGroups

      @NonNull public @NonNull List<FulfillmentPricingGroup> getFulfillmentPriceGroups()
      List of FulfillmentPricingGroup containing data from each FulfillmentGroup pertinent to fulfillment pricing.

    • isPriceCurrentServiceLevelsOnly

      public boolean isPriceCurrentServiceLevelsOnly()
      Indicate whether all options should being priced or only the current selections.

    • getAdditionalAttributes

      @NonNull public @NonNull Map<String,Object> getAdditionalAttributes()
      Map to hold arbitrary additional attributes.

    • setCartSubtotal

      public void setCartSubtotal(@Nullable javax.money.MonetaryAmount cartSubtotal)
      This is an optional field. If not provided, the system will attempt to populate it by summing the values of all fulfillmentPriceGroups.

    • setTotalCartWeight

      public void setTotalCartWeight(@Nullable Weight totalCartWeight)
      Optional total weight of the items in the cart. If not provided, the system will attempt to populate it by summing the values of all of the items in the fulfillmentPriceGroups.

    • setFulfillmentPriceGroups

      public void setFulfillmentPriceGroups(@NonNull @NonNull List<FulfillmentPricingGroup> fulfillmentPriceGroups)
      List of FulfillmentPricingGroup containing data from each FulfillmentGroup pertinent to fulfillment pricing.

    • setPriceCurrentServiceLevelsOnly

      public void setPriceCurrentServiceLevelsOnly(boolean priceCurrentServiceLevelsOnly)
      Indicate whether all options should being priced or only the current selections.

    • setAdditionalAttributes

      public void setAdditionalAttributes(@NonNull @NonNull Map<String,Object> additionalAttributes)
      Map to hold arbitrary additional attributes.