com.konakart.bl

Class ProductMgrEE

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.ProductMgr

com.konakart.bl.ProductMgrEE

All Implemented Interfaces:

ProductMgrIf

Direct Known Subclasses:

ProductMgrWond

public class ProductMgrEE
extends ProductMgr
implements ProductMgrIf

Product Mgr - EE version.

Nested Class Summary

Nested classes/interfaces inherited from class com.konakart.bl.ProductMgr

ProductMgr.OptionSortOrderComparator, ProductMgr.ProdAttr, ProductMgr.ProdAttrSortOrderComparator, ProductMgr.ProdSortOrderComparator, ProductMgr.StaticData, ProductMgr.TagSortOrderComparator

Field Summary

Fields

Modifier and Type	Field and Description
protected static com.fasterxml.jackson.databind.ObjectMapper	mapper JSON Data Mapping Object

Fields inherited from class com.konakart.bl.ProductMgr

ACCESSORY, ALL_RELATIONSHIPS, BOOKABLE_PRODUCT_TYPE, BUNDLE_PRODUCT_TYPE, BUNDLED_PRODUCT_RELATIONSHIP, CROSS_SELL, CUSTOM_RELATIONSHIP_1, CUSTOM_RELATIONSHIP_2, CUSTOM_RELATIONSHIP_3, CUSTOM_RELATIONSHIP_4, CUSTOM_RELATIONSHIP_5, customAttrAnOracleCLOB, DEPENDENT_ITEM, DIGITAL_DOWNLOAD, DONT_INCLUDE, FREE_SHIPPING, FREE_SHIPPING_BUNDLE_PRODUCT_TYPE, GIFT_CERTIFICATE_PRODUCT_TYPE, log, PHYSICAL_PRODUCT, prodMgrMutex, productViewCountMaxRetries, prodViewMutex, reserveStockMutex, staticDataHM, tagMutex, UP_SELL, updateStockMutex, VIRTUAL_PRODUCT_TYPE

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
ProductMgrEE(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
boolean	cacheThisProduct(Product product) Should this particular product be cached? The default implementation returns false for null products and Bundle products (according to the setting of the configuration value) and simply returns true for every other product.
protected Basket	clearBasketReservationData(Basket basketItem) Utility method to clear the attributes of a Basket concerned with reservations
protected AddToBasketOptionsIf	createAddToBasketOptions(StockReservationOptionsIf options) Creates an AddToBasketOptions object from a StockReservationOptions
protected FetchProductOptionsIf	createFetchProductOptions(StockReservationOptionsIf options) Creates a FetchProductOptions object from a StockReservationOptions
protected void	deleteStockReservation(int reservationId) Delete a Stock Reservation object
Catalog	getCatalogPerKey(java.lang.String catalogKey) Returns a catalog object for the catalog key.
static com.fasterxml.jackson.databind.ObjectMapper	getMapper()
ProductImages	getProductImages(ProductImagesOptionsIf options) Get the image file names associated with the product whose id is specified.
protected Product	getProductWithOptions(int productId, java.lang.String catalogId, int priceId, int langId, FetchProductOptionsIf options)
protected StockReservation[]	getStockReservations(int reservationId) Used to get StockReservation objects using the reservation id.
void	init() Initialise the configuration of the product manager
protected int	removeStockReservations(int customerId, int[] idArray, java.util.ArrayList<java.lang.Integer> idList, StockReservationOptionsIf options) A local method which actually implements the deletion of the stock reservations.
int	removeStockReservationsForBasketItems(int customerId, BasketIf[] basketItems, StockReservationOptionsIf options) This API call is used to remove stock reservations.
int	removeStockReservationsForBasketItems(java.lang.String sessionId, BasketIf[] basketItems, StockReservationOptionsIf options) This API call is used to remove stock reservations.
int	removeStockReservationsForIds(int customerId, int[] idArray, StockReservationOptionsIf options) This API call is used to remove stock reservations.
int	removeStockReservationsForIds(java.lang.String sessionId, int[] idArray, StockReservationOptionsIf options) This API call is used to remove stock reservations.
int	removeStockReservationsForOrderProducts(int customerId, OrderProductIf[] orderProducts, StockReservationOptionsIf options) This API call is used to remove stock reservations.
int	removeStockReservationsForOrderProducts(java.lang.String sessionId, OrderProductIf[] orderProducts, StockReservationOptionsIf options) This API call is used to remove stock reservations.
Basket[]	reserveStock(java.lang.String sessionId, BasketIf[] basketItems, StockReservationOptionsIf stockReservationOptions) The purpose of this API call is to reserve stock in order to give a customer enough time to checkout without risking that the products being ordered become unavailable while checking out.
protected BasketIf	reserveStockSingleItem(int customerId, Basket basketItem, ProductQuantityIf[] bundlePQs, int reservationTime, StockReservationOptionsIf options, ProductMgr.StaticData sd) This method attempts to reserve stock for the Basket item passed in as a parameter.
protected void	setExtPriceProductAttributeCriteria(KKCriteria c, int productId, FetchProductOptionsIf options) Add criteria for getting the prices from another table based on the catalog id .
protected void	setExtPriceProductCriteria(KKCriteria c, FetchProductOptionsIf options) Add criteria for getting the prices from another table based on the catalog id .
protected void	setExtPricesVariantPriceCriteria(KKCriteria c, int productId, FetchProductOptionsIf options) Add criteria for getting the variant prices from another table based on the catalog id .
void	setExtPriceTierPriceCriteria(KKCriteria c, int prodId, FetchProductOptionsIf options) Add criteria for getting the tier prices from another table based on the catalog id .
protected void	setExtQuantityProductCriteria(KKCriteria c, FetchProductOptionsIf options) Add criteria for getting the product quantity from another table based on the catalog id .
protected void	setExtQuantityProductQuantityCriteria(KKCriteria c, int productId, FetchProductOptionsIf options) Add criteria for getting the product quantity from another table based on the catalog id .
protected void	setStockReservationCriteriaOnProduct(KKCriteria c, FetchProductOptionsIf options) Add criteria for getting stock reservation information.
protected void	setStockReservationCriteriaOnProductQuantity(KKCriteria c, int productId, FetchProductOptionsIf options) Add criteria for getting stock reservation information .
protected void	updateBasketWithReservationInfo(Basket bItem, int reservationId, int reserveQty, java.util.Date reservationStartTime, java.util.Date reservationEndTime) Utility method to avoid repeated code
int	updateProductLockItems(java.lang.String productId, java.lang.String shopIds) Lockes a Product for all shops in the ;-separated shopIds
int	updateProductNotLockedItems(java.lang.String[] productIds) Resets all Locked Products which are not in the List productIds

Methods inherited from class com.konakart.bl.ProductMgr

addProductDescriptions, addProductsToStoresConstraint, addTax, addTax, beforeSendCriteria, beforeSendQuery, createEncodedProductIdFromProductQuantityEncodedKey, createOptionsFromProductQuantityEncodedKey, createProductQuantityEncodedKeyFromEncodedProductId, createProductQuantityEncodedKeyFromOptions, decProductQuantitiesWithOptions, deleteDigitalDownload, doesExtQuantityExist, doesProductExist, doTierPricesExist, editDigitalDownload, editDigitalDownload, editExtQuantity, fetchDescriptionsSeparately, getAddressesPerProduct, getAllProductRelationships, getAllProducts, getAllProductsWithOptions, getAllSpecials, getAlsoPurchased, getAlsoPurchasedWithOptions, getBestSellers, getBestSellersWithOptions, getBundleProductQuantityWithOptions, getBundlesThatProductBelongsTo, getBundlesThatProductsBelongTo, getCount, getCustomAttrs, getCustomAttrsFromXML, getDigitalDownload, getDigitalDownloadById, getDigitalDownloadById, getDigitalDownloads, getDigitalDownloadsWithOptions, getExpiryDate, getLastAddedDateFromTagToProduct, getLightProduct, getMaxDownloadDays, getMaxNumDownloads, getOption, getOrderHistory, getOrderHistoryWithOptions, getPaymentScheduleId, getPriceId, getProduct, getProduct, getProductCountForTag, getProductOptions, getProductPerSku, getProductPerSkuWithOptions, getProductQuantitiesPerProductWithOptions, getProductQuantity, getProductQuantityPerProductWithOptions, getProductQuantityWithOptions, getProductQuantityWithOptions, getProductReorderLevel, getProductsAllCases, getProductsFromIds, getProductsFromIdsWithOptions, getProductsFromIdsWithOptions, getProductsPerCategory, getProductsPerCategoryPerManufacturer, getProductsPerCategoryPerManufacturerWithOptions, getProductsPerCategoryWithOptions, getProductsPerManufacturer, getProductsPerManufacturerWithOptions, getProductType, getProductViewCountMaxRetries, getProductWithOptions, getProductWithOptions, getProductWithOptions, getRelatedProducts, getRelatedProducts, getRelatedProductsWithOptions, getSku, getSku, getSpecialsPerCategory, getTag, getTagGroup, getTagGroupsPerCategory, getTagGroupsPerCategoryWithOptions, getTagsPerCategory, getTagsPerProduct, getTagsPerTagGroup, getTagToProductCount, getTaxClassId, getTierPrices, getVariantPrices, getVariantPricesPerProductWithOptions, getXMLFromCustomAttrs, insertDigitalDownload, insertDigitalDownload, insertExtQuantity, insertGiftCertificateDigitalDownload, isCustomAttrAnOracleCLOB, isEnhancedVariantHandlingModeEnabled, manageDataDescriptor, manageDataDescriptor, refreshConfigs, searchForProducts, searchForProductsPrivate, searchForProductsWithOptions, selectActiveProduct, sendQuery, setBundledProducts, setCriteriaWithStandardAttributes, setCriteriaWithStandardAttributes, setDigitalDownloadCriteria, setOptionPrice, setProductPrice, setProductsSharedCriteria, setProductViewCountMaxRetries, setTagCriteriaWithStandardAttributes, setTagGroupCriteriaWithStandardAttributes, synchronizeTagProductCount, updateBundleProductQuantityWithOptions, updateDigitalDownloadCount, updateDigitalDownloadCountById, updateProductQuantity, updateProductQuantity, updateProductQuantityWithOptions, updateProductReviewInfo, updateProductsOrdered, updateProductViewedCount, useSpecialPrice, validateDigitalDownload

Methods inherited from class com.konakart.bl.BaseMgr

acquireLock, addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkRequired, escapeHTML, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getAdminEngMgr, getBasketMgr, getBillingMgr, getBookableProductMgr, getCacheMgr, getCatMgr, getConfigMgr, getCookieMgr, getCurrMgr, getCustMgr, getCustomerIdFromSession, getCustomerStatsMgr, getCustomerTagMgr, getEmailMgr, getEng, getEventMgr, getExportMgr, getHTMLEscaper, getKonaKartConfig, getKonaKartConfig, getKonaKartConfig, getLangMgr, getManuMgr, getMiscItemMgr, getMiscPriceMgr, getMode, getModeString, getMqMgr, getMultiStoreMgr, getNewCriteria, getNewCriteria, getOrderIntegrationMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getProductsToCategoresCriteria, getPromMgr, getPunchOutMgr, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getStoreTime, getSuggestionMgr, getTaxMgr, getTemplate, getTemplateRoot, getVelocityContextMgr, getWishListMgr, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isClassPresent, isCommunity, isDeadlockException, isEnterprise, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreSharedDb, isMultiStoreShareProducts, isMultiVendor, isUnix, manageThrowable, releaseLock, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.konakart.blif.ProductMgrIf

createEncodedProductIdFromProductQuantityEncodedKey, createOptionsFromProductQuantityEncodedKey, createProductQuantityEncodedKeyFromEncodedProductId, createProductQuantityEncodedKeyFromOptions, doesProductExist, editDigitalDownload, editDigitalDownload, getAddressesPerProduct, getAllProductRelationships, getAllProducts, getAllProductsWithOptions, getAllSpecials, getAlsoPurchased, getAlsoPurchasedWithOptions, getBestSellers, getBestSellersWithOptions, getBundlesThatProductBelongsTo, getBundlesThatProductsBelongTo, getCustomAttrsFromXML, getDigitalDownloadById, getDigitalDownloadById, getDigitalDownloads, getDigitalDownloadsWithOptions, getOption, getOrderHistory, getOrderHistoryWithOptions, getPaymentScheduleId, getPriceId, getProduct, getProduct, getProductPerSku, getProductPerSkuWithOptions, getProductQuantity, getProductQuantityWithOptions, getProductReorderLevel, getProductsFromIds, getProductsFromIdsWithOptions, getProductsFromIdsWithOptions, getProductsPerCategory, getProductsPerCategoryPerManufacturer, getProductsPerCategoryPerManufacturerWithOptions, getProductsPerCategoryWithOptions, getProductsPerManufacturer, getProductsPerManufacturerWithOptions, getProductViewCountMaxRetries, getProductWithOptions, getProductWithOptions, getRelatedProducts, getRelatedProductsWithOptions, getSku, getSpecialsPerCategory, getTag, getTagGroup, getTagGroupsPerCategory, getTagGroupsPerCategoryWithOptions, getTagsPerCategory, getTaxClassId, getXMLFromCustomAttrs, insertDigitalDownload, insertDigitalDownload, insertGiftCertificateDigitalDownload, refreshConfigs, searchForProducts, searchForProductsWithOptions, setProductViewCountMaxRetries, updateDigitalDownloadCount, updateDigitalDownloadCountById, updateProductQuantity, updateProductQuantity, updateProductQuantityWithOptions, updateProductReviewInfo, updateProductsOrdered, updateProductViewedCount

Field Detail

mapper

protected static com.fasterxml.jackson.databind.ObjectMapper mapper

JSON Data Mapping Object

Constructor Detail

ProductMgrEE

public ProductMgrEE(KKEngIf eng)
             throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

setExtPriceTierPriceCriteria

public void setExtPriceTierPriceCriteria(KKCriteria c,
                                         int prodId,
                                         FetchProductOptionsIf options)
                                  throws com.konakart.app.KKException

Add criteria for getting the tier prices from another table based on the catalog id .

Overrides:

setExtPriceTierPriceCriteria in class ProductMgr

Parameters:

c - criteria object

prodId - Product id

options - fetch product options

Throws:

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

setExtPriceProductCriteria

protected void setExtPriceProductCriteria(KKCriteria c,
                                          FetchProductOptionsIf options)
                                   throws com.konakart.app.KKException

Add criteria for getting the prices from another table based on the catalog id .

Overrides:

setExtPriceProductCriteria in class ProductMgr

Parameters:

c - criteria object

options - fetch product options

Throws:

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

setExtQuantityProductCriteria

protected void setExtQuantityProductCriteria(KKCriteria c,
                                             FetchProductOptionsIf options)
                                      throws com.konakart.app.KKException

Add criteria for getting the product quantity from another table based on the catalog id .

Overrides:

setExtQuantityProductCriteria in class ProductMgr

Parameters:

c - criteria object

options - fetch product options

Throws:

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

setExtQuantityProductQuantityCriteria

protected void setExtQuantityProductQuantityCriteria(KKCriteria c,
                                                     int productId,
                                                     FetchProductOptionsIf options)
                                              throws com.konakart.app.KKException

Add criteria for getting the product quantity from another table based on the catalog id .

Overrides:

setExtQuantityProductQuantityCriteria in class ProductMgr

Parameters:

c - the c

productId - the productId

options - the options

Throws:

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

setExtPriceProductAttributeCriteria

protected void setExtPriceProductAttributeCriteria(KKCriteria c,
                                                   int productId,
                                                   FetchProductOptionsIf options)
                                            throws com.konakart.app.KKException

Add criteria for getting the prices from another table based on the catalog id .

Overrides:

setExtPriceProductAttributeCriteria in class ProductMgr

Parameters:

c - the c

productId - the productId

options - the options

Throws:

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

getProductWithOptions

protected Product getProductWithOptions(int productId,
                                        java.lang.String catalogId,
                                        int priceId,
                                        int langId,
                                        FetchProductOptionsIf options)
                                 throws java.lang.Exception

Overrides:

getProductWithOptions in class ProductMgr

Parameters:

productId - the productId

catalogId - the catalogId

priceId - the priceId

langId - the langId

options - the options

Returns:

A product object with full details

Throws:

java.lang.Exception - an unexpected exception

cacheThisProduct

public boolean cacheThisProduct(Product product)
                         throws com.konakart.app.KKException

Should this particular product be cached? The default implementation returns false for null products and Bundle products (according to the setting of the configuration value) and simply returns true for every other product. The idea of this interface is that it is provided to be overridden so that you can choose not to cache certain products.

Only relevant in the Enterprise version.

Specified by:

cacheThisProduct in interface ProductMgrIf

Overrides:

cacheThisProduct in class ProductMgr

Parameters:

product - the product to be considered for caching

Returns:

true if the product should be cached otherwise false

Throws:

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

getProductImages

public ProductImages getProductImages(ProductImagesOptionsIf options)
                               throws com.konakart.app.KKException

Description copied from interface: ProductMgrIf

Get the image file names associated with the product whose id is specified. Only return image file names that match the specified regular expression if specified and not null. If the file name filter is null, all file names associated with the product are returned. If no product exists with the specified productId an exception is thrown. If no files are found for the product an empty array of image names is returned in the ProductImages return object.

Specified by:

getProductImages in interface ProductMgrIf

Overrides:

getProductImages in class ProductMgr

Parameters:

options - a ProductImagesOptions object for specifying the criteria used to define which product images should be returned. Within this search object you can specify productId and a file name filter (which is a regular expression).

Returns:

a ProductImages object that contains an array of image file names associated with the specified product and matching the (possibly) specified name filter regular expression.

Throws:

com.konakart.app.KKException - if options is null or if no product with the specified productId can be found.

init

public void init()
          throws java.lang.Exception

Initialise the configuration of the product manager

Throws:

java.lang.Exception - an unexpected exception

getMapper

public static com.fasterxml.jackson.databind.ObjectMapper getMapper()

Returns:

the mapper

reserveStock

public Basket[] reserveStock(java.lang.String sessionId,
                             BasketIf[] basketItems,
                             StockReservationOptionsIf stockReservationOptions)
                      throws java.lang.Exception

The purpose of this API call is to reserve stock in order to give a customer enough time to checkout without risking that the products being ordered become unavailable while checking out.

The options allow you to:

• Define the number of seconds the reservation is active for. The default is set to -1 which means that the value defined in the global configuration variable is used. A batch job should be scheduled to run at regular intervals to remove expired reservations.
• Define whether you want to allow a partial reservation for a product if the number of items available is less than the number required. The default behavior is to not allow partial reservations.
• Define a maximum number of reservations per customer for any one product. This is a defensive measure to prevent a customer from abandoning multiple checkouts or a (single checkout with a high quantity number) and so reserving products and preventing other customers from buying them.

If a reservation already exists, it is deleted and a new one is inserted. The Basket items returned, as well as having the reservation information populated, also have populated the quantityInStock attribute. The reservation information is also persisted in the database.

If any of the Basket items contain products or product variations no longer in the catalog then they are not included in the return array.

Specified by:

reserveStock in interface ProductMgrIf

Overrides:

reserveStock in class ProductMgr

Parameters:

sessionId - the sessionId

basketItems - the basketItems

stockReservationOptions - the stockReservationOptions

Returns:

Returns an array of basket items with the attributes reservationId, qtyResrvdForResId and reservationExpiryDate populated. The reservationId is set to -1 if the reservation could not be made because the stock was not available or for any other reason.

Throws:

java.lang.Exception - an unexpected exception

reserveStockSingleItem

protected BasketIf reserveStockSingleItem(int customerId,
                                          Basket basketItem,
                                          ProductQuantityIf[] bundlePQs,
                                          int reservationTime,
                                          StockReservationOptionsIf options,
                                          ProductMgr.StaticData sd)
                                   throws java.lang.Exception

This method attempts to reserve stock for the Basket item passed in as a parameter.

Parameters:

customerId - the customerId

basketItem - the basketItem

bundlePQs - If we have an array of bundle product quantities then we have to create a reservation for each one of these

reservationTime - the reservationTime

options - the options

sd - the sd

Returns:

Returns a Basket object containing reservation information if the reservation was successful.

Throws:

java.lang.Exception - an unexpected exception

updateBasketWithReservationInfo

protected void updateBasketWithReservationInfo(Basket bItem,
                                               int reservationId,
                                               int reserveQty,
                                               java.util.Date reservationStartTime,
                                               java.util.Date reservationEndTime)
                                        throws org.apache.torque.TorqueException,
                                               com.konakart.app.KKException

Utility method to avoid repeated code

Parameters:

bItem - the bItem

reservationId - the reservationId

reserveQty - the reserveQty

reservationStartTime - the reservationStartTime

reservationEndTime - the reservationEndTime

Throws:

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

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

getStockReservations

protected StockReservation[] getStockReservations(int reservationId)
                                           throws java.lang.Exception

Used to get StockReservation objects using the reservation id. In the case of a bundle there may be multiple products reserved for a single reservation id.

Parameters:

reservationId - the reservationId

Returns:

Returns a StockReservation object

Throws:

java.lang.Exception - an unexpected exception

deleteStockReservation

protected void deleteStockReservation(int reservationId)
                               throws java.lang.Exception

Delete a Stock Reservation object

Parameters:

reservationId - the reservationId

Throws:

java.lang.Exception - an unexpected exception

clearBasketReservationData

protected Basket clearBasketReservationData(Basket basketItem)

Utility method to clear the attributes of a Basket concerned with reservations

Parameters:

basketItem - the basketItem

Returns:

Returns the cleared basket item

removeStockReservationsForBasketItems

public int removeStockReservationsForBasketItems(java.lang.String sessionId,
                                                 BasketIf[] basketItems,
                                                 StockReservationOptionsIf options)
                                          throws java.lang.Exception

This API call is used to remove stock reservations. The reservation ids are retrieved from the array of basket items passed in as a parameter. The code checks that the reservations belong to the customer referenced by the session id.

Specified by:

removeStockReservationsForBasketItems in interface ProductMgrIf

Overrides:

removeStockReservationsForBasketItems in class ProductMgr

Parameters:

sessionId - the sessionId

basketItems - the basketItems

options - the options

Returns:

Returns the number of reservations removed

Throws:

java.lang.Exception - an unexpected exception

removeStockReservationsForBasketItems

public int removeStockReservationsForBasketItems(int customerId,
                                                 BasketIf[] basketItems,
                                                 StockReservationOptionsIf options)
                                          throws java.lang.Exception

This API call is used to remove stock reservations. The reservation ids are retrieved from the array of basket items passed in as a parameter. The code checks that the reservations belong to the customer referenced by the session id.

Specified by:

removeStockReservationsForBasketItems in interface ProductMgrIf

Overrides:

removeStockReservationsForBasketItems in class ProductMgr

Parameters:

customerId - the customerId

basketItems - the basketItems

options - the options

Returns:

Returns the number of reservations removed

Throws:

java.lang.Exception - an unexpected exception

removeStockReservationsForOrderProducts

public int removeStockReservationsForOrderProducts(java.lang.String sessionId,
                                                   OrderProductIf[] orderProducts,
                                                   StockReservationOptionsIf options)
                                            throws java.lang.Exception

This API call is used to remove stock reservations. The reservation ids are retrieved from the array of order products passed in as a parameter. The code checks that the reservations belong to the customer referenced by the session id.

Specified by:

removeStockReservationsForOrderProducts in interface ProductMgrIf

Overrides:

removeStockReservationsForOrderProducts in class ProductMgr

Parameters:

sessionId - the sessionId

orderProducts - the orderProducts

options - the options

Returns:

Returns the number of reservations removed

Throws:

java.lang.Exception - an unexpected exception

removeStockReservationsForOrderProducts

public int removeStockReservationsForOrderProducts(int customerId,
                                                   OrderProductIf[] orderProducts,
                                                   StockReservationOptionsIf options)
                                            throws java.lang.Exception

This API call is used to remove stock reservations. The reservation ids are retrieved from the array of order products passed in as a parameter. The code checks that the reservations belong to the customer referenced by the session id.

Specified by:

removeStockReservationsForOrderProducts in interface ProductMgrIf

Overrides:

removeStockReservationsForOrderProducts in class ProductMgr

Parameters:

customerId - the customerId

orderProducts - the orderProducts

options - the options

Returns:

Returns the number of reservations removed

Throws:

java.lang.Exception - an unexpected exception

removeStockReservationsForIds

public int removeStockReservationsForIds(java.lang.String sessionId,
                                         int[] idArray,
                                         StockReservationOptionsIf options)
                                  throws java.lang.Exception

This API call is used to remove stock reservations. The reservation ids are retrieved from the array of ids passed in as a parameter. The code checks that the reservations belong to the customer referenced by the session id.

Specified by:

removeStockReservationsForIds in interface ProductMgrIf

Overrides:

removeStockReservationsForIds in class ProductMgr

Parameters:

sessionId - the sessionId

idArray - the idArray

options - the options

Returns:

Returns the number of reservations removed

Throws:

java.lang.Exception - an unexpected exception

removeStockReservationsForIds

public int removeStockReservationsForIds(int customerId,
                                         int[] idArray,
                                         StockReservationOptionsIf options)
                                  throws java.lang.Exception

This API call is used to remove stock reservations. The reservation ids are retrieved from the array of ids passed in as a parameter. The code checks that the reservations belong to the customer referenced by the session id.

Specified by:

removeStockReservationsForIds in interface ProductMgrIf

Overrides:

removeStockReservationsForIds in class ProductMgr

Parameters:

customerId - the customerId

idArray - the idArray

options - the options

Returns:

Returns the number of reservations removed

Throws:

java.lang.Exception - an unexpected exception

removeStockReservations

protected int removeStockReservations(int customerId,
                                      int[] idArray,
                                      java.util.ArrayList<java.lang.Integer> idList,
                                      StockReservationOptionsIf options)
                               throws java.lang.Exception

A local method which actually implements the deletion of the stock reservations. The reservation ids are either retrieved from idArray or idList. One of the two parameters should always be set to null.The code checks that the reservations belong to the customer referenced by the session id.

Parameters:

customerId - the customerId

idArray - the idArray

idList - the idList

options - the options

Returns:

Returns the number of reservations removed

Throws:

java.lang.Exception - an unexpected exception

createAddToBasketOptions

protected AddToBasketOptionsIf createAddToBasketOptions(StockReservationOptionsIf options)

Creates an AddToBasketOptions object from a StockReservationOptions

Parameters:

options - the options

Returns:

Return an AddToBasketOptions object

createFetchProductOptions

protected FetchProductOptionsIf createFetchProductOptions(StockReservationOptionsIf options)

Creates a FetchProductOptions object from a StockReservationOptions

Parameters:

options - the options

Returns:

Return a FetchProductOptions object

setStockReservationCriteriaOnProduct

protected void setStockReservationCriteriaOnProduct(KKCriteria c,
                                                    FetchProductOptionsIf options)
                                             throws com.konakart.app.KKException

Add criteria for getting stock reservation information.

Overrides:

setStockReservationCriteriaOnProduct in class ProductMgr

Parameters:

c - criteria object

options - fetch product options

Throws:

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

setStockReservationCriteriaOnProductQuantity

protected void setStockReservationCriteriaOnProductQuantity(KKCriteria c,
                                                            int productId,
                                                            FetchProductOptionsIf options)
                                                     throws com.konakart.app.KKException

Add criteria for getting stock reservation information . In this case we return stock information on an array of product quantity objects.

Overrides:

setStockReservationCriteriaOnProductQuantity in class ProductMgr

Parameters:

c - the c

productId - the productId

options - the options

Throws:

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

getCatalogPerKey

public Catalog getCatalogPerKey(java.lang.String catalogKey)
                         throws java.lang.Exception

Returns a catalog object for the catalog key.

Specified by:

getCatalogPerKey in interface ProductMgrIf

Overrides:

getCatalogPerKey in class ProductMgr

Parameters:

catalogKey - the catalogKey

Returns:

Returns a catalog object

Throws:

java.lang.Exception - an unexpected exception

setExtPricesVariantPriceCriteria

protected void setExtPricesVariantPriceCriteria(KKCriteria c,
                                                int productId,
                                                FetchProductOptionsIf options)
                                         throws com.konakart.app.KKException

Add criteria for getting the variant prices from another table based on the catalog id .

Overrides:

setExtPricesVariantPriceCriteria in class ProductMgr

Parameters:

c - the c

productId - the productId

options - the options

Throws:

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

updateProductLockItems

public int updateProductLockItems(java.lang.String productId,
                                  java.lang.String shopIds)
                           throws java.lang.Exception

Description copied from interface: ProductMgrIf

Lockes a Product for all shops in the ;-separated shopIds

Specified by:

updateProductLockItems in interface ProductMgrIf

Overrides:

updateProductLockItems in class ProductMgr

Parameters:

productId - Product-ID for which the Lock should be set

shopIds - ;-Separated-List with shop-Ids where the Product should be locked

Returns:

Returns status

Throws:

java.lang.Exception - an unexpected KKException exception

updateProductNotLockedItems

public int updateProductNotLockedItems(java.lang.String[] productIds)
                                throws java.lang.Exception

Description copied from interface: ProductMgrIf

Resets all Locked Products which are not in the List productIds

Specified by:

updateProductNotLockedItems in interface ProductMgrIf

Overrides:

updateProductNotLockedItems in class ProductMgr

Parameters:

productIds - List with acutaly Locked Products

Returns:

Returns status

Throws:

java.lang.Exception - an unexpected KKException exception