Package com.broadleafcommerce.promotion.offer.client.web.context

Interface FulfillmentGroup<T extends FulfillmentLineItem>

All Known Implementing Classes:
FulfillmentGroupDto
public interface FulfillmentGroup<T extends FulfillmentLineItem>
DTO containing information about a group of items that share the same fulfillment information (means, destination, and payment info).
Author:
Chad Harchar (charchar), Nathan Moore (nathanmoore).

  • Method Details

    • getId

      String getId()
      The id of this group.
      Returns:
      The id of this group.

    • setId

      void setId(String id)
      The id of this group.
      Parameters:
      id - The id of this group.

    • getFulfillmentOptionType

      String getFulfillmentOptionType()
      The type of fulfillment that will be used for this fulfillment group. This could be SHIP, PICKUP, or VIRTUAL, for example.
      Returns:
      The type of means by which this fulfillment group is fulfilled.

    • setFulfillmentOptionType

      void setFulfillmentOptionType(String fulfillmentOptionType)
      The type of fulfillment that will be used for this fulfillment group. This could be SHIP, PICKUP, or VIRTUAL, for example.
      Parameters:
      fulfillmentOptionType - The type of means by which this fulfillment group is fulfilled.

    • getFulfillmentOptionName

      String getFulfillmentOptionName()
      Deprecated.
      instead see the keys in getPriceBeforeAdjustmentsByServiceLevel()
      The name of the fulfillment option used. This could be "Express Shipping", "Priority Shipping", "2-Day Shipping", etc. As of PromotionServices 2.0.4, returns the first element in the getPriceBeforeAdjustmentsByServiceLevel() map if not directly set.
      Returns:
      The name of the fulfillment option used.

    • setFulfillmentOptionName

      void setFulfillmentOptionName(String fulfillmentOptionName)
      Deprecated.
      instead set the key in the map getPriceBeforeAdjustmentsByServiceLevel() along with the associated price.
      The name of the fulfillment option used. This could be "Express Shipping", "Priority Shipping", "2-Day Shipping", etc.
      Parameters:
      fulfillmentOptionName - The name of the fulfillment option used.

    • getDestination

      Destination getDestination()
      The Destination containing information about this fulfillment group's destination address.
      Returns:
      The Destination containing information about this fulfillment group's destination address.
      See Also:

    • setDestination

      void setDestination(Destination destination)
      The Destination containing information about this fulfillment group's destination address.
      Parameters:
      destination - The Destination containing information about this fulfillment group's destination address.
      See Also:

    • getFulfillmentItems

      List<T> getFulfillmentItems()
      Items being fulfilled together in this group.
      Returns:
      Items being fulfilled together in this group.
      See Also:

    • setFulfillmentItems

      void setFulfillmentItems(List<T> fulfillmentItems)
      Items being fulfilled together in this group.
      Parameters:
      fulfillmentItems - Items being fulfilled together in this group.
      See Also:

    • getPrimaryPhone

      String getPrimaryPhone()
      The primary phone number for this fulfillment group.
      Returns:
      The primary phone number for this fulfillment group.

    • setPrimaryPhone

      void setPrimaryPhone(String primaryPhone)
      The primary phone number for this fulfillment group.
      Parameters:
      primaryPhone - The primary phone number for this fulfillment group.

    • getSecondaryPhone

      String getSecondaryPhone()
      The secondary phone number for this fulfillment group.
      Returns:
      The secondary phone number for this fulfillment group.

    • setSecondaryPhone

      void setSecondaryPhone(String secondaryPhone)
      The secondary phone number for this fulfillment group.
      Parameters:
      secondaryPhone - The secondary phone number for this fulfillment group.

    • getFaxNumber

      String getFaxNumber()
      The fax number for this fulfillment group.
      Returns:
      The fax number for this fulfillment group.

    • setFaxNumber

      void setFaxNumber(String faxNumber)
      The fax number for this fulfillment group.
      Parameters:
      faxNumber - The fax number for this fulfillment group.

    • getPriceBeforeAdjustments

      javax.money.MonetaryAmount getPriceBeforeAdjustments()
      The shipping price of this fulfillment group before adjustments are applied. This is pricing specifically at the group level and does not include pricing from getFulfillmentItems(). If no value is set, the sum of the values in getPriceBeforeAdjustmentsByServiceLevel() will be returned.
      Returns:
      The shipping price of this fulfillment group before adjustments are applied.

    • setPriceBeforeAdjustments

      void setPriceBeforeAdjustments(javax.money.MonetaryAmount priceBeforeAdjustments)
      The shipping price of this fulfillment group before adjustments are applied. This is pricing specifically at the group level and does not include pricing from getFulfillmentItems().
      Parameters:
      priceBeforeAdjustments - The shipping price of this fulfillment group before adjustments are applied.

    • getAttributes

      Map<String,Object> getAttributes()
      Additional, unspecified attributes.
      Returns:
      Additional, unspecified attributes

    • setAttributes

      void setAttributes(Map<String,Object> attributes)
      Additional, unspecified attributes.
      Parameters:
      attributes - Additional, unspecified attributes.

    • getPriceBeforeAdjustmentsByServiceLevel

      default Map<String,javax.money.MonetaryAmount> getPriceBeforeAdjustmentsByServiceLevel()
      Out of box implementations will return a Map. This default returns a null value. Custom extensions prior to Release Train 1.8.2 must implement this method to be compatible with the new service level features in FulfillmentServices.