Package com.broadleafcommerce.fulfillment.service.dto.calculator

Class DBFulfillmentCalculator

java.lang.Object

com.broadleafcommerce.fulfillment.service.dto.calculator.DBFulfillmentCalculator

All Implemented Interfaces:

FulfillmentCalculator

public class DBFulfillmentCalculator
extends Object
implements FulfillmentCalculator

Field Summary

Fields inherited from interface com.broadleafcommerce.fulfillment.service.dto.calculator.FulfillmentCalculator

DEFAULT_CALCULATOR_TYPE_PRIORITY, DEFAULT_FLAT_RATE_TYPE_PRIORITY, FLAT_RATE_ITEM_ATTR, UNKNOWN

Constructor Summary

Constructors

Constructor	Description
DBFulfillmentCalculator()
DBFulfillmentCalculator(FulfillmentCalculatorConfig fulfillmentCalculatorConfig, GeoCoordinateService geoCoordinateService, WeightCalculationHelper weightCalculationHelper, DistanceCalculationHelper distanceCalculationHelper)

Method Summary

Modifier and Type	Method	Description
protected boolean	addressIsWithinRadius(FulfillmentDestinationDetail detail, com.broadleafcommerce.fulfillment.common.domain.Address address)
boolean	canHandle(EnhancedFulfillmentPricingItem item)
protected com.broadleafcommerce.fulfillment.common.domain.Address	convertDetailToAddress(FulfillmentDestinationDetail detail)
protected DistanceCalculationHelper	getDistanceCalculationHelper()
Integer	getEstimatedMaxDaysToFulfill()
Integer	getEstimatedMinDaysToFulfill()
FulfillmentCalculatorConfig	getFulfillmentCalculatorConfig()
protected GeoCoordinateService	getGeoCoordinateService()
String	getId()	Returns the id of this calculator
String	getName()	Returns the name of this calculator
Integer	getPriority()
String	getServiceLevel()	Returns the service level that this calculator is able to operate on.
protected WeightCalculationHelper	getWeightCalculationHelper()
boolean	hasCalculatorConfig()
protected boolean	isDimensionRestricted(EnhancedFulfillmentPricingItem item)
boolean	isEnabled(Instant now)	Indicates whether this calculator should be used.
protected boolean	isWeightRestricted(EnhancedFulfillmentPricingItem item)
protected boolean	itemIsNotRestricted(EnhancedFulfillmentPricingItem item)
boolean	matchesAddress(com.broadleafcommerce.fulfillment.common.domain.Address address)	Returns true if this calculator can compute prices for the passed in Address
boolean	matchesCurrency(javax.money.CurrencyUnit currencyUnit)
protected boolean	matchesDestination(FulfillmentDestination destination, com.broadleafcommerce.fulfillment.common.domain.Address address)
protected boolean	matchesDestinationDetail(FulfillmentDestinationDetail detail, com.broadleafcommerce.fulfillment.common.domain.Address address)
boolean	matchesFulfillmentType(String type)	Returns true if the calculator can handle the passed in fulfillment type.
boolean	matchesInventoryType(String type)	Returns true if the calculator can handle the passed in inventory type.
boolean	matchesOriginInfo(com.broadleafcommerce.fulfillment.common.domain.FulfillmentOriginInfo originInfo)	Returns true if the FulfillmentOriginInfo can be handled by this calculator.
void	setDistanceCalculationHelper(DistanceCalculationHelper distanceCalculationHelper)
void	setFulfillmentCalculatorConfig(FulfillmentCalculatorConfig fulfillmentCalculatorConfig)
void	setGeoCoordinateService(GeoCoordinateService geoCoordinateService)
void	setWeightCalculationHelper(WeightCalculationHelper weightCalculationHelper)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.broadleafcommerce.fulfillment.service.dto.calculator.FulfillmentCalculator

getCalculatorTypePriority, getType, matchesAnyFulfillmentTypes, matchesAnyInventoryTypes, matchesAnyOriginInfo, setCalculatorTypePriority

Constructor Details

DBFulfillmentCalculator

public DBFulfillmentCalculator()

DBFulfillmentCalculator

public DBFulfillmentCalculator(FulfillmentCalculatorConfig fulfillmentCalculatorConfig,
 @Nullable
 GeoCoordinateService geoCoordinateService,
 WeightCalculationHelper weightCalculationHelper,
 DistanceCalculationHelper distanceCalculationHelper)

Method Details

getPriority

public Integer getPriority()

Specified by:

getPriority in interface FulfillmentCalculator

getName

public String getName()

Description copied from interface: FulfillmentCalculator

Returns the name of this calculator

Specified by:

getName in interface FulfillmentCalculator

Returns:

The name of the calculator which is useful for debugging.

getId

public String getId()

Description copied from interface: FulfillmentCalculator

Returns the id of this calculator

Specified by:

getId in interface FulfillmentCalculator

Returns:

The id for this calculator which must be unique.

isEnabled

public boolean isEnabled(Instant now)

Description copied from interface: FulfillmentCalculator

Indicates whether this calculator should be used. Database driven calculators will rely on active dates. Configured calculators can be disabled by setting this property.

Specified by:

isEnabled in interface FulfillmentCalculator

Returns:

true if this calculator is enabled

getServiceLevel

public String getServiceLevel()

Description copied from interface: FulfillmentCalculator

Returns the service level that this calculator is able to operate on.

Specified by:

getServiceLevel in interface FulfillmentCalculator

Returns:

The service level

matchesCurrency

public boolean matchesCurrency(javax.money.CurrencyUnit currencyUnit)

Specified by:

matchesCurrency in interface FulfillmentCalculator

matchesAddress

public boolean matchesAddress(com.broadleafcommerce.fulfillment.common.domain.Address address)

Description copied from interface: FulfillmentCalculator

Returns true if this calculator can compute prices for the passed in Address

Specified by:

matchesAddress in interface FulfillmentCalculator

Returns:

See Also:

• matchesAddress(Address)

canHandle

public boolean canHandle(EnhancedFulfillmentPricingItem item)

Specified by:

canHandle in interface FulfillmentCalculator

matchesOriginInfo

public boolean matchesOriginInfo(com.broadleafcommerce.fulfillment.common.domain.FulfillmentOriginInfo originInfo)

Description copied from interface: FulfillmentCalculator

Returns true if the FulfillmentOriginInfo can be handled by this calculator. The origin info is typically a container of inventory location references but can be implementation dependent.

Specified by:

matchesOriginInfo in interface FulfillmentCalculator

Returns:

matchesInventoryType

public boolean matchesInventoryType(String type)

Description copied from interface: FulfillmentCalculator

Returns true if the calculator can handle the passed in inventory type.

Specified by:

matchesInventoryType in interface FulfillmentCalculator

Parameters:

type - The type to check

Returns:

matchesFulfillmentType

public boolean matchesFulfillmentType(String type)

Description copied from interface: FulfillmentCalculator

Returns true if the calculator can handle the passed in fulfillment type.

Specified by:

matchesFulfillmentType in interface FulfillmentCalculator

Parameters:

type - The type to check

Returns:

getEstimatedMinDaysToFulfill

public Integer getEstimatedMinDaysToFulfill()

Specified by:

getEstimatedMinDaysToFulfill in interface FulfillmentCalculator

getEstimatedMaxDaysToFulfill

public Integer getEstimatedMaxDaysToFulfill()

Specified by:

getEstimatedMaxDaysToFulfill in interface FulfillmentCalculator

hasCalculatorConfig

public boolean hasCalculatorConfig()

Specified by:

hasCalculatorConfig in interface FulfillmentCalculator

matchesDestination

protected boolean matchesDestination(FulfillmentDestination destination,
 com.broadleafcommerce.fulfillment.common.domain.Address address)

matchesDestinationDetail

protected boolean matchesDestinationDetail(FulfillmentDestinationDetail detail,
 com.broadleafcommerce.fulfillment.common.domain.Address address)

addressIsWithinRadius

protected boolean addressIsWithinRadius(FulfillmentDestinationDetail detail,
 com.broadleafcommerce.fulfillment.common.domain.Address address)

convertDetailToAddress

protected com.broadleafcommerce.fulfillment.common.domain.Address convertDetailToAddress(FulfillmentDestinationDetail detail)

itemIsNotRestricted

protected boolean itemIsNotRestricted(EnhancedFulfillmentPricingItem item)

isWeightRestricted

protected boolean isWeightRestricted(EnhancedFulfillmentPricingItem item)

isDimensionRestricted

protected boolean isDimensionRestricted(EnhancedFulfillmentPricingItem item)

setFulfillmentCalculatorConfig

public void setFulfillmentCalculatorConfig(FulfillmentCalculatorConfig fulfillmentCalculatorConfig)

setGeoCoordinateService

public void setGeoCoordinateService(@Nullable
 GeoCoordinateService geoCoordinateService)

setWeightCalculationHelper

public void setWeightCalculationHelper(WeightCalculationHelper weightCalculationHelper)

setDistanceCalculationHelper

public void setDistanceCalculationHelper(DistanceCalculationHelper distanceCalculationHelper)

getFulfillmentCalculatorConfig

public FulfillmentCalculatorConfig getFulfillmentCalculatorConfig()

Specified by:

getFulfillmentCalculatorConfig in interface FulfillmentCalculator

getGeoCoordinateService

@Nullable
protected GeoCoordinateService getGeoCoordinateService()

getWeightCalculationHelper

protected WeightCalculationHelper getWeightCalculationHelper()

getDistanceCalculationHelper

protected DistanceCalculationHelper getDistanceCalculationHelper()