de.hybris.platform.order

Interface ZoneDeliveryModeService

All Superinterfaces:

DeliveryModeService

All Known Implementing Classes:

DefaultZoneDeliveryModeService

public interface ZoneDeliveryModeService
extends DeliveryModeService

Service around the ZoneDeliveryModeModel. You may find more info about delivery modes here. The service allows finding ZoneDeliveryModeModel by code. Service returns also specific delivery costs for specified zone, currency and delivery mode.

Spring Bean ID:

zoneDeliveryModeService

Method Summary

Modifier and Type	Method and Description
java.util.Collection<ZoneModel>	getAllZones() Gets all ZoneModels.
java.util.Collection<CurrencyModel>	getCurrencies(ZoneModel zone, ZoneDeliveryModeModel zoneDeliveryMode) Gets all currencies for which values are defined in the zone and in the delivery mode.
ZoneDeliveryModeValueModel	getDeliveryValue(ZoneModel zone, CurrencyModel currency, java.lang.Double min, ZoneDeliveryModeModel zoneDeliveryMode) Gets specific ZoneDeliveryModeValueModel for the given zone, currency, minimum value, and zone delivery mode.
java.util.Map<java.lang.Double,java.lang.Double>	getDeliveryValues(CurrencyModel currency, ZoneModel zone, ZoneDeliveryModeModel zoneDeliveryMode) Gets all delivery cost values for the currency in the zone and with the specific delivery mode.
ZoneModel	getZoneForCode(java.lang.String code) Gets the ZoneModel with the specified code.
java.util.Collection<ZoneModel>	getZonesForZoneDeliveryMode(ZoneDeliveryModeModel zoneDeliveryMode) Gets all zones for which price values are defined in the delivery mode.
boolean	isUsingPrice(ZoneDeliveryModeModel zoneDeliveryMode) Checks whether the ZoneDeliveryModeModel uses the order subtotal as calculation base.
boolean	isZoneAllowed(ZoneModel zone, ZoneDeliveryModeModel zoneDeliveryMode) Checks whether the zone is allowed to be used for adding new values to the delivery mode.
ZoneDeliveryModeValueModel	setDeliveryCost(CurrencyModel currency, java.lang.Double min, java.lang.Double value, ZoneModel zone, ZoneDeliveryModeModel zoneDeliveryMode) Sets the delivery cost for the given zone, currency, minimum value, and zone delivery mode.
void	setUsingPrice(ZoneDeliveryModeModel zoneDeliveryMode) Sets the special price property name for the ZoneDeliveryModeModel conveniently.

Methods inherited from interface de.hybris.platform.order.DeliveryModeService

getAllDeliveryModes, getDeliveryModeForCode, getSupportedDeliveryModes

Method Detail

getZoneForCode

ZoneModel getZoneForCode(java.lang.String code)

Gets the ZoneModel with the specified code.

Parameters:

code - the zone code

Returns:

the found ZoneModel with the specified code

getAllZones

java.util.Collection<ZoneModel> getAllZones()

Gets all ZoneModels.

Returns:

a Collection of all ZoneModels

getZonesForZoneDeliveryMode

java.util.Collection<ZoneModel> getZonesForZoneDeliveryMode(ZoneDeliveryModeModel zoneDeliveryMode)

Gets all zones for which price values are defined in the delivery mode.

Parameters:

zoneDeliveryMode - the zone delivery mode

Returns:

all ZoneModels for the delivery mode

getCurrencies

java.util.Collection<CurrencyModel> getCurrencies(ZoneModel zone,
                                                  ZoneDeliveryModeModel zoneDeliveryMode)

Gets all currencies for which values are defined in the zone and in the delivery mode.

Parameters:

zone - the zone

zoneDeliveryMode - the zone delivery mode

Returns:

all found CurrencyModels

isZoneAllowed

boolean isZoneAllowed(ZoneModel zone,
                      ZoneDeliveryModeModel zoneDeliveryMode)

Checks whether the zone is allowed to be used for adding new values to the delivery mode. This is necessary because two zones may share countries so the delivery mode can no longer calculate distinct prices for a specific country.

Parameters:

zone - the zone to be checked

zoneDeliveryMode - the zone delivery mode

Returns:

true if the zone is allowed for the delivery mode, false otherwise

getDeliveryValues

java.util.Map<java.lang.Double,java.lang.Double> getDeliveryValues(CurrencyModel currency,
                                                                   ZoneModel zone,
                                                                   ZoneDeliveryModeModel zoneDeliveryMode)

Gets all delivery cost values for the currency in the zone and with the specific delivery mode.

Parameters:

currency - the currency

zone - the zone

zoneDeliveryMode - the zone delivery mode

Returns:

All delivery cost values consisting of minimum threshold value and cost value.

getDeliveryValue

ZoneDeliveryModeValueModel getDeliveryValue(ZoneModel zone,
                                            CurrencyModel currency,
                                            java.lang.Double min,
                                            ZoneDeliveryModeModel zoneDeliveryMode)

Gets specific ZoneDeliveryModeValueModel for the given zone, currency, minimum value, and zone delivery mode.

Parameters:

zone - the zone

currency - the currency

min - the minimum value

zoneDeliveryMode - the zone delivery mode

Returns:

found ZoneDeliveryModeValueModel

setDeliveryCost

ZoneDeliveryModeValueModel setDeliveryCost(CurrencyModel currency,
                                           java.lang.Double min,
                                           java.lang.Double value,
                                           ZoneModel zone,
                                           ZoneDeliveryModeModel zoneDeliveryMode)
                                    throws DeliveryModeInterceptorException

Sets the delivery cost for the given zone, currency, minimum value, and zone delivery mode. Creates a new ZoneDeliveryModeValueModel if no ZoneDeliveryModeValueModel can be found.

Parameters:

currency - the currency

min - the minimum value

value - the delivery cost value

zone - the zone

zoneDeliveryMode - the zone delivery mode

Returns:

changed ZoneDeliveryModeValueModel with new delivery cost value or the created ZoneDeliveryModeValueModel

Throws:

DeliveryModeInterceptorException - if there is ambiguous zone for the ZoneDeliveryModeModel

setUsingPrice

void setUsingPrice(ZoneDeliveryModeModel zoneDeliveryMode)

Sets the special price property name for the ZoneDeliveryModeModel conveniently. If the property is set, the ZoneDeliveryModeModel would use order's subtotal as calculation base.

Parameters:

zoneDeliveryMode - the zone delivery mode

isUsingPrice

boolean isUsingPrice(ZoneDeliveryModeModel zoneDeliveryMode)

Checks whether the ZoneDeliveryModeModel uses the order subtotal as calculation base.

Parameters:

zoneDeliveryMode - the zone delivery mode