com.konakartadmin.modules

Interface ShippingModuleInterface

All Superinterfaces:

ModuleInterface

All Known Implementing Classes:

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

public interface ShippingModuleInterface
extends ModuleInterface

All Konakart shipping modules must implement the ShippingModuleInterface

Field Summary

Fields inherited from interface com.konakartadmin.modules.ModuleInterface

MODULE_SUB_TYPE_PROMOTION, MODULE_TYPE_ORDER_TOTAL, MODULE_TYPE_OTHER, MODULE_TYPE_PAYMENT, MODULE_TYPE_SHIPPING

Method Summary

Modifier and Type	Method and Description
com.konakart.app.ExportOrderResponse	exportOrderForShipping(AdminOrder order, com.konakart.app.ExportOrderOptions options, KKAdminIf adminEng) Export the order for shipping.

Methods inherited from interface com.konakartadmin.modules.ModuleInterface

getClassPrefix, getConfigKeyStub, getConfigs, getImplementationFileName, getKeys, getModuleCode, getModuleSubType, getModuleTitle, getModuleType, init, install, installed, remove, setConfigKeyStub, setInstalled, toString

Method Detail

exportOrderForShipping

com.konakart.app.ExportOrderResponse exportOrderForShipping(AdminOrder order,
                                                            com.konakart.app.ExportOrderOptions options,
                                                            KKAdminIf adminEng)
                                                     throws KKAdminException

Export the order for shipping. This is typically used to create a file that is imported into a 3rd Party shipping application. The format of the file to import will (could?) be different for each shipping system so there is an implementation for each shipping module.

Parameters:

order - AdminOrder object to export for shipping

options - Defines the options to use for the export of the Order

adminEng - A KKAdmin engine which may be useful for accessing configuration variables etc.

Returns:

an ExportOrderResponse object to indicate the result

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine