Interface FulfillmentBand

All Superinterfaces:
Serializable
All Known Subinterfaces:
FulfillmentPriceBand, FulfillmentWeightBand
All Known Implementing Classes:
FulfillmentBandImpl, FulfillmentPriceBandImpl, FulfillmentWeightBandImpl

public interface FulfillmentBand extends Serializable
This entity is a collection of properties shared between different band implementations. Out of the box, Broadleaf provides implementations for banded weight and banded price.
Author:
Phillip Verheyden
  • Method Details

    • getId

      Long getId()
    • setId

      void setId(Long id)
    • getResultAmount

      BigDecimal getResultAmount()
      Gets the amount that should be applied to the fulfillment cost for the FulfillmentGroup. This could be applied as a percentage or as a flat rate, depending on the result of calling #getResultType(). This is required and should never be null
      Returns:
      the amount to apply for this band
    • setResultAmount

      void setResultAmount(BigDecimal resultAmount)
      Sets the amount that should be applied to the fulfillment cost for this band. This can be either a flat rate or a percentage depending on #getResultType().
      Parameters:
      resultAmount - - the percentage or flat rate that should be applied as a fulfillment cost for this band
    • getResultAmountType

      FulfillmentBandResultAmountType getResultAmountType()
      Gets how getResultAmount() should be applied to the fulfillment cost
      Returns:
      the type of getResultAmount() which determines how that value should be calculated into the cost
    • setResultAmountType

      void setResultAmountType(FulfillmentBandResultAmountType resultAmountType)
      Sets how getResultAmount() should be applied to the fulfillment cost
      Parameters:
      resultAmountType - - how the value from getResultAmount() should be applied to the cost of the FulfillmentGroup