com.konakart.bl

Class ExportMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.ExportMgr

All Implemented Interfaces:

ExportMgrIf

Direct Known Subclasses:

ExportMgrEE

public class ExportMgr
extends BaseMgr
implements ExportMgrIf

Used to export data

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	erpOutputQueuePrefix Prefix for output queue
protected static org.apache.commons.logging.Log	log the log

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
ExportMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
void	exportCustomer(java.lang.String storeId, int customerId, CustomerRegistrationIf custReg, java.lang.String type) Get the customer from the customer Id and export it
void	exportOrder(java.lang.String storeId, int orderId) Write the order with the specified Id to a queue
void	exportOrder(java.lang.String storeId, OrderIf order) Write the order to a queue
IOAddress	getBillingAddressFromOrder(OrderIf order, java.util.HashMap<java.lang.String,CountryIf> countryMap) Create an IOAddress for the billing address
IOAddress	getCustomerAddressFromOrder(OrderIf order, java.util.HashMap<java.lang.String,CountryIf> countryMap) Create an IOAddress for the customer
IOAddress	getDeliverAddressFromOrder(OrderIf order, java.util.HashMap<java.lang.String,CountryIf> countryMap) Create an IOAddress for the delivery address
java.lang.String	getERPOutputQueuePrefix()
java.lang.String[]	getIntegrations() Returns an array of strings containing the integration names
IOCustomerOut	getIOCustomer(int customerId, CustomerRegistrationIf custReg) Get an IOCustomerOut object from a kkCustomerId
IOOrderOut	getIOOrder(OrderIf orderIn) Creates an IOOrder object (ready to export) from an OrderIf object.
boolean	isERPEnabled()
boolean	isExportCustomer()
boolean	isExportOrder()
boolean	isUpdateObjectEnabled(int objectType, int operationType) Utility that returns true or false depending to determine whether a message should be exported when an object has been modified
void	setERPOutputQueuePrefix(java.lang.String erpOutputQueuePrefix)
void	updateObject(java.lang.String storeId, int objectType, int operationType, int kkObjectId) Writes an updateObject message to the queue.
void	updateObject(java.lang.String storeId, int objectType, int operationType, int kkObjectId, java.lang.String objectId1, java.lang.String objectId2, java.lang.String value1, java.lang.String value2) Writes an updateObject message to the queue.
void	writeToQueue(java.lang.String storeId, java.lang.String msg) Method to post data to a queue based on the storeId

Methods inherited from class com.konakart.bl.BaseMgr

acquireLock, addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkRequired, escapeHTML, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getAdminEngMgr, getBasketMgr, getBillingMgr, getBookableProductMgr, getCacheMgr, getCatMgr, getConfigMgr, getCookieMgr, getCurrMgr, getCustMgr, getCustomerIdFromSession, getCustomerStatsMgr, getCustomerTagMgr, getEmailMgr, getEng, getEventMgr, getExportMgr, getHTMLEscaper, getKonaKartConfig, getKonaKartConfig, getKonaKartConfig, getLangMgr, getManuMgr, getMiscItemMgr, getMiscPriceMgr, getMode, getModeString, getMqMgr, getMultiStoreMgr, getNewCriteria, getNewCriteria, getOrderIntegrationMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getProductsToCategoresCriteria, getPromMgr, getPunchOutMgr, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getStoreTime, getSuggestionMgr, getTaxMgr, getTemplate, getTemplateRoot, getVelocityContextMgr, getWishListMgr, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isClassPresent, isCommunity, isDeadlockException, isEnterprise, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreSharedDb, isMultiStoreShareProducts, isMultiVendor, isUnix, manageThrowable, releaseLock, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

the log

erpOutputQueuePrefix

protected java.lang.String erpOutputQueuePrefix

Prefix for output queue

Constructor Detail

ExportMgr

public ExportMgr(KKEngIf eng)
          throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

exportOrder

public void exportOrder(java.lang.String storeId,
                        OrderIf order)
                 throws java.lang.Exception

Write the order to a queue

Specified by:

exportOrder in interface ExportMgrIf

Parameters:

storeId - the storeId

order - the order

Throws:

java.lang.Exception - an unexpected exception

exportOrder

public void exportOrder(java.lang.String storeId,
                        int orderId)
                 throws java.lang.Exception

Write the order with the specified Id to a queue

Specified by:

exportOrder in interface ExportMgrIf

Parameters:

storeId - the storeId

orderId - the orderId

Throws:

java.lang.Exception - an unexpected exception

getIOOrder

public IOOrderOut getIOOrder(OrderIf orderIn)
                      throws java.lang.Exception

Creates an IOOrder object (ready to export) from an OrderIf object.

Specified by:

getIOOrder in interface ExportMgrIf

Parameters:

orderIn - the orderIn

Returns:

IOOrderOut

Throws:

java.lang.Exception - an unexpected exception

getCustomerAddressFromOrder

public IOAddress getCustomerAddressFromOrder(OrderIf order,
                                             java.util.HashMap<java.lang.String,CountryIf> countryMap)
                                      throws com.konakart.app.KKException

Create an IOAddress for the customer

Specified by:

getCustomerAddressFromOrder in interface ExportMgrIf

Parameters:

order - the order

countryMap - the countryMap

Returns:

Returns an IOAddress object

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getBillingAddressFromOrder

public IOAddress getBillingAddressFromOrder(OrderIf order,
                                            java.util.HashMap<java.lang.String,CountryIf> countryMap)
                                     throws java.lang.Exception

Create an IOAddress for the billing address

Specified by:

getBillingAddressFromOrder in interface ExportMgrIf

Parameters:

order - the order

countryMap - the countryMap

Returns:

Returns an IOAddress object

Throws:

java.lang.Exception - an unexpected exception

getDeliverAddressFromOrder

public IOAddress getDeliverAddressFromOrder(OrderIf order,
                                            java.util.HashMap<java.lang.String,CountryIf> countryMap)
                                     throws java.lang.Exception

Create an IOAddress for the delivery address

Specified by:

getDeliverAddressFromOrder in interface ExportMgrIf

Parameters:

order - the order

countryMap - the countryMap

Returns:

Returns an IOAddress object

Throws:

java.lang.Exception - an unexpected exception

exportCustomer

public void exportCustomer(java.lang.String storeId,
                           int customerId,
                           CustomerRegistrationIf custReg,
                           java.lang.String type)
                    throws java.lang.Exception

Get the customer from the customer Id and export it

Specified by:

exportCustomer in interface ExportMgrIf

Parameters:

storeId - the storeId

customerId - the customerId

custReg - the custReg

type - INSERT or UPDATE

Throws:

java.lang.Exception - an unexpected exception

getIOCustomer

public IOCustomerOut getIOCustomer(int customerId,
                                   CustomerRegistrationIf custReg)
                            throws java.lang.Exception

Get an IOCustomerOut object from a kkCustomerId

Specified by:

getIOCustomer in interface ExportMgrIf

Parameters:

customerId - the customerId

custReg - the custReg

Returns:

IOCustomerOut

Throws:

java.lang.Exception - an unexpected exception

writeToQueue

public void writeToQueue(java.lang.String storeId,
                         java.lang.String msg)
                  throws java.lang.Exception

Method to post data to a queue based on the storeId

Specified by:

writeToQueue in interface ExportMgrIf

Parameters:

storeId - the storeId

msg - the msg

Throws:

java.lang.Exception - an unexpected exception

getERPOutputQueuePrefix

public java.lang.String getERPOutputQueuePrefix()

Specified by:

getERPOutputQueuePrefix in interface ExportMgrIf

Returns:

the erpOutputQueuePrefix

setERPOutputQueuePrefix

public void setERPOutputQueuePrefix(java.lang.String erpOutputQueuePrefix)

Specified by:

setERPOutputQueuePrefix in interface ExportMgrIf

Parameters:

erpOutputQueuePrefix - the erpOutputQueuePrefix to set

updateObject

public void updateObject(java.lang.String storeId,
                         int objectType,
                         int operationType,
                         int kkObjectId)
                  throws java.lang.Exception

Writes an updateObject message to the queue.

Specified by:

updateObject in interface ExportMgrIf

Parameters:

storeId - the storeId

objectType - Determines the type of object

• KKConstants.UPDATE_OBJECT_TYPE_ORDER
• KKConstants.UPDATE_OBJECT_TYPE_CUSTOMER

operationType - Determines the type of operation

• KKConstants.UPDATE_OPERATION_TYPE_CREATE
• KKConstants.UPDATE_OPERATION_TYPE_UPDATE
• KKConstants.UPDATE_OPERATION_TYPE_DELETE

kkObjectId - Id of the KonaKart object being updated

Throws:

java.lang.Exception - an unexpected exception

updateObject

public void updateObject(java.lang.String storeId,
                         int objectType,
                         int operationType,
                         int kkObjectId,
                         java.lang.String objectId1,
                         java.lang.String objectId2,
                         java.lang.String value1,
                         java.lang.String value2)
                  throws java.lang.Exception

Writes an updateObject message to the queue.

Specified by:

updateObject in interface ExportMgrIf

Parameters:

storeId - the storeId

objectType - Determines the type of object

• KKConstants.UPDATE_OBJECT_TYPE_ORDER
• KKConstants.UPDATE_OBJECT_TYPE_CUSTOMER

operationType - Determines the type of operation

• KKConstants.UPDATE_OPERATION_TYPE_CREATE
• KKConstants.UPDATE_OPERATION_TYPE_UPDATE
• KKConstants.UPDATE_OPERATION_TYPE_DELETE

kkObjectId - Id of the KonaKart object being updated

objectId1 - Additional identifier that can be used by the ERP to identify the object.

objectId2 - Additional identifier that can be used by the ERP to identify the object.

value1 - Optional value to simplify the processing of the message.

value2 - Optional value to simplify the processing of the message.

Throws:

java.lang.Exception - an unexpected exception

isUpdateObjectEnabled

public boolean isUpdateObjectEnabled(int objectType,
                                     int operationType)
                              throws java.lang.Exception

Utility that returns true or false depending to determine whether a message should be exported when an object has been modified

Specified by:

isUpdateObjectEnabled in interface ExportMgrIf

Parameters:

objectType - Determines the type of object

• KKConstants.UPDATE_OBJECT_TYPE_ORDER
• KKConstants.UPDATE_OBJECT_TYPE_CUSTOMER
• KKConstants.UPDATE_OBJECT_TYPE_PRODUCT

operationType - Determines the type of operation

• KKConstants.UPDATE_OPERATION_TYPE_CREATE
• KKConstants.UPDATE_OPERATION_TYPE_UPDATE
• KKConstants.UPDATE_OPERATION_TYPE_DELETE

Returns:

Returns true if the message should be sent

Throws:

java.lang.Exception - an unexpected exception

isERPEnabled

public boolean isERPEnabled()
                     throws java.lang.Exception

Specified by:

isERPEnabled in interface ExportMgrIf

Returns:

Returns true if ERP is enabled

Throws:

java.lang.Exception - an unexpected exception

getIntegrations

public java.lang.String[] getIntegrations()
                                   throws com.konakart.app.KKException,
                                          java.lang.Exception

Returns an array of strings containing the integration names

Returns:

Returns an array of strings containing the integration names

Throws:

com.konakart.app.KKException - an unexpected exception in the KK engine

java.lang.Exception - an unexpected exception

isExportCustomer

public boolean isExportCustomer()
                         throws java.lang.Exception

Specified by:

isExportCustomer in interface ExportMgrIf

Returns:

Returns true if we need to export customer information when it changes

Throws:

java.lang.Exception - an unexpected exception

isExportOrder

public boolean isExportOrder()
                      throws java.lang.Exception

Specified by:

isExportOrder in interface ExportMgrIf

Returns:

Returns true if we need to export the order when it is created

Throws:

java.lang.Exception - an unexpected exception