Package org.broadleafcommerce.core.catalog.domain

Interface SkuFee

All Superinterfaces:
Serializable
All Known Implementing Classes:
SkuFeeImpl
public interface SkuFee extends Serializable
Used to represent Sku-specific surcharges when fulfilling this item. For instance there might be a disposal fee when selling batteries or an environmental fee for tires.
Author:
Phillip Verheyden

  • Method Summary

    Modifier and Type
    Method
    Description
    org.broadleafcommerce.common.money.Money
    getAmount()
    Gets the amount to charge for this surcharge
    org.broadleafcommerce.common.currency.domain.BroadleafCurrency
    getCurrency()
     
    String
    getDescription()
    Get the description of the surcharge
    String
    getExpression()
    Gets the optional MVEL expression used as additional criteria to determine if this fee applies
    SkuFeeType
    getFeeType()
     
    Long
    getId()
     
    String
    getName()
    Get the name of the surcharge
    List<Sku>
    getSkus()
    Gets the Skus associated with this surcharge
    Boolean
    getTaxable()
    Gets whether or not this surcharge is taxable.
    void
    setAmount(org.broadleafcommerce.common.money.Money amount)
    Sets the amount to charge for this surcharge
    void
    setCurrency(org.broadleafcommerce.common.currency.domain.BroadleafCurrency currency)
     
    void
    setDescription(String description)
    Sets the fee description
    void
    setExpression(String expression)
    Sets the MVEL expression used to determine if this fee should be applied.
    void
    setFeeType(SkuFeeType feeType)
     
    void
    setId(Long id)
     
    void
    setName(String name)
    Sets the name of the surcharge
    void
    setSkus(List<Sku> skus)
    Sets the Skus associated with this surcharge
    void
    setTaxable(Boolean taxable)
    Sets whether or not this surcharge should be included in tax calculations

  • Method Details

    • getId

      Long getId()

    • setId

      void setId(Long id)

    • getName

      String getName()
      Get the name of the surcharge
      Returns:
      the surcharge name

    • setName

      void setName(String name)
      Sets the name of the surcharge
      Parameters:
      name -

    • getDescription

      String getDescription()
      Get the description of the surcharge
      Returns:
      the surcharge description

    • setDescription

      void setDescription(String description)
      Sets the fee description
      Parameters:
      description -

    • getAmount

      org.broadleafcommerce.common.money.Money getAmount()
      Gets the amount to charge for this surcharge
      Returns:
      the fee amount

    • setAmount

      void setAmount(org.broadleafcommerce.common.money.Money amount)
      Sets the amount to charge for this surcharge
      Parameters:
      amount -

    • getTaxable

      Boolean getTaxable()
      Gets whether or not this surcharge is taxable.
      Returns:
      true if the surcharge is taxable, false otherwise. Defaults to false

    • setTaxable

      void setTaxable(Boolean taxable)
      Sets whether or not this surcharge should be included in tax calculations
      Parameters:
      taxable -

    • getExpression

      String getExpression()
      Gets the optional MVEL expression used as additional criteria to determine if this fee applies
      Returns:
      the MVEL expression of extra criteria to determine if this fee applies

    • setExpression

      void setExpression(String expression)
      Sets the MVEL expression used to determine if this fee should be applied. If this is null or empty, this fee will always be applied
      Parameters:
      expression - - a valid MVEL expression

    • getFeeType

      SkuFeeType getFeeType()

    • setFeeType

      void setFeeType(SkuFeeType feeType)

    • getSkus

      List<Sku> getSkus()
      Gets the Skus associated with this surcharge
      Returns:
      Skus that have this particular surcharge

    • setSkus

      void setSkus(List<Sku> skus)
      Sets the Skus associated with this surcharge
      Parameters:
      skus -

    • getCurrency

      org.broadleafcommerce.common.currency.domain.BroadleafCurrency getCurrency()

    • setCurrency

      void setCurrency(org.broadleafcommerce.common.currency.domain.BroadleafCurrency currency)