com.konakart.bl.modules.shipping

Class BaseShippingModule

java.lang.Object

com.konakart.bl.modules.BaseModule

com.konakart.bl.modules.shipping.BaseShippingModule

Direct Known Subclasses:

DigitalDownload, Fedex, Flat, Free, FreeProduct, Item, PickUpInStore, Table, Ups, Usps, Uspsint, Zones

public class BaseShippingModule
extends BaseModule

The Base class for shipping modules

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log The Log instance for this application.

Fields inherited from class com.konakart.bl.modules.BaseModule

basePackage, debugStackTraceExclusions

Constructor Summary

Constructors

Constructor and Description
BaseShippingModule()

Method Summary

Modifier and Type	Method and Description
protected void	checkForProducts(ShippingInfo info) If there are no products it throws an exception since shipping isn't required.
protected void	checkZone(ShippingInfo info, int geoZoneId) Ensures that the geoZoneId is within one of the Geo Zones contained in the ShippingInfo object.
protected KKCriteria	getNewCriteria(boolean allStores) Gets a new KKCriteria object with the option of it being for all stores when in multi-store single db mode.
protected boolean	isGeoZoneMappedToCountry(int geoZoneId, int countryId) In some cases no zones may be defined for a country but a geo zone may be defined to map to all zones of that country.
protected boolean	isMultiStoreShareCustomers() Returns true if we need to share customers in multi-store single db mode

Methods inherited from class com.konakart.bl.modules.BaseModule

getBasketMgr, getCatMgr, getConfigMgr, getConfiguration, getConfigurationValue, getConfigurationValueAsBigDecimalWithDefault, getConfigurationValueAsBool, getConfigurationValueAsIntWithDefault, getCurrMgr, getCustMgr, getCustTagMgr, getDebugStackTraceExclusions, getEmailMgr, getEng, getLangMgr, getModuleClassName, getMultiStoreMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getPromMgr, getRandomText, getRandomText, getResourceBundle, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getTaxMgr, getZoneCodeForZoneName, init, isAvailable, isAvailable, isMultiStoreShareCustomersOrProducts, setDebugStackTraceExclusions, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.commons.logging.Log log

The Log instance for this application.

Constructor Detail

BaseShippingModule

public BaseShippingModule()

Method Detail

checkZone

protected void checkZone(ShippingInfo info,
                         int geoZoneId)
                  throws com.konakart.app.KKException

Ensures that the geoZoneId is within one of the Geo Zones contained in the ShippingInfo object.

Parameters:

info - the ShippingInfo - this defines the items to be shipped

geoZoneId - the geoZoneId

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

isGeoZoneMappedToCountry

protected boolean isGeoZoneMappedToCountry(int geoZoneId,
                                           int countryId)

In some cases no zones may be defined for a country but a geo zone may be defined to map to all zones of that country. On these occasions the DeliveryGeoZoneArray in the ShippingInfo object is null so the checkZone method never returns true.

This method does a search in the zones_to_geo_zones table for any entries matching the geoZoneId, countryId and zoneId of 0 which is the id that is set when the mapping is for all zones of the country.

Parameters:

geoZoneId - the geoZoneId

countryId - the countryId

Returns:

Returns true if there is a mapping

isMultiStoreShareCustomers

protected boolean isMultiStoreShareCustomers()
                                      throws com.konakart.app.KKException

Returns true if we need to share customers in multi-store single db mode

Returns:

true if multiStore and we're sharing customers

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

getNewCriteria

protected KKCriteria getNewCriteria(boolean allStores)

Gets a new KKCriteria object with the option of it being for all stores when in multi-store single db mode.

Overrides:

getNewCriteria in class BaseModule

Parameters:

allStores - the allStores

Returns:

Returns a new KKCriteria object

checkForProducts

protected void checkForProducts(ShippingInfo info)
                         throws com.konakart.app.KKException

If there are no products it throws an exception since shipping isn't required. They may be all digital download products.

Parameters:

info - ShippingInfo object - this defines the items to be shipped

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine