Interface FulfillmentBand
- All Superinterfaces:
Serializable
- All Known Subinterfaces:
FulfillmentPriceBand,FulfillmentWeightBand
- All Known Implementing Classes:
FulfillmentBandImpl,FulfillmentPriceBandImpl,FulfillmentWeightBandImpl
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 Summary
Modifier and TypeMethodDescriptiongetId()Gets the amount that should be applied to the fulfillment cost for theFulfillmentGroup.Gets howgetResultAmount()should be applied to the fulfillment costvoidvoidsetResultAmount(BigDecimal resultAmount) Sets the amount that should be applied to the fulfillment cost for this band.voidsetResultAmountType(FulfillmentBandResultAmountType resultAmountType) Sets howgetResultAmount()should be applied to the fulfillment cost
-
Method Details
-
getId
Long getId() -
setId
-
getResultAmount
BigDecimal getResultAmount()Gets the amount that should be applied to the fulfillment cost for theFulfillmentGroup. 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
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 howgetResultAmount()should be applied to the fulfillment cost- Returns:
- the type of
getResultAmount()which determines how that value should be calculated into the cost
-
setResultAmountType
Sets howgetResultAmount()should be applied to the fulfillment cost- Parameters:
resultAmountType- - how the value fromgetResultAmount()should be applied to the cost of theFulfillmentGroup
-