com.konakartadmin.modules.shipping.flat
Class Flat

java.lang.Object
  extended by com.konakartadmin.modules.Module
      extended by com.konakartadmin.modules.ShippingModule
          extended by com.konakartadmin.modules.shipping.flat.Flat
All Implemented Interfaces:
ModuleInterface, ShippingModuleInterface

public class Flat
extends ShippingModule

Flat Rate shipping module


Field Summary
private static java.lang.String MODULE_CODE
           
 
Fields inherited from class com.konakartadmin.modules.Module
configKeyStub, configs, implementationFileName, keys, log
 
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
 
Constructor Summary
Flat()
           
 
Method Summary
 com.konakart.app.ExportOrderResponse exportOrderForShipping(AdminOrder order, com.konakart.app.ExportOrderOptions options, KKAdminIf adminEng)
          Export the order for shipping.
 java.lang.String getConfigKeyStub()
           
 KKConfiguration[] getConfigs()
           
 java.lang.String getImplementationFileName()
           
 java.lang.String getModuleCode()
           
 java.lang.String getModuleTitle()
           
 
Methods inherited from class com.konakartadmin.modules.ShippingModule
getAdminOrderMgr, getClassPrefix, getConfigVariable, getModuleType, getOrderExportBase, getWeightOfOrder, toString
 
Methods inherited from class com.konakartadmin.modules.Module
getKeys, getModuleSubType, getMsgs, init, install, installed, remove, setConfigKeyStub, setConfigs, setImplementationFileName, setKeys, setMsgs
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.konakartadmin.modules.ModuleInterface
getKeys, getModuleSubType, init, install, installed, remove, setConfigKeyStub
 

Field Detail

MODULE_CODE

private static java.lang.String MODULE_CODE
Constructor Detail

Flat

public Flat()
Method Detail

getConfigKeyStub

public java.lang.String getConfigKeyStub()
Specified by:
getConfigKeyStub in interface ModuleInterface
Overrides:
getConfigKeyStub in class ShippingModule
Returns:
the config key stub

getModuleTitle

public java.lang.String getModuleTitle()
Specified by:
getModuleTitle in interface ModuleInterface
Overrides:
getModuleTitle in class Module
Returns:
the module's title - the friendly name for the user

getImplementationFileName

public java.lang.String getImplementationFileName()
Specified by:
getImplementationFileName in interface ModuleInterface
Overrides:
getImplementationFileName in class Module
Returns:
the implementation filename - for compatibility with osCommerce we use the php name

getModuleCode

public java.lang.String getModuleCode()
Specified by:
getModuleCode in interface ModuleInterface
Overrides:
getModuleCode in class Module
Returns:
the module code

getConfigs

public KKConfiguration[] getConfigs()
Specified by:
getConfigs in interface ModuleInterface
Overrides:
getConfigs in class Module
Returns:
an array of configuration values for this payment module

exportOrderForShipping

public com.konakart.app.ExportOrderResponse exportOrderForShipping(AdminOrder order,
                                                                   com.konakart.app.ExportOrderOptions options,
                                                                   KKAdminIf adminEng)
                                                            throws KKAdminException
Description copied from interface: ShippingModuleInterface
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.

Specified by:
exportOrderForShipping in interface ShippingModuleInterface
Overrides:
exportOrderForShipping in class ShippingModule
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


Copyright © 2011 DS Data Systems UK Ltd.