com.konakartadmin.bl
Class AdminProductBatchMgr

java.lang.Object
  com.konakartadmin.bl.AdminBaseMgr
      com.konakartadmin.bl.AdminBatchBaseMgr
          com.konakartadmin.bl.AdminProductBatchMgr

public class AdminProductBatchMgr
extends AdminBatchBaseMgr

The ProductBatchMgr

Nested Class Summary

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, kkConf, kkInstanceId, mgrFactory, STORE_ID, templateBaseDir

Constructor Summary

AdminProductBatchMgr(KKAdminIf eng)

Method Summary

void	setProductAverageRatingsBatch(java.lang.String logName, java.lang.String appendLogStr) Whenever a product review is submitted, a rating is given to the product.
void	setSpecialPriceStateBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr) Whenever a product special price is set and active, it is used in sort / filter by price queries regardless of whether it has expired or has yet to start.
private void	setSpecialState(com.konakart.bl.KKCriteria updateC, com.konakart.bl.KKCriteria selectC, int id, boolean enable) Private method to enable or disable the special
void	synchronizeStoresBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr, java.lang.String storeIdFrom, java.lang.String storeIdTo) This batch synchronizes the products in storeIdFrom with the ones in storeIdTo.

Methods inherited from class com.konakartadmin.bl.AdminBatchBaseMgr

executeQuery, getBoolean, getInt, getIntArray, getLogName, validateTemplate

Methods inherited from class com.konakartadmin.bl.AdminBaseMgr

addInsertAttr, addInsertAttr, checkIntIsSet, checkRequired, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCatMgr, getAdminConfigMgr, getAdminCurrMgr, getAdminCustMgr, getAdminCustTagMgr, getAdminEmailMgr, getAdminEng, getAdminHtmlMgr, getAdminLanguageMgr, getAdminManuMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminModulesMgr, getAdminMultiStoreMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProdMgr, getAdminPromMgr, getAdminPublishProdMgr, getAdminReviewMgr, getAdminSearchRuleMgr, getAdminSecMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminVelocityContextMgr, getAdminWishListMgr, getBooleanFromString, getExportXMLData, getIntFromString, getKkConfig, getKkInstanceId, getMode, getModeString, getMqMgr, getNewCriteria, getNewCriteria, getPostSearchText, getPreSearchText, getPropertyValue, getRecordCount, getRewardPointMgr, getSingleIntResult, getStoreId, getTemplate, getTemplateBase, getXml_io, init, isConfigSet, isEnterprise, isMultiStoreLanguagesShared, isMultiStoreMode, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareProducts, isMultiStoreSingleDBCSMode, isMultiStoreSingleDBMode, isMultiStoreSingleDBNonCSMode, manageException, refreshConfigs, removeCData, setAdminEng, setupWildCardRules, setWildCardAfter, setWildCardBefore, shutdownGracefully, shutdownGracefully, timestampStr

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminProductBatchMgr

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

Parameters:

eng -

Throws:

java.lang.Exception

Method Detail

setProductAverageRatingsBatch

public void setProductAverageRatingsBatch(java.lang.String logName,
                                          java.lang.String appendLogStr)
                                   throws java.lang.Exception

Whenever a product review is submitted, a rating is given to the product. This method calculates the average rating for each product and updates the product rating attribute with this value.

The product rating may be used by the application to filter and order products.

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.

Throws:

java.lang.Exception

setSpecialPriceStateBatch

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

Whenever a product special price is set and active, it is used in sort / filter by price queries regardless of whether it has expired or has yet to start. The price shown on the product is always the correct price but when for example sorting by price, it may appear in the wrong position because the special price is used to do the sorting whereas the full price is displayed. The reason for this functionality is that only the special status (for performance reasons) is looked at to decide which price to use when sorting / filtering.

If your policy is to set special prices on a daily basis, then this batch should be run on a daily basis. It looks at the start and expiry dates of the special and disables it if the current date doesn't lie in between these two dates. Otherwise the special is enabled if there is a start date and the special price should have started.

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.

Throws:

java.lang.Exception

setSpecialState

private void setSpecialState(com.konakart.bl.KKCriteria updateC,
                             com.konakart.bl.KKCriteria selectC,
                             int id,
                             boolean enable)
                      throws org.apache.torque.TorqueException

Private method to enable or disable the special

Parameters:

updateC -

selectC -

id -

enable -

Throws:

org.apache.torque.TorqueException

synchronizeStoresBatch

public void synchronizeStoresBatch(java.lang.String logName,
                                   java.lang.String appendLogStr,
                                   java.lang.String recordFetchSizeStr,
                                   java.lang.String storeIdFrom,
                                   java.lang.String storeIdTo)
                            throws java.lang.Exception

This batch synchronizes the products in storeIdFrom with the ones in storeIdTo. It can only be used if the KonaKart engine is running in shared category / shared product mode. It performs the following three copy operations from the source store to the destination store:

• Copy all products that have uuid equal to null. If uuid is equal to null, this means that the products have never been copied.
• Copy all products that have a valid uuid but the uuid doesn't exist in the destination store. This situation can arise if the products have been copied before to another store which isn't the destination store. They may also have been copied and then deleted from the destination store.
• Copy all products that have matching uuids but the dates in the masterProdDate attribute do not match. This situation can arise if a product has previously been copied but then modified.
A product object has two attributes to manage synchronization. One is the uuid which identifies identical products in different stores. i.e. When a product is copied from one store to another, the product id of the copied product is different but a uuid is generated and saved in both products in order to match them. The other attribute is the masterProdDate which is the last modified date of the source product. This date is maintained during the copy so that it can be used to determine when the products are no longer in sync. If after the copy, the source product is edited, the masterProdDate of the source product is automatically modified to the new edit date and so can be used to determine that the copied product in another store is now out of date.

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.

storeIdFrom - The id of the source store

storeIdTo - The id of the destination store

Throws:

java.lang.Exception