com.konakartadmin.modules.shipping.ups

Class Ups

java.lang.Object

com.konakartadmin.modules.Module

com.konakartadmin.modules.ShippingModule

com.konakartadmin.modules.shipping.ups.Ups

All Implemented Interfaces:

ModuleInterface, ShippingModuleInterface

public class Ups
extends ShippingModule

UPS shipping module

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	MODULE_CODE
private static java.lang.String	MODULE_SHIPPING_UPS_USERID
private static java.util.HashMap<java.lang.String,java.lang.String>	serviceTypeMap
private static java.lang.String	SHIP_FROM_CITY
private static java.lang.String	SHIP_FROM_STREET_ADDRESS
private static java.lang.String	SHIPPING_ORIGIN_COUNTRY
private static java.lang.String	SHIPPING_ORIGIN_ZIP

Fields inherited from class com.konakartadmin.modules.Module

configKeyStub, configs, implementationFileName, installed, 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

Constructors

Constructor and Description
Ups()

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.
java.lang.String	getConfigKeyStub()
KKConfiguration[]	getConfigs()
java.lang.String	getImplementationFileName()
java.lang.String	getModuleCode()
java.lang.String	getModuleTitle()
private void	setServiceTypeMap() Defines mappings between UPS service codes and service types.

Methods inherited from class com.konakartadmin.modules.ShippingModule

getAdminOrderMgr, getClassPrefix, getConfigVariable, getModuleType, getOrderExportBase, getWeightOfOrder, toString

Methods inherited from class com.konakartadmin.modules.Module

getKeys, getKonakartTimeStampDate, getModuleSubType, getMsgs, init, install, installed, remove, setConfigKeyStub, setConfigs, setImplementationFileName, setInstalled, 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, setInstalled

Field Detail

MODULE_CODE

private static java.lang.String MODULE_CODE

MODULE_SHIPPING_UPS_USERID

private static final java.lang.String MODULE_SHIPPING_UPS_USERID

See Also:

Constant Field Values

SHIPPING_ORIGIN_COUNTRY

private static final java.lang.String SHIPPING_ORIGIN_COUNTRY

See Also:

Constant Field Values

SHIPPING_ORIGIN_ZIP

private static final java.lang.String SHIPPING_ORIGIN_ZIP

See Also:

Constant Field Values

SHIP_FROM_CITY

private static final java.lang.String SHIP_FROM_CITY

See Also:

Constant Field Values

SHIP_FROM_STREET_ADDRESS

private static final java.lang.String SHIP_FROM_STREET_ADDRESS

See Also:

Constant Field Values

serviceTypeMap

private static java.util.HashMap<java.lang.String,java.lang.String> serviceTypeMap

Constructor Detail

Ups

public Ups()

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

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 - an unexpected exception in the KonaKart Admin engine

setServiceTypeMap

private void setServiceTypeMap()

Defines mappings between UPS service codes and service types.