com.konakartadmin.blif

Interface AdminImportMgrIf

All Known Implementing Classes:

AdminImportMgr, AdminImportMgrEE

public interface AdminImportMgrIf

Manager for importing

Method Summary

Modifier and Type	Method and Description
boolean	exportInvoice(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOInvoiceInMsg invoiceMsg) Allows the ERP system to associate an invoice file (typically in PDF format) with a KonaKart order with the option of having the invoice sent out to a customer in an email by KonaKart.
AdminCustomer	getCustomerForEmail(java.lang.String emailAddr) Get customer for email
java.lang.String	getRandomPassword() Creates a random password
void	log(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOMsgBase msgBase, java.lang.String msg) Common code for writing to the log file
boolean	matchCustomer(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOMatchCustomerInMsg matchInMsg) Method to match a customer that has been registered on the ERP
boolean	paymentCapture(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOPaymentCaptureInMsg captureMsg) In many cases when the customer confirms an order using his credit card, the funds are reserved and not captured until the products are actually shipped.
boolean	registerCustomer(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOCustomerInMsg custInMsg, AdminServletMgrIf servletMgr) Method to register a customer
boolean	updateOrder(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOOrderUpdateInMsg updateMsg) Update the order based on information contained in an IOOrderUpdate object.
boolean	updateProduct(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOProductUpdateInMsg updateMsg) Method to update a product quantity and / or prices.
boolean	updateProductPrices(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOProductPriceUpdateInMsg updateMsg) Method to update the prices of a product.

Method Detail

updateOrder

boolean updateOrder(java.lang.StringBuffer logSB,
                    com.konakart.erp.jaxb.IOOrderUpdateInMsg updateMsg)
             throws java.lang.Exception

Update the order based on information contained in an IOOrderUpdate object. The method will update the state of the order and if required will insert a Shipment object with details of the products shipped for the order change.

Parameters:

logSB - the logSB

updateMsg - the updateMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

updateProduct

boolean updateProduct(java.lang.StringBuffer logSB,
                      com.konakart.erp.jaxb.IOProductUpdateInMsg updateMsg)
               throws java.lang.Exception

Method to update a product quantity and / or prices. It may also disable the product.

Parameters:

logSB - the logSB

updateMsg - the updateMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

updateProductPrices

boolean updateProductPrices(java.lang.StringBuffer logSB,
                            com.konakart.erp.jaxb.IOProductPriceUpdateInMsg updateMsg)
                     throws java.lang.Exception

Method to update the prices of a product.

Parameters:

logSB - the logSB

updateMsg - the updateMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

registerCustomer

boolean registerCustomer(java.lang.StringBuffer logSB,
                         com.konakart.erp.jaxb.IOCustomerInMsg custInMsg,
                         AdminServletMgrIf servletMgr)
                  throws java.lang.Exception

Method to register a customer

Parameters:

logSB - the logSB

custInMsg - the custInMsg

servletMgr - the servletMgr

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

matchCustomer

boolean matchCustomer(java.lang.StringBuffer logSB,
                      com.konakart.erp.jaxb.IOMatchCustomerInMsg matchInMsg)
               throws java.lang.Exception

Method to match a customer that has been registered on the ERP

Parameters:

logSB - the logSB

matchInMsg - the matchInMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

getRandomPassword

java.lang.String getRandomPassword()
                            throws java.lang.Exception

Creates a random password

Returns:

Returns a random password

Throws:

java.lang.Exception - an unexpected exception

exportInvoice

boolean exportInvoice(java.lang.StringBuffer logSB,
                      com.konakart.erp.jaxb.IOInvoiceInMsg invoiceMsg)
               throws java.lang.Exception

Allows the ERP system to associate an invoice file (typically in PDF format) with a KonaKart order with the option of having the invoice sent out to a customer in an email by KonaKart. The invoice may be downloaded by a customer from the storefront after logging in.

Parameters:

logSB - the logSB

invoiceMsg - the invoiceMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

paymentCapture

boolean paymentCapture(java.lang.StringBuffer logSB,
                       com.konakart.erp.jaxb.IOPaymentCaptureInMsg captureMsg)
                throws java.lang.Exception

In many cases when the customer confirms an order using his credit card, the funds are reserved and not captured until the products are actually shipped. This message, sent by the ERP, instructs KonaKart to initiate a credit card capture transaction with the payment gateway for the amount specified.

Parameters:

logSB - the logSB

captureMsg - the captureMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

log

void log(java.lang.StringBuffer logSB,
         com.konakart.erp.jaxb.IOMsgBase msgBase,
         java.lang.String msg)
  throws java.io.IOException,
         com.konakart.app.KKException

Common code for writing to the log file

Parameters:

logSB - the logSB

msgBase - the msgBase

msg - the msg

Throws:

java.io.IOException - an unexpected IOException exception

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

getCustomerForEmail

AdminCustomer getCustomerForEmail(java.lang.String emailAddr)
                           throws java.lang.Exception

Get customer for email

Parameters:

emailAddr - the emailAddr

Returns:

Returns an admin customer

Throws:

java.lang.Exception - an unexpected exception