com.konakartadmin.bl

Class AdminImportMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminImportMgr

All Implemented Interfaces:

AdminImportMgrIf

Direct Known Subclasses:

AdminImportMgrEE

public class AdminImportMgr
extends AdminBaseMgr
implements AdminImportMgrIf

Manager for importing

Nested Class Summary

Nested classes/interfaces inherited from class com.konakartadmin.bl.AdminBaseMgr

AdminBaseMgr.StaticData

Field Summary

Fields

Modifier and Type	Field and Description
protected com.konakart.appif.KKEngIf	appEng An instance of the application engine
protected static org.apache.commons.logging.Log	log the log

Fields inherited from class com.konakartadmin.bl.AdminBaseMgr

adminEng, baseMgrMutex, baseStaticDataHM, cDataEnd, cDataStart, debugStackTraceExclusions, kkAdminPropsFilePath, kkConf, kkInstanceId, mgrFactory, STORE_ID, templateBaseDir

Constructor Summary

Constructors

Constructor and Description
AdminImportMgr(KKAdminIf adminEng, com.konakart.appif.KKEngIf appEng) Constructor

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.

Methods inherited from class com.konakartadmin.bl.AdminBaseMgr

addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkAPICallEnabled, checkIntInRange, checkIntIsSet, checkRequired, executeQuery, executeQuery, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCatMgr, getAdminConfigMgr, getAdminContentMgr, getAdminCurrMgr, getAdminCustMgr, getAdminCustPwdHistMgr, getAdminCustTagMgr, getAdminEmailMgr, getAdminEng, getAdminEngineCacheMgr, getAdminEventMgr, getAdminExecuteMgr, getAdminFileMgr, getAdminFilterMgr, getAdminHtmlMgr, getAdminImportMgr, getAdminLanguageMgr, getAdminManuMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminMiscPriceMgr, getAdminModulesMgr, getAdminMultiStoreMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProdMgr, getAdminPromMgr, getAdminReviewMgr, getAdminSearchRuleMgr, getAdminSecMgr, getAdminServletMgr, getAdminShipmentMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminSuggestionMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminVelocityContextMgr, getAdminWishListMgr, getBooleanFromString, getDebugStackTraceExclusions, getEmailThreadGracefulShutdownTimeout, getExportMgr, getExportMgr, getExportXMLData, getIntFromString, getKkAdminPropsFilePath, getKkConfig, getKkInstanceId, getMode, getModeString, getMqMgr, getNewCriteria, getNewCriteria, getNewCriteria, getNewCriteria, getOtherModuleByName, getPostSearchText, getPreSearchText, getProductsToCategoresCriteria, getPropertyValue, getPropertyValue, getPropertyValueAsBool, getPropertyValueAsInt, getPropertyValueAsLong, getRecordCount, getRecordCount, getRewardPointMgr, getSingleIntResult, getStoreId, getTemplate, getTemplateBase, getXml_io, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isCommunity, isConfigSet, isEnterprise, isMultiStoreLanguagesShared, isMultiStoreMode, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreShareProducts, isMultiStoreSingleDBCSMode, isMultiStoreSingleDBMode, isMultiStoreSingleDBNonCSMode, isUnix, isWindows, manageException, manageThrowable, refreshConfigs, removeCData, sendMQMessages, setAdminEng, setDebugStackTraceExclusions, setKkAdminPropsFilePath, setupWildCardRules, setWildCardAfter, setWildCardBefore, shutdownGracefully, shutdownGracefully, timestampStr, 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

appEng

protected com.konakart.appif.KKEngIf appEng

An instance of the application engine

Constructor Detail

AdminImportMgr

public AdminImportMgr(KKAdminIf adminEng,
                      com.konakart.appif.KKEngIf appEng)
               throws java.lang.Exception

Constructor

Parameters:

adminEng - the adminEng

appEng - the appEng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

updateOrder

public 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.

Specified by:

updateOrder in interface AdminImportMgrIf

Parameters:

logSB - the logSB

updateMsg - the updateMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

updateProduct

public 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.

Specified by:

updateProduct in interface AdminImportMgrIf

Parameters:

logSB - the logSB

updateMsg - the updateMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

updateProductPrices

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

Method to update the prices of a product.

Specified by:

updateProductPrices in interface AdminImportMgrIf

Parameters:

logSB - the logSB

updateMsg - the updateMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

registerCustomer

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

Method to register a customer

Specified by:

registerCustomer in interface AdminImportMgrIf

Parameters:

logSB - the logSB

custInMsg - the custInMsg

servletMgr - the servletMgr

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

matchCustomer

public 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

Specified by:

matchCustomer in interface AdminImportMgrIf

Parameters:

logSB - the logSB

matchInMsg - the matchInMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

getRandomPassword

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

Creates a random password

Specified by:

getRandomPassword in interface AdminImportMgrIf

Returns:

Returns a random password

Throws:

java.lang.Exception - an unexpected exception

exportInvoice

public 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.

Specified by:

exportInvoice in interface AdminImportMgrIf

Parameters:

logSB - the logSB

invoiceMsg - the invoiceMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

paymentCapture

public 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.

Specified by:

paymentCapture in interface AdminImportMgrIf

Parameters:

logSB - the logSB

captureMsg - the captureMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

log

public 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

Specified by:

log in interface AdminImportMgrIf

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

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

Get customer for email

Specified by:

getCustomerForEmail in interface AdminImportMgrIf

Parameters:

emailAddr - the emailAddr

Returns:

Returns an admin customer

Throws:

java.lang.Exception - an unexpected exception