com.konakartadmin.bl

Class AdminOrderBatchMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminBatchBaseMgr

com.konakartadmin.bl.AdminOrderBatchMgr

public class AdminOrderBatchMgr
extends AdminBatchBaseMgr

The OrderBatchMgr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminOrderBatchMgr.OrderProdList A return object containing a list of OrderProducts and the last OrderId processed
protected class	AdminOrderBatchMgr.OrderProdStatus Object stored in the hash maps

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

AdminBatchBaseMgr.CustTagCounter

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

AdminBaseMgr.StaticData

Field Summary

Fields inherited from class com.konakartadmin.bl.AdminBatchBaseMgr

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
AdminOrderBatchMgr(KKAdminIf eng)

Method Summary

Modifier and Type	Method and Description
java.lang.String	createInvoicesBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr) The method creates invoices for all orders that currently have a null invoice_filename.
java.lang.String	freeReservedPointsBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr, java.lang.String orderSearchStateIdsStr, java.lang.String numMinutesStr, java.lang.String orderEndStateIdStr) FreeReservedPointsBatch is used to free up a customer's reward points that were reserved after an order was confirmed, but have never been deleted or freed since the order was never paid for or cancelled.
protected com.konakart.db.KKCriteria	getfreeReservedPointsOrderCriteria(int size, int numMinutes, int[] orderSearchStateIdArray) Create a criteria object for reading orders that have reserved points
protected com.konakart.db.KKCriteria	getInvoiceOrderCriteria(int size) Create a criteria object for reading the Orders for creating invoices
protected AdminOrder[]	getOrderArrayFromList(java.util.List<AdminOrder> ordersForCustomer) Creates an array of Orders from a list.
protected AdminOrderProduct[]	getOrderProdArrayFromList(java.util.List<AdminOrderProduct> opForOrderList) Creates an array of Order Products from a list.
protected com.konakart.db.KKCriteria	getOrderProductCriteria(int size) Create a criteria object for reading the OrderProducts
protected AdminOrderBatchMgr.OrderProdList	getOrderProducts(com.konakart.db.KKCriteria c, int orderId, java.util.HashMap<java.lang.String,AdminOrderBatchMgr.OrderProdStatus> skuHM, java.util.HashMap<java.lang.Integer,AdminOrderBatchMgr.OrderProdStatus> idHM) The method returns null when all of the order products have been read.
protected java.util.List<AdminOrder>	getOrdersForCriteria(com.konakart.db.KKCriteria c) The method returns null when all of the orders have been read.
protected com.konakart.db.KKCriteria	getRemoveOrdersCriteria(int size, int numDays, int[] orderStates) Create a criteria object for reading orders to remove
protected java.util.List<AdminOrder>	getReservedPointsOrders(com.konakart.db.KKCriteria c) The method returns null when all of the orders have been read.
protected com.konakart.db.KKCriteria	getUnpaidOrderCriteria(int size, int numDays, int[] validOrderStates) Create a criteria object for reading unpaid orders
protected java.util.List<AdminOrder>	getUnpaidOrders(com.konakart.db.KKCriteria c) The method returns null when all of the orders have been read.
java.lang.String	productAvailabilityNotificationBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr, java.lang.String emailTemplateName, java.lang.String numEmailThreadsStr) The method detects orders that haven't been fully delivered because one or more products were out of stock when the order was placed.
java.lang.String	recurringBillingBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr) The method loops through all active subscriptions that have a next billing date set to the current date.
java.lang.String	removeOrdersBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String numDaysStr, java.lang.String orderStatesStr) Removes orders older than a specified number of dates that are in one of the specified order statuses.
protected void	sendProductAvailabilityEmail(java.io.BufferedWriter bw, AdminOrderMgrIf orderMgr, AdminCustomerMgrIf custMgr, AdminOrderProduct[] opArray, com.konakart.db.KKCriteria selectCrit, com.konakart.db.KKCriteria updateCrit, java.lang.String templateName, java.util.concurrent.ExecutorService executor) protected method to send the mail and then reset the order products
protected void	sendUnpaidOrderEmail(java.io.BufferedWriter bw, AdminOrderMgrIf orderMgr, AdminCustomerMgrIf custMgr, AdminOrder[] orderArray, com.konakart.db.KKCriteria selectCrit, com.konakart.db.KKCriteria updateCrit, java.lang.String templateName, java.util.concurrent.ExecutorService executor, int newState) protected method to send the eMail and then change the order states.
protected void	setOrderProductState(AdminOrderProduct[] orderProds, int newState, com.konakart.db.KKCriteria selectCrit, com.konakart.db.KKCriteria updateCrit) Set the state of the list of order products passed in.
protected void	setOrderState(AdminOrder[] orders, int newState, com.konakart.db.KKCriteria selectCrit, com.konakart.db.KKCriteria updateCrit) Set the state of the list of orders passed in.
java.lang.String	unpaidOrderNotificationBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr, java.lang.String emailTemplateName, java.lang.String numEmailThreadsStr, java.lang.String numDaysStr, java.lang.String validOrderStatesStr, java.lang.String newStateStr) An email is sent to all customers when a number of days has passed since they submitted their order and the order is not in one of the valid order states.

Methods inherited from class com.konakartadmin.bl.AdminBatchBaseMgr

ensureCustomerTagIsPresent, getAdEngConf, getAdminJsonEngine, getBatchLogName, getBoolean, getCustomerTagsHash, getInt, getIntArray, getIntArray, getLiteCustomerCriteria, getLiteCustomers, getLogName, getOrders, getSkuForProduct, insertOrUpdateCustomerTag, trimMultiTag, validateTemplate

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

Constructor Detail

AdminOrderBatchMgr

public AdminOrderBatchMgr(KKAdminIf eng)
                   throws java.lang.Exception

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

unpaidOrderNotificationBatch

public java.lang.String unpaidOrderNotificationBatch(java.lang.String logName,
                                                     java.lang.String appendLogStr,
                                                     java.lang.String recordFetchSizeStr,
                                                     java.lang.String emailTemplateName,
                                                     java.lang.String numEmailThreadsStr,
                                                     java.lang.String numDaysStr,
                                                     java.lang.String validOrderStatesStr,
                                                     java.lang.String newStateStr)
                                              throws java.lang.Exception

An email is sent to all customers when a number of days has passed since they submitted their order and the order is not in one of the valid order states. When the eMail has been sent, the order is set to a new state. If a customer has more than one unpaid order, only one mail is sent for all orders.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

recordFetchSizeStr - It the batch involves reading many records in a loop, this determines the maximum number read in any one loop. It defaults to 100.

emailTemplateName - The name of the eMail template if the batch involves sending eMails to customers. The name should not include the extension or the underscore+country code. i.e. It should be myTemplate rather than myTemplate_en.vm. The country code and file extension will be added automatically.

numEmailThreadsStr - If the batch involves sending eMails to customers, this determines how many eMail sender threads are used. It defaults to 5.

numDaysStr - The number of days that needs to have passed before a mail is sent

validOrderStatesStr - An array of integers that determine valid order states. If the order is in a valid state then a mail is not sent. They are in a format "1-4-7" where "-" is the delimiter.

newStateStr - The state that the order should be set to once a mail has been sent.

Returns:

Returns the number of mails sent

Throws:

java.lang.Exception - an unexpected exception

productAvailabilityNotificationBatch

public java.lang.String productAvailabilityNotificationBatch(java.lang.String logName,
                                                             java.lang.String appendLogStr,
                                                             java.lang.String recordFetchSizeStr,
                                                             java.lang.String emailTemplateName,
                                                             java.lang.String numEmailThreadsStr)
                                                      throws java.lang.Exception

The method detects orders that haven't been fully delivered because one or more products were out of stock when the order was placed. It detects the products that were out of stock and that didn't have an Available Date set when they were ordered. If the available date is now available, an eMail is sent to the customer (one eMail even for multiple products) and the state of the OrderProduct object is changed so that the eMail is not sent again next time the method is run.

• Loop through all of the OrderProducts that have a certain state and group them by order.
• For each OrderProduct in an order figure out if the product has a new delivery date.
• For all of the order products in the order with new delivery dates, get an array of products and send the email and log the event. Only send one mail per customer.
• Once the eMail has been sent, change the state of the OrderProduct

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

recordFetchSizeStr - It the batch involves reading many records in a loop, this determines the maximum number read in any one loop. It defaults to 100.

emailTemplateName - The name of the eMail template if the batch involves sending eMails to customers. The name should not include the extension or the underscore+country code. i.e. It should be myTemplate rather than myTemplate_en.vm. The country code and file extension will be added automatically.

numEmailThreadsStr - If the batch involves sending eMails to customers, this determines how many eMail sender threads are used. It defaults to 5.

Returns:

Returns the number of eMails sent

Throws:

java.lang.Exception - an unexpected exception

createInvoicesBatch

public java.lang.String createInvoicesBatch(java.lang.String logName,
                                            java.lang.String appendLogStr,
                                            java.lang.String recordFetchSizeStr)
                                     throws java.lang.Exception

The method creates invoices for all orders that currently have a null invoice_filename.

Once the invoice has been created the order is updated with the name of the filename of the invoice.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

recordFetchSizeStr - It the batch involves reading many records in a loop, this determines the maximum number read in any one loop. It defaults to 100.

Returns:

Returns the number of invoices created

Throws:

java.lang.Exception - an unexpected exception

recurringBillingBatch

public java.lang.String recurringBillingBatch(java.lang.String logName,
                                              java.lang.String appendLogStr,
                                              java.lang.String recordFetchSizeStr)
                                       throws java.lang.Exception

The method loops through all active subscriptions that have a next billing date set to the current date. The payment is made by interfacing to the payment gateway and the subscription object is updated with a new next billing date. The subscription object is also updated if the transaction with the payment gateway fails.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

recordFetchSizeStr - It the batch involves reading many records in a loop, this determines the maximum number read in any one loop. It defaults to 100.

Returns:

Returns the number of payment transactions performed

Throws:

java.lang.Exception - an unexpected exception

getOrderProdArrayFromList

protected AdminOrderProduct[] getOrderProdArrayFromList(java.util.List<AdminOrderProduct> opForOrderList)

Creates an array of Order Products from a list. We need to get a unique instance since it is passed to a thread to send the eMail. It can't just be a pointer to the list.

Parameters:

opForOrderList - the opForOrderList

Returns:

An array of Order Products

getOrderArrayFromList

protected AdminOrder[] getOrderArrayFromList(java.util.List<AdminOrder> ordersForCustomer)

Creates an array of Orders from a list. We need to get a unique instance since it is passed to a thread to send the eMail. It can't just be a pointer to the list.

Parameters:

ordersForCustomer - the ordersForCustomer

Returns:

An array of Orders

sendUnpaidOrderEmail

protected void sendUnpaidOrderEmail(java.io.BufferedWriter bw,
                                    AdminOrderMgrIf orderMgr,
                                    AdminCustomerMgrIf custMgr,
                                    AdminOrder[] orderArray,
                                    com.konakart.db.KKCriteria selectCrit,
                                    com.konakart.db.KKCriteria updateCrit,
                                    java.lang.String templateName,
                                    java.util.concurrent.ExecutorService executor,
                                    int newState)
                             throws java.lang.Exception

protected method to send the eMail and then change the order states.

Parameters:

bw - the bw

orderMgr - the orderMgr

custMgr - the custMgr

orderArray - the orderArray

selectCrit - the selectCrit

updateCrit - the updateCrit

templateName - the templateName

executor - the executor

newState - the newState

Throws:

java.lang.Exception - an unexpected exception

sendProductAvailabilityEmail

protected void sendProductAvailabilityEmail(java.io.BufferedWriter bw,
                                            AdminOrderMgrIf orderMgr,
                                            AdminCustomerMgrIf custMgr,
                                            AdminOrderProduct[] opArray,
                                            com.konakart.db.KKCriteria selectCrit,
                                            com.konakart.db.KKCriteria updateCrit,
                                            java.lang.String templateName,
                                            java.util.concurrent.ExecutorService executor)
                                     throws java.lang.Exception

protected method to send the mail and then reset the order products

Parameters:

bw - the bw

orderMgr - the orderMgr

custMgr - the custMgr

opArray - the opArray

selectCrit - the selectCrit

updateCrit - the updateCrit

templateName - the templateName

executor - the executor

Throws:

java.lang.Exception - an unexpected exception

getUnpaidOrders

protected java.util.List<AdminOrder> getUnpaidOrders(com.konakart.db.KKCriteria c)
                                              throws java.lang.Exception

The method returns null when all of the orders have been read. The caller can stop looping when he receives null.

Parameters:

c - the c

Returns:

Returns a list of AdminOrders

Throws:

java.lang.Exception - an unexpected exception

getOrdersForCriteria

protected java.util.List<AdminOrder> getOrdersForCriteria(com.konakart.db.KKCriteria c)
                                                   throws java.lang.Exception

The method returns null when all of the orders have been read. The caller can stop looping when he receives null.

Parameters:

c - the c

Returns:

Returns a list of AdminOrders

Throws:

java.lang.Exception - an unexpected exception

getOrderProducts

protected AdminOrderBatchMgr.OrderProdList getOrderProducts(com.konakart.db.KKCriteria c,
                                                            int orderId,
                                                            java.util.HashMap<java.lang.String,AdminOrderBatchMgr.OrderProdStatus> skuHM,
                                                            java.util.HashMap<java.lang.Integer,AdminOrderBatchMgr.OrderProdStatus> idHM)
                                                     throws java.lang.Exception

The method returns null when all of the order products have been read. If we don't need to send any emails for any of the read order products then it returns an empty list. The can stop looping when he receives null. We loop through the list of order products and create a return list that just contains the ones that have a delivery date and weren't in stock.

Parameters:

c - the c

orderId - We only fetch order products for orders with an id >= to this

skuHM - the skuHM

idHM - the idHM

Returns:

Returns a list of AdminOrderProducts and last order processed

Throws:

java.lang.Exception - an unexpected exception

setOrderProductState

protected void setOrderProductState(AdminOrderProduct[] orderProds,
                                    int newState,
                                    com.konakart.db.KKCriteria selectCrit,
                                    com.konakart.db.KKCriteria updateCrit)
                             throws org.apache.torque.TorqueException

Set the state of the list of order products passed in.

Parameters:

orderProds - the orderProds

newState - the newState

selectCrit - the selectCrit

updateCrit - the updateCrit

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

setOrderState

protected void setOrderState(AdminOrder[] orders,
                             int newState,
                             com.konakart.db.KKCriteria selectCrit,
                             com.konakart.db.KKCriteria updateCrit)
                      throws org.apache.torque.TorqueException

Set the state of the list of orders passed in.

Parameters:

orders - the orders

newState - the newState

selectCrit - the selectCrit

updateCrit - the updateCrit

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

getUnpaidOrderCriteria

protected com.konakart.db.KKCriteria getUnpaidOrderCriteria(int size,
                                                            int numDays,
                                                            int[] validOrderStates)

Create a criteria object for reading unpaid orders

Parameters:

size - the size

numDays - the numDays

validOrderStates - the validOrderStates

Returns:

KKCriteria object

getOrderProductCriteria

protected com.konakart.db.KKCriteria getOrderProductCriteria(int size)

Create a criteria object for reading the OrderProducts

Parameters:

size - the size

Returns:

KKCriteria object

getInvoiceOrderCriteria

protected com.konakart.db.KKCriteria getInvoiceOrderCriteria(int size)

Create a criteria object for reading the Orders for creating invoices

Parameters:

size - the size

Returns:

KKCriteria object

freeReservedPointsBatch

public java.lang.String freeReservedPointsBatch(java.lang.String logName,
                                                java.lang.String appendLogStr,
                                                java.lang.String recordFetchSizeStr,
                                                java.lang.String orderSearchStateIdsStr,
                                                java.lang.String numMinutesStr,
                                                java.lang.String orderEndStateIdStr)
                                         throws java.lang.Exception

FreeReservedPointsBatch is used to free up a customer's reward points that were reserved after an order was confirmed, but have never been deleted or freed since the order was never paid for or cancelled.

If orderEndStateStr is set then the order is moved into this state. Once the reserved points have been returned to the customer, the pointsReservationId attribute of the order is reset and the pointsRedeemed attribute is set to zero.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

recordFetchSizeStr - This determines the maximum number of orders read in any one loop. It defaults to 100.

orderSearchStateIdsStr - Comma separated string containing numeric order state ids. We search only for orders in these states that have pointReservation ids

numMinutesStr - We only search for orders that are at least this number of minutes old.

orderEndStateIdStr - If given a numeric value, we change the order to this state once the points have been freed.

Returns:

Returns the number of orders processed

Throws:

java.lang.Exception - an unexpected exception

getfreeReservedPointsOrderCriteria

protected com.konakart.db.KKCriteria getfreeReservedPointsOrderCriteria(int size,
                                                                        int numMinutes,
                                                                        int[] orderSearchStateIdArray)

Create a criteria object for reading orders that have reserved points

Parameters:

size - the size

numMinutes - the numMinutes

orderSearchStateIdArray - the orderSearchStateIdArray

Returns:

KKCriteria object

getReservedPointsOrders

protected java.util.List<AdminOrder> getReservedPointsOrders(com.konakart.db.KKCriteria c)
                                                      throws java.lang.Exception

The method returns null when all of the orders have been read. The caller can stop looping when he receives null.

Parameters:

c - the c

Returns:

Returns a list of AdminOrders

Throws:

java.lang.Exception - an unexpected exception

removeOrdersBatch

public java.lang.String removeOrdersBatch(java.lang.String logName,
                                          java.lang.String appendLogStr,
                                          java.lang.String numDaysStr,
                                          java.lang.String orderStatesStr)
                                   throws java.lang.Exception

Removes orders older than a specified number of dates that are in one of the specified order statuses.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

numDaysStr - The number of days that needs to have passed before orders are removed

orderStatesStr - An array of integers that determine the order states to remove.

Returns:

Returns the number of orders removed

Throws:

java.lang.Exception - an unexpected exception

getRemoveOrdersCriteria

protected com.konakart.db.KKCriteria getRemoveOrdersCriteria(int size,
                                                             int numDays,
                                                             int[] orderStates)

Create a criteria object for reading orders to remove

Parameters:

size - the size

numDays - the numDays

orderStates - the orderStates

Returns:

KKCriteria object