Package com.broadleafcommerce.shipping

Class FulfillmentOption

java.lang.Object
com.broadleafcommerce.shipping.FulfillmentOption
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
BandedFulfillmentPricingOption, FixedFulfillmentPricingOption, VirtualFulfillmentPricingOption
public class FulfillmentOption extends Object implements Serializable
A fulfillment option is used to hold information about a particular type of fulfillment implementation. Third-party fulfillment implementations should extend this to provide their own configuration options particular to that implementation.
Author:
Chad Harchar (charchar)
See Also:

  • Constructor Details

    • FulfillmentOption

      public FulfillmentOption()

  • Method Details

    • getName

      public String getName()
      The name of this option. This is expected to be unique across all options. It is used to determine which option is used for a fulfillment group and what options a specific FulfillmentPricingProvider can provide pricing for.
      Returns:
      The name of this option.

    • getDescription

      public String getDescription()
      The description of this option. Used to display information to a customer.
      Returns:
      The description of this option.

    • isUseFlatRates

      public boolean isUseFlatRates()
      Whether to use flat rates for this option.
      Returns:
      Whether to use flat rates for this option.

    • getTaxCode

      public String getTaxCode()
      The tax code for this option.
      Returns:
      The tax code for this option.

    • isTaxable

      public boolean isTaxable()
      Whether any shipping prices should be taxable for this option.
      Returns:
      Whether any shipping prices should be taxable for this option.

    • setName

      public void setName(String name)
      The name of this option. This is expected to be unique across all options. It is used to determine which option is used for a fulfillment group and what options a specific FulfillmentPricingProvider can provide pricing for.
      Parameters:
      name - The name of this option.

    • setDescription

      public void setDescription(String description)
      The description of this option. Used to display information to a customer.
      Parameters:
      description - The description of this option.

    • setUseFlatRates

      public void setUseFlatRates(boolean useFlatRates)
      Whether to use flat rates for this option.
      Parameters:
      useFlatRates - Whether to use flat rates for this option.

    • setTaxCode

      public void setTaxCode(String taxCode)
      The tax code for this option.
      Parameters:
      taxCode - The tax code for this option.

    • setTaxable

      public void setTaxable(boolean taxable)
      Whether any shipping prices should be taxable for this option.
      Parameters:
      taxable - Whether any shipping prices should be taxable for this option.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object