com.konakart.blif

Interface ExportMgrIf

All Known Implementing Classes:

ExportMgr, ExportMgrEE

public interface ExportMgrIf

Used to export data

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()
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

Method Detail

exportOrder

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

Write the order to a queue

Parameters:

storeId - the storeId

order - the order

Throws:

java.lang.Exception - an unexpected exception

exportOrder

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

Write the order with the specified Id to a queue

Parameters:

storeId - the storeId

orderId - the orderId

Throws:

java.lang.Exception - an unexpected exception

getIOOrder

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

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

Parameters:

orderIn - the orderIn

Returns:

IOOrderOut

Throws:

java.lang.Exception - an unexpected exception

getCustomerAddressFromOrder

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

Create an IOAddress for the customer

Parameters:

order - the order

countryMap - the countryMap

Returns:

Returns an IOAddress object

Throws:

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

getBillingAddressFromOrder

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

Create an IOAddress for the billing address

Parameters:

order - the order

countryMap - the countryMap

Returns:

Returns an IOAddress object

Throws:

java.lang.Exception - an unexpected exception

getDeliverAddressFromOrder

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

Create an IOAddress for the delivery address

Parameters:

order - the order

countryMap - the countryMap

Returns:

Returns an IOAddress object

Throws:

java.lang.Exception - an unexpected exception

exportCustomer

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

Parameters:

storeId - the storeId

customerId - the customerId

custReg - the custReg

type - INSERT or UPDATE

Throws:

java.lang.Exception - an unexpected exception

getIOCustomer

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

Get an IOCustomerOut object from a kkCustomerId

Parameters:

customerId - the customerId

custReg - the custReg

Returns:

IOCustomerOut

Throws:

java.lang.Exception - an unexpected exception

writeToQueue

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

Parameters:

storeId - the storeId

msg - the msg

Throws:

java.lang.Exception - an unexpected exception

getERPOutputQueuePrefix

java.lang.String getERPOutputQueuePrefix()

Returns:

the erpOutputQueuePrefix

setERPOutputQueuePrefix

void setERPOutputQueuePrefix(java.lang.String erpOutputQueuePrefix)

Parameters:

erpOutputQueuePrefix - the erpOutputQueuePrefix to set

updateObject

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

Writes an updateObject message to the queue.

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

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.

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

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

Parameters:

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

Returns:

Returns true if the message should be sent

Throws:

java.lang.Exception - an unexpected exception

isERPEnabled

boolean isERPEnabled()
              throws java.lang.Exception

Returns:

Returns true if ERP is enabled

Throws:

java.lang.Exception - an unexpected exception

isExportCustomer

boolean isExportCustomer()
                  throws java.lang.Exception

Returns:

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

Throws:

java.lang.Exception - an unexpected exception

isExportOrder

boolean isExportOrder()
               throws java.lang.Exception

Returns:

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

Throws:

java.lang.Exception - an unexpected exception