ProductMgr (KonaKart Server Engine API Documentation)

java.lang.Object
- com.konakart.bl.BaseMgr
- - com.konakart.bl.ProductMgr

All Implemented Interfaces:

ProductMgrIf

Direct Known Subclasses:

ProductMgrEE
```
public class ProductMgr
extends BaseMgr
implements ProductMgrIf
```
Product Mgr.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected class`	`ProductMgr.OptionSortOrderComparator` Used to sort the Option objects based on option id
`protected class`	`ProductMgr.ProdAttr` protected class used to create the encoded key
`protected class`	`ProductMgr.ProdAttrSortOrderComparator` Used to sort the ProdAttr objects based on option id
`protected class`	`ProductMgr.ProdSortOrderComparator` Used to sort products for getBundlesThatProductBelongsTo()
`protected class`	`ProductMgr.StaticData` Used to store the static data of this manager
`protected class`	`ProductMgr.TagSortOrderComparator` Used to sort a list of tags

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`ACCESSORY` Accessories
`static int`	`ALL_RELATIONSHIPS` Returns all related products
`static int`	`BOOKABLE_PRODUCT_TYPE` Bookable Product Type
`static int`	`BUNDLE_PRODUCT_TYPE` Bundle Product Type
`static int`	`BUNDLED_PRODUCT_RELATIONSHIP` Bundled product
`static int`	`CROSS_SELL` Cross Sell related products
`static int`	`CUSTOM_RELATIONSHIP_1` Custom relationship
`static int`	`CUSTOM_RELATIONSHIP_2` Custom relationship
`static int`	`CUSTOM_RELATIONSHIP_3` Custom relationship
`static int`	`CUSTOM_RELATIONSHIP_4` Custom relationship
`static int`	`CUSTOM_RELATIONSHIP_5` Custom relationship
`static java.lang.Boolean`	`customAttrAnOracleCLOB` is Oracle CLOB used for custom_attrs column on the products table?
`static int`	`DEPENDENT_ITEM` Dependent items, such as warranties
`static int`	`DIGITAL_DOWNLOAD` Digital download product
`static int`	`DONT_INCLUDE` Used to not include values in the query
`static int`	`FREE_SHIPPING` Physical product with free shipping
`static int`	`FREE_SHIPPING_BUNDLE_PRODUCT_TYPE` Free Shipping Bundle Product Type
`static int`	`GIFT_CERTIFICATE_PRODUCT_TYPE` Gift Certificate Product Type
`protected static org.apache.commons.logging.Log`	`log` the log
`static int`	`PHYSICAL_PRODUCT` Physical product
`protected static java.lang.String`	`prodMgrMutex` Mutex for the product manager
`protected static int`	`productViewCountMaxRetries` Number of times to retry the product view count update SQL
`protected static java.lang.String`	`prodViewMutex` Mutex for updating product viewed count
`protected static java.lang.String`	`reserveStockMutex` Mutex for reserving stock
`protected static java.util.Map<java.lang.String,ProductMgr.StaticData>`	`staticDataHM` Hash Map that contains the static data
`protected static java.lang.String`	`tagMutex` Mutex for updating tags
`static int`	`UP_SELL` Up Sell related products
`protected static java.lang.String`	`updateStockMutex` Mutex for updating stock
`static int`	`VIRTUAL_PRODUCT_TYPE` Virtual Product Type

Fields inherited from class com.konakart.bl.BaseMgr
templateBaseDir

Constructor Summary

Constructors
Constructor and Description

ProductMgr(KKEngIf eng)
Constructor

Constructors
Constructor and Description
`ProductMgr(KKEngIf eng)` Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`addProductDescriptions(Product[] prods, int langId, boolean multiStoreSearch)` Adds the description to an array of products
`protected void`	`addProductsToStoresConstraint(KKCriteria c, org.apache.torque.map.ColumnMap cm)` If we're sharing products we need to add a constraint to the criteria object so that we only get records if there is a record for this product and storeId in the products_to_stores table.
`protected void`	`addTax(Customer cust, Product product)` We set the price of the product including tax for the customer identified by cust.
`protected void`	`addTax(Customer cust, Products products, Product[] productArray)` We iterate through the array of products and for each product, we set the price including tax.
`protected KKCriteria`	`beforeSendCriteria(java.lang.String sessionId, java.lang.String apiCall, KKCriteria criteria, DataDescriptorIf dataDesc, ProductSearchIf prodSearch, int languageId, FetchProductOptionsIf options)` Method that can be used to customize the KKCriteria object before it is used to create the query string that is sent to the database.
`protected java.lang.String`	`beforeSendQuery(java.lang.String sessionId, java.lang.String apiCall, java.lang.String queryString, DataDescriptorIf dataDesc, ProductSearchIf prodSearch, int languageId, FetchProductOptionsIf options)` Method that can be used to customize the query string before being sent to the database.
`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.
`java.lang.String`	`createEncodedProductIdFromProductQuantityEncodedKey(int productId, java.lang.String productQuantityEncodedKey)` Takes in a productQuantityEncodedKey and a productId and returns an encoded product Id.
`OptionIf[]`	`createOptionsFromProductQuantityEncodedKey(java.lang.String encodedKey)` Receives an encoded key from the products_quantity table in the format 3{4}4{6} and creates an array of Option objects.
`ProductQuantity`	`createProductQuantityEncodedKeyFromEncodedProductId(java.lang.String encodedProductId)` Takes in an encodedProductId and returns an encoded key for the products_quantity table The format of the encoded product id is 1{2}3{4}5 where the product id = 1, the first optionId / valueId pair have ids of 2,3 and the 2nd optionId / valueId pair have ids of 4,5.
`java.lang.String`	`createProductQuantityEncodedKeyFromOptions(OptionIf[] opts)` Takes in an an array of options and returns an encoded key for the products_quantity table The format of the encoded key for the products_quantity table is 3{4}4{6} which means product_options of id==3 and product_options_values of id==4 followed by product_options of id==4 and product_options_values of id==6.
`protected int`	`decProductQuantitiesWithOptions(int productId, int quantitySold, boolean setProductStatus, boolean onlyOrdered, FetchProductOptionsIf options)` An internal method to avoid code duplication.
`protected void`	`deleteDigitalDownload(DigitalDownload dd)` Deletes the digital download passed in as a parameter
`protected boolean`	`doesExtQuantityExist(int productId, java.lang.String encodedOptionValues, java.lang.String catalogId, KKCriteria selectC)` Returns true if the external quantity record exists
`boolean`	`doesProductExist(int productId)` Figure out whether a product exists
`protected boolean`	`doTierPricesExist()` Returns true if at least one TierPrice record exists in the database.
`void`	`editDigitalDownload(DigitalDownloadIf digitalDownload)` Edits the digital download object
`void`	`editDigitalDownload(java.lang.String sessionId, DigitalDownloadIf digitalDownload)` Edits the digital download object
`protected void`	`editExtQuantity(int productId, java.lang.String encodedOptionValues, int quantity, java.lang.String catalogId, KKCriteria selectC, KKCriteria updateC)` Used to edit a quantity in the external quantity table.
`protected boolean`	`fetchDescriptionsSeparately()` This can be specialized to modify the way the product descriptions are queried or the configuration variable can be set to the value you require to be returned here.
`Address[]`	`getAddressesPerProduct(int productId)` Returns all of the addresses for the given product.
`ProductRelationship[]`	`getAllProductRelationships()` Returns all product relationships in a single call.
`Products`	`getAllProducts(java.lang.String sessionId, DataDescriptorIf dataDesc, int languageId)` Returns all products
`Products`	`getAllProductsWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int languageId, FetchProductOptionsIf options)` Returns all products.
`Products`	`getAllSpecials(java.lang.String sessionId, DataDescriptorIf dataDesc, int languageId)` Returns all special priced products
`Product[]`	`getAlsoPurchased(java.lang.String sessionId, DataDescriptorIf dataDesc, int productId, int languageId)` Find products that were in the same order as orders containing the product referenced by productId.
`Product[]`	`getAlsoPurchasedWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int productId, int languageId, FetchProductOptionsIf options)` Find products that were in the same order as orders containing the product referenced by productId.
`Product[]`	`getBestSellers(DataDescriptorIf dataDesc, int categoryId, int languageId)` Calls getBestSellersWithOptions
`Product[]`	`getBestSellersWithOptions(DataDescriptorIf dataDesc, int categoryId, int languageId, FetchProductOptionsIf options)` Returns an array of bestseller products for the category and its children.
`protected ProductQuantityIf`	`getBundleProductQuantityWithOptions(Product product, FetchProductOptionsIf options)` Get the quantity and date available of a bundle product.
`Products`	`getBundlesThatProductBelongsTo(java.lang.String sessionId, DataDescriptorIf dataDesc, int productId, int languageId, FetchProductOptionsIf options)` The method fetches an array of bundles (products of type bundle), all of which contain the product with id `productId` as one of the bundled products.
`Products`	`getBundlesThatProductsBelongTo(java.lang.String sessionId, DataDescriptorIf dataDescriptor, int[] productIds, boolean exactMatch, int languageId, FetchProductOptionsIf options)` The method fetches an array of bundles (products of type bundle), all of which contain the product ids `productIds` as one or more of the bundled products.
`Catalog`	`getCatalogPerKey(java.lang.String catalogKey)` Returns a catalog object for the catalog key.
`protected int`	`getCount(java.lang.String sessionId, java.lang.String apiCall, DataDescriptorIf dataDesc, ProductSearchIf prodSearch, KKCriteria criteria, boolean fixQuery, boolean tagCount, boolean multiStoreSearch, int languageId, FetchProductOptionsIf options)` This method is mainly used for paging.
`protected java.lang.String`	`getCustomAttrs(int productId)` Get the custom_attrs for the product with the specified Id
`ProdCustAttr[]`	`getCustomAttrsFromXML(java.lang.String xml)` Create an array of custom attributes from the XML
`protected DigitalDownload`	`getDigitalDownload(int customerId, int productId)` Returns a Digital Download object for the customerId and productId passed in as parameters.
`DigitalDownload`	`getDigitalDownloadById(int digitalDownloadId)` Returns a Digital Download object for the digital download id.
`DigitalDownload`	`getDigitalDownloadById(java.lang.String sessionId, int digitalDownloadId)` Returns a Digital Download object for the digital download id.
`DigitalDownload[]`	`getDigitalDownloads(java.lang.String sessionId)` Returns an array of Digital Download objects for the customer identified by the sessionId parameter.
`DigitalDownload[]`	`getDigitalDownloadsWithOptions(java.lang.String sessionId, int languageId, FetchDigitalDownloadOptionsIf ddOptions, FetchProductOptionsIf prodOptions)` Returns an array of Digital Download objects for the customer identified by the sessionId parameter.
`protected java.util.Date`	`getExpiryDate(int maxDownloadDays)` Common code to get the expiry date
`protected java.util.Date`	`getLastAddedDateFromTagToProduct()` Get the last date added for a tag to product record
`protected Product`	`getLightProduct(int productId)` Fetches a very "light" product with few attributes
`protected int`	`getMaxDownloadDays(Product prod)` Common code to get the maximum number of download days
`protected int`	`getMaxNumDownloads(Product prod)` Common code to get the maximum number of downloads
`Option`	`getOption(int productId, int optionId, int optionValueId, int priceId, int languageId, FetchProductOptionsIf options)` Finds a single Option object for the parameters passed in by reading from the product_attributes, product_options and product_options_values tables.
`Product[]`	`getOrderHistory(DataDescriptorIf dataDesc, java.lang.String sessionId, int languageId)` Get a list of the products ordered by the customer referenced by the sessionId.
`Product[]`	`getOrderHistoryWithOptions(DataDescriptorIf dataDesc, java.lang.String sessionId, int languageId, FetchProductOptionsIf options)` Get a list of the products ordered by the customer referenced by the sessionId.
`int`	`getPaymentScheduleId(int productId)` A utility method to return just the Payment Schedule Id from a product to determine whether it requires recurring billing.
`int`	`getPriceId(Customer customer)` Get the priceId from the customer
`Product`	`getProduct(int customerId, int productId, int languageId)` Fetches a fully populated product object for a customer referenced by customerId.
`Product`	`getProduct(java.lang.String sessionId, int productId, int languageId)` Fetches a fully populated product object.
`protected void`	`getProductCountForTag(TagIf tag)` Get the number of products for a tag and add the number to the tag object
`ProductImages`	`getProductImages(ProductImagesOptionsIf options)` Get the image file names associated with the product whose id is specified.
`protected java.util.HashMap<java.lang.String,Option>`	`getProductOptions(KKCriteria criteria, Product prod, int priceId, int langId, FetchProductOptionsIf options)` Common code for setting the product options of a product.
`Product`	`getProductPerSku(java.lang.String sessionId, java.lang.String sku, int languageId)` Get a product from its SKU.
`Product`	`getProductPerSkuWithOptions(java.lang.String sessionId, java.lang.String sku, int languageId, FetchProductOptionsIf options)` Get a product from its SKU.
`protected ProductQuantityIf[]`	`getProductQuantitiesPerProductWithOptions(int productId, FetchProductOptionsIf options, java.util.HashMap<java.lang.String,Option> optionMap)` Return all of the product quantities associated with a product
`ProductQuantityIf`	`getProductQuantity(java.lang.String encodedProductId)` The stock level of the product is returned.
`protected ProductQuantityIf`	`getProductQuantityPerProductWithOptions(int productId, java.lang.String encodedOptionValues, FetchProductOptionsIf options)` Return all of the product quantities associated with a product
`protected ProductQuantityIf`	`getProductQuantityWithOptions(int productId, FetchProductOptionsIf options)` The stock level and available date of the product is returned assuming it has no attributes.
`ProductQuantityIf`	`getProductQuantityWithOptions(java.lang.String encodedProductId, FetchProductOptionsIf options)` The stock level of the product is returned.
`int`	`getProductReorderLevel(int productId)` Return the re-order level of the product.
`protected Products`	`getProductsAllCases(java.lang.String apiCall, java.lang.String sessionId, DataDescriptorIf dataDesc, int categoryId, int languageId, int manufacturerId, FetchProductOptionsIf options)` This protected method gets called by various flavours of public methods to get an array of products with differing criteria.
`Product[]`	`getProductsFromIds(java.lang.String sessionId, java.util.ArrayList<java.lang.Integer> prodIdList, int languageId)` Returns an array of products referenced by the ids in prodIdList.
`Product[]`	`getProductsFromIdsWithOptions(java.lang.String sessionId, java.util.ArrayList<java.lang.Integer> prodIdList, int languageId, FetchProductOptionsIf options)` Returns an array of products referenced by the ids in prodIdList.
`Product[]`	`getProductsFromIdsWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int[] prodIdArray, int languageId, FetchProductOptionsIf options)` Returns an array of products referenced by the ids in prodIdArray.
`Products`	`getProductsPerCategory(java.lang.String sessionId, DataDescriptorIf dataDesc, int categoryId, boolean searchInSubCats, int languageId)` Returns the products for a category
`Products`	`getProductsPerCategoryPerManufacturer(java.lang.String sessionId, DataDescriptorIf dataDesc, int categoryId, int manufacturerId, int languageId)` Returns the products for a category and a manufacturer
`Products`	`getProductsPerCategoryPerManufacturerWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int categoryId, int manufacturerId, int languageId, FetchProductOptionsIf options)` Returns the products for a category and a manufacturer.
`Products`	`getProductsPerCategoryWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int categoryId, boolean searchInSubCats, int languageId, FetchProductOptionsIf options)` Returns the products for a category.An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
`Products`	`getProductsPerManufacturer(java.lang.String sessionId, DataDescriptorIf dataDesc, int manufacturerId, int languageId)` Returns the products for a manufacturer
`Products`	`getProductsPerManufacturerWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int manufacturerId, int languageId, FetchProductOptionsIf options)` Returns the products for a manufacturer.An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
`protected int`	`getProductType(int productId)` Return the product type
`int`	`getProductViewCountMaxRetries()`
`protected Product`	`getProductWithOptions(int productId, Customer cust, int languageId, FetchProductOptionsIf options)`
`Product`	`getProductWithOptions(int customerId, int productId, int languageId, FetchProductOptionsIf options)` Fetches a fully populated product object for a customer referenced by customerId.
`protected Product`	`getProductWithOptions(int productId, java.lang.String catalogId, int priceId, int langId, FetchProductOptionsIf options)`
`Product`	`getProductWithOptions(java.lang.String sessionId, int productId, int languageId, FetchProductOptionsIf options)` Fetches a fully populated product object.
`Products`	`getRelatedProducts(java.lang.String sessionId, DataDescriptorIf dataDesc, int productId, int relationType, int languageId)` Find products related to the product defined by the productId parameter.
`protected Products`	`getRelatedProducts(java.lang.String sessionId, DataDescriptorIf dataDescriptor, int productId, int relationType, int languageId, java.util.HashMap<java.lang.String,Product> bundleProductMap, int loopInput, int quantity, FetchProductOptionsIf options)` A protected version of getRelatedProducts with a hash map passed in for recursion
`Products`	`getRelatedProductsWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, int productId, int relationType, int languageId, FetchProductOptionsIf options)` Find products related to the product defined by the productId parameter.
`protected java.lang.String`	`getSku(int productId)` Gets the SKU for a product directly from the product table.
`java.lang.String`	`getSku(OrderProductIf orderProd)` This method is deprecated since release 4.0.0.0 because an SKU attribute was added to the OrderProduct.
`Products`	`getSpecialsPerCategory(java.lang.String sessionId, DataDescriptorIf dataDescriptor, int categoryId, boolean searchInSubCats, int languageId)` Returns all special priced products for a category
`TagIf`	`getTag(int tagId, boolean getProdCount, int languageId)` Returns a Tag object for the id passed in as a parameter.
`TagGroupIf`	`getTagGroup(int tagGroupId, boolean getProdCount, int languageId)` Returns a TagGroup object for the id passed in as a parameter.
`TagGroup[]`	`getTagGroupsPerCategory(int categoryId, boolean getProdCount, int languageId)` Return an array of TagGroup objects for a category.
`TagGroup[]`	`getTagGroupsPerCategoryWithOptions(int categoryId, int languageId, FetchTagGroupOptionsIf options)` Return an array of TagGroup objects for a category.
`TagIf[]`	`getTagsPerCategory(int categoryId, boolean getProdCount, int languageId)` Return an array of Tag objects for a category.
`protected Tag[]`	`getTagsPerProduct(int productId, int langId)` Get the tags for a product.
`protected TagIf[]`	`getTagsPerTagGroup(int tagGroupId, boolean getProdCount, int languageId)` Returns an array of Tags for a TagGroup
`protected int`	`getTagToProductCount()` Get the number of records in the tag to product table
`int`	`getTaxClassId(int productId)` Returns the tax class id for a product
`protected TierPrice[]`	`getTierPrices(Product prod, int productPriceId, FetchProductOptionsIf options)` Return the An array of TierPrice objects (or null) for the product referenced by productId
`protected VariantPriceIf[]`	`getVariantPrices(Product prod, int productPriceId, FetchProductOptionsIf options)` Return the An array of VariantPrice objects (or null) for the product referenced by productId
`protected VariantPriceIf[]`	`getVariantPricesPerProductWithOptions(int productId, FetchProductOptionsIf options, java.util.HashMap<java.lang.String,Option> optionMap)` Return all of the variant prices associated with a product
`java.lang.String`	`getXMLFromCustomAttrs(ProdCustAttrIf[] attrDescArray)` Create an XML structure for the custom attributes
`int`	`insertDigitalDownload(int customerId, int productId)` Create and insert a digital download record for the product identified by the productId and the customer identified by the customerId.
`int`	`insertDigitalDownload(java.lang.String sessionId, int productId)` Create and insert a digital download record for the product identified by the productId and the customer identified by the sessionId.
`protected void`	`insertExtQuantity(int productId, java.lang.String encodedOptionValues, int quantity, java.lang.String catalogId, KKCriteria insertC)` Used to insert a quantity in the external quantity table.
`int`	`insertGiftCertificateDigitalDownload(int customerId, int productId, java.lang.String filePath)` Create and insert a digital download record for the product identified by the productId and the customer identified by the customerId.
`static boolean`	`isCustomAttrAnOracleCLOB()` Is the custom_attrs column is an Oracle CLOB? We only check once and save the result in a static variable.
`protected boolean`	`isEnhancedVariantHandlingModeEnabled()` Check in the static data if enhanced variant handling mode is enabled.
`protected void`	`manageDataDescriptor(DataDescriptorIf dataDesc, org.apache.torque.util.Criteria c, java.lang.String price)` Provides common code to deal with the management of the DataDescriptor.
`protected void`	`manageDataDescriptor(DataDescriptorIf dataDesc, org.apache.torque.util.Criteria c, java.lang.String price, boolean addConstraints)` Provides common code to deal with the management of the DataDescriptor.
`void`	`refreshConfigs()` Refresh the configuration of the product manager
`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.
`Products`	`searchForProducts(java.lang.String sessionId, DataDescriptorIf dataDesc, ProductSearchIf prodSearch, int languageId)` Returns products matching the search criteria.
`protected Products`	`searchForProductsPrivate(KKCriteria criteria, java.lang.String apiCall, java.lang.String sessionId, DataDescriptorIf dataDescriptor, ProductSearchIf productSearch, java.util.ArrayList<java.lang.Integer> productIdList, int languageId, FetchProductOptionsIf options)` Returns products matching the search criteria in the format defined by the data descriptor.
`Products`	`searchForProductsWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, ProductSearchIf prodSearch, int languageId, FetchProductOptionsIf options)` Returns products matching the search criteria.
`protected int`	`selectActiveProduct(java.lang.String sessionId, java.util.ArrayList<java.lang.Integer> productIdList, int languageId, FetchProductOptionsIf options)` For the case when multiple products exist for the same SKU, we give priority to products not disabled and not invisible
`protected java.util.List<com.workingdogs.village.Record>`	`sendQuery(java.lang.String sessionId, java.lang.String apiCall, KKCriteria crit, DataDescriptorIf dataDesc, ProductSearchIf prodSearch, int languageId, boolean fixQuery, FetchProductOptionsIf options)` Common code to send a query string
`protected void`	`setBundledProducts(ProductIf currentParent, java.util.ArrayList<ProductIf> childProdList)` Private method to avoid duplicating code
`protected void`	`setCriteriaWithStandardAttributes(KKCriteria c, int languageId, boolean manuOuterJoin, boolean multiStoreSearch, FetchProductOptionsIf options, DataDescriptorIf dd, boolean singleProduct, ProductSearchIf prodSearch)` Initializes the criteria with the standard attributes for the product.
`protected void`	`setCriteriaWithStandardAttributes(KKCriteria c, int languageId, FetchProductOptionsIf options, boolean singleProduct)` Initializes the criteria with the standard attributes for the product.
`protected void`	`setDigitalDownloadCriteria(KKCriteria c)` Sets the criteria with the standard attributes so as not to have to repeat this code many times.
`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`	`setOptionPrice(Option opt, Product prod, int productId, int productPriceId)` Edit the product option to use the correct price based on the product price Id
`protected void`	`setProductPrice(Product prod, int productPriceId)` Edit the product to use the correct price based on the product price Id
`protected void`	`setProductsSharedCriteria(KKCriteria c, boolean getPriceId, FetchProductOptionsIf options)` Add criteria to get shared products from the database
`void`	`setProductViewCountMaxRetries(int productViewCountMaxRetries)` The maximum number of optimistic concurrency retries when setting the product viewed count
`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`	`setTagCriteriaWithStandardAttributes(KKCriteria c, int languageId)` Set the Criteria attribute with standard attributes for a Tag object
`protected void`	`setTagGroupCriteriaWithStandardAttributes(KKCriteria c, int languageId)` Set the Criteria attribute with standard attributes for a TagGroup object
`protected void`	`synchronizeTagProductCount()` We save the product count for each tag, in a hash table.
`protected void`	`updateBundleProductQuantityWithOptions(int productId, int quantitySold, boolean setStatus, FetchProductOptionsIf options)` Updates the quantities for a bundle product.
`int`	`updateDigitalDownloadCount(java.lang.String sessionId, int productId)` Updates the count of the Digital Download that defines how many times it has been downloaded.
`int`	`updateDigitalDownloadCountById(java.lang.String sessionId, int digitalDownloadId)` Updates the count of the Digital Download (identified by id) that defines how many times it has been downloaded.
`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`
`int`	`updateProductQuantity(int productId, OptionIf[] opts, int quantitySold, boolean setStatus)` The product quantity is updated by subtracting quantitySold from the current quantity.
`int`	`updateProductQuantity(int productId, OptionIf[] opts, java.lang.String encodedOptions, int quantitySold, boolean setStatus)` The product quantity is updated by subtracting quantitySold from the current quantity.
`int`	`updateProductQuantityWithOptions(int productId, OptionIf[] opts, java.lang.String encodedOptions, int quantitySold, boolean setStatus, FetchProductOptionsIf options)` The product quantity is updated by subtracting quantitySold from the current quantity.
`void`	`updateProductReviewInfo(int productId)` The product referenced by the `productId` parameter is updated with information regarding the average rating and the number of reviews present for the product.
`void`	`updateProductsOrdered(OrderIf order)` Update the products ordered count for the products sold in an order
`void`	`updateProductViewedCount(int productId, int languageId)` Increments the viewed count for the product.
`protected boolean`	`useSpecialPrice()` This can be specialized to return false if special prices aren't used.
`protected Product`	`validateDigitalDownload(int productId)` Validate the digital download productId

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

- Field Detail
  - log
```
protected static org.apache.commons.logging.Log log
```
    the log
  - DONT_INCLUDE
```
public static final int DONT_INCLUDE
```
    Used to not include values in the query
    
    See Also:
    
    Constant Field Values
  - ALL_RELATIONSHIPS
```
public static final int ALL_RELATIONSHIPS
```
    Returns all related products
    
    See Also:
    
    Constant Field Values
  - UP_SELL
```
public static final int UP_SELL
```
    Up Sell related products
    
    See Also:
    
    Constant Field Values
  - CROSS_SELL
```
public static final int CROSS_SELL
```
    Cross Sell related products
    
    See Also:
    
    Constant Field Values
  - ACCESSORY
```
public static final int ACCESSORY
```
    Accessories
    
    See Also:
    
    Constant Field Values
  - DEPENDENT_ITEM
```
public static final int DEPENDENT_ITEM
```
    Dependent items, such as warranties
    
    See Also:
    
    Constant Field Values
  - BUNDLED_PRODUCT_RELATIONSHIP
```
public static final int BUNDLED_PRODUCT_RELATIONSHIP
```
    Bundled product
    
    See Also:
    
    Constant Field Values
  - CUSTOM_RELATIONSHIP_1
```
public static final int CUSTOM_RELATIONSHIP_1
```
    Custom relationship
    
    See Also:
    
    Constant Field Values
  - CUSTOM_RELATIONSHIP_2
```
public static final int CUSTOM_RELATIONSHIP_2
```
    Custom relationship
    
    See Also:
    
    Constant Field Values
  - CUSTOM_RELATIONSHIP_3
```
public static final int CUSTOM_RELATIONSHIP_3
```
    Custom relationship
    
    See Also:
    
    Constant Field Values
  - CUSTOM_RELATIONSHIP_4
```
public static final int CUSTOM_RELATIONSHIP_4
```
    Custom relationship
    
    See Also:
    
    Constant Field Values
  - CUSTOM_RELATIONSHIP_5
```
public static final int CUSTOM_RELATIONSHIP_5
```
    Custom relationship
    
    See Also:
    
    Constant Field Values
  - PHYSICAL_PRODUCT
```
public static final int PHYSICAL_PRODUCT
```
    Physical product
    
    See Also:
    
    Constant Field Values
  - DIGITAL_DOWNLOAD
```
public static final int DIGITAL_DOWNLOAD
```
    Digital download product
    
    See Also:
    
    Constant Field Values
  - FREE_SHIPPING
```
public static final int FREE_SHIPPING
```
    Physical product with free shipping
    
    See Also:
    
    Constant Field Values
  - BUNDLE_PRODUCT_TYPE
```
public static final int BUNDLE_PRODUCT_TYPE
```
    Bundle Product Type
    
    See Also:
    
    Constant Field Values
  - FREE_SHIPPING_BUNDLE_PRODUCT_TYPE
```
public static final int FREE_SHIPPING_BUNDLE_PRODUCT_TYPE
```
    Free Shipping Bundle Product Type
    
    See Also:
    
    Constant Field Values
  - GIFT_CERTIFICATE_PRODUCT_TYPE
```
public static final int GIFT_CERTIFICATE_PRODUCT_TYPE
```
    Gift Certificate Product Type
    
    See Also:
    
    Constant Field Values
  - BOOKABLE_PRODUCT_TYPE
```
public static final int BOOKABLE_PRODUCT_TYPE
```
    Bookable Product Type
    
    See Also:
    
    Constant Field Values
  - VIRTUAL_PRODUCT_TYPE
```
public static final int VIRTUAL_PRODUCT_TYPE
```
    Virtual Product Type
    
    See Also:
    
    Constant Field Values
  - staticDataHM
```
protected static java.util.Map<java.lang.String,ProductMgr.StaticData> staticDataHM
```
    Hash Map that contains the static data
  - customAttrAnOracleCLOB
```
public static java.lang.Boolean customAttrAnOracleCLOB
```
    is Oracle CLOB used for custom_attrs column on the products table?
  - productViewCountMaxRetries
```
protected static int productViewCountMaxRetries
```
    Number of times to retry the product view count update SQL
  - updateStockMutex
```
protected static java.lang.String updateStockMutex
```
    Mutex for updating stock
  - reserveStockMutex
```
protected static java.lang.String reserveStockMutex
```
    Mutex for reserving stock
  - prodViewMutex
```
protected static java.lang.String prodViewMutex
```
    Mutex for updating product viewed count
  - tagMutex
```
protected static java.lang.String tagMutex
```
    Mutex for updating tags
  - prodMgrMutex
```
protected static java.lang.String prodMgrMutex
```
    Mutex for the product manager
- Constructor Detail
  - ProductMgr
```
public ProductMgr(KKEngIf eng)
           throws java.lang.Exception
```
    Constructor
    
    Parameters:
    
    eng - the eng
    
    Throws:
    
    java.lang.Exception - an unexpected exception
- Method Detail
  - getProductsPerCategory
```
public Products getProductsPerCategory(java.lang.String sessionId,
                                       DataDescriptorIf dataDesc,
                                       int categoryId,
                                       boolean searchInSubCats,
                                       int languageId)
                                throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Returns the products for a category
    
    Specified by:
    
    getProductsPerCategory in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    categoryId - the categoryId
    
    searchInSubCats - the searchInSubCats
    
    languageId - the languageId
    
    Returns:
    
    Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductsPerCategoryWithOptions
```
public Products getProductsPerCategoryWithOptions(java.lang.String sessionId,
                                                  DataDescriptorIf dataDesc,
                                                  int categoryId,
                                                  boolean searchInSubCats,
                                                  int languageId,
                                                  FetchProductOptionsIf options)
                                           throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Returns the products for a category.An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    
    Specified by:
    
    getProductsPerCategoryWithOptions in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    categoryId - the categoryId
    
    searchInSubCats - the searchInSubCats
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductsPerCategoryPerManufacturer
```
public Products getProductsPerCategoryPerManufacturer(java.lang.String sessionId,
                                                      DataDescriptorIf dataDesc,
                                                      int categoryId,
                                                      int manufacturerId,
                                                      int languageId)
                                               throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Returns the products for a category and a manufacturer
    
    Specified by:
    
    getProductsPerCategoryPerManufacturer in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    categoryId - the categoryId
    
    manufacturerId - the manufacturerId
    
    languageId - the languageId
    
    Returns:
    
    Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductsPerCategoryPerManufacturerWithOptions
```
public Products getProductsPerCategoryPerManufacturerWithOptions(java.lang.String sessionId,
                                                                 DataDescriptorIf dataDesc,
                                                                 int categoryId,
                                                                 int manufacturerId,
                                                                 int languageId,
                                                                 FetchProductOptionsIf options)
                                                          throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Returns the products for a category and a manufacturer. An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    
    Specified by:
    
    getProductsPerCategoryPerManufacturerWithOptions in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    categoryId - the categoryId
    
    manufacturerId - the manufacturerId
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAllProducts
```
public Products getAllProducts(java.lang.String sessionId,
                               DataDescriptorIf dataDesc,
                               int languageId)
                        throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Returns all products
    
    Specified by:
    
    getAllProducts in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    languageId - the languageId
    
    Returns:
    
    Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAllProductsWithOptions
```
public Products getAllProductsWithOptions(java.lang.String sessionId,
                                          DataDescriptorIf dataDesc,
                                          int languageId,
                                          FetchProductOptionsIf options)
                                   throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Returns all products. An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    
    Specified by:
    
    getAllProductsWithOptions in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductsPerManufacturer
```
public Products getProductsPerManufacturer(java.lang.String sessionId,
                                           DataDescriptorIf dataDesc,
                                           int manufacturerId,
                                           int languageId)
                                    throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Returns the products for a manufacturer
    
    Specified by:
    
    getProductsPerManufacturer in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    manufacturerId - the manufacturerId
    
    languageId - the languageId
    
    Returns:
    
    Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductsPerManufacturerWithOptions
```
public Products getProductsPerManufacturerWithOptions(java.lang.String sessionId,
                                                      DataDescriptorIf dataDesc,
                                                      int manufacturerId,
                                                      int languageId,
                                                      FetchProductOptionsIf options)
                                               throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Returns the products for a manufacturer.An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    
    Specified by:
    
    getProductsPerManufacturerWithOptions in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    manufacturerId - the manufacturerId
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductsAllCases
```
protected Products getProductsAllCases(java.lang.String apiCall,
                                       java.lang.String sessionId,
                                       DataDescriptorIf dataDesc,
                                       int categoryId,
                                       int languageId,
                                       int manufacturerId,
                                       FetchProductOptionsIf options)
                                throws java.lang.Exception
```
    This protected method gets called by various flavours of public methods to get an array of products with differing criteria.
    
    Parameters:
    
    apiCall - the apiCall
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    categoryId - the categoryId
    
    languageId - the languageId
    
    manufacturerId - the manufacturerId
    
    options - the options
    
    Returns:
    
    Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getTaxClassId
```
public int getTaxClassId(int productId)
                  throws org.apache.torque.TorqueException,
                         com.konakart.app.KKException,
                         com.workingdogs.village.DataSetException
```
    Description copied from interface: ProductMgrIf
    
    Returns the tax class id for a product
    
    Specified by:
    
    getTaxClassId in interface ProductMgrIf
    
    Parameters:
    
    productId - the productId
    
    Returns:
    
    Returns the TaxClass Id
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - getProduct
```
public Product getProduct(java.lang.String sessionId,
                          int productId,
                          int languageId)
                   throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Fetches a fully populated product object. If there is a valid sessionId, the prices are calculated for the logged in customer.
    
    Specified by:
    
    getProduct in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    productId - the productId
    
    languageId - the languageId
    
    Returns:
    
    Returns a product object with full details
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductWithOptions
```
public Product getProductWithOptions(java.lang.String sessionId,
                                     int productId,
                                     int languageId,
                                     FetchProductOptionsIf options)
                              throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Fetches a fully populated product object. If there is a valid sessionId, the prices are calculated for the logged in customer. An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    
    Specified by:
    
    getProductWithOptions in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    productId - the productId
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Returns a product object with full details
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProduct
```
public Product getProduct(int customerId,
                          int productId,
                          int languageId)
                   throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Fetches a fully populated product object for a customer referenced by customerId.
    
    Specified by:
    
    getProduct in interface ProductMgrIf
    
    Parameters:
    
    customerId - the customerId
    
    productId - the productId
    
    languageId - the languageId
    
    Returns:
    
    Returns a product object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductWithOptions
```
public Product getProductWithOptions(int customerId,
                                     int productId,
                                     int languageId,
                                     FetchProductOptionsIf options)
                              throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Fetches a fully populated product object for a customer referenced by customerId. An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    
    Specified by:
    
    getProductWithOptions in interface ProductMgrIf
    
    Parameters:
    
    customerId - the customerId
    
    productId - the productId
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Returns a product object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductWithOptions
```
protected Product getProductWithOptions(int productId,
                                        Customer cust,
                                        int languageId,
                                        FetchProductOptionsIf options)
                                 throws java.lang.Exception
```
    Parameters:
    
    productId - the productId
    
    cust - the cust
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    A product object with full details
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductWithOptions
```
protected Product getProductWithOptions(int productId,
                                        java.lang.String catalogId,
                                        int priceId,
                                        int langId,
                                        FetchProductOptionsIf options)
                                 throws java.lang.Exception
```
    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
  - getProductOptions
```
protected java.util.HashMap<java.lang.String,Option> getProductOptions(KKCriteria criteria,
                                                                       Product prod,
                                                                       int priceId,
                                                                       int langId,
                                                                       FetchProductOptionsIf options)
                                                                throws java.lang.Exception
```
    Common code for setting the product options of a product.
    
    Parameters:
    
    criteria - the criteria
    
    prod - the prod
    
    priceId - the priceId
    
    langId - the langId
    
    options - the options
    
    Returns:
    
    Returns a hash map of Product Options
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getTagsPerProduct
```
protected Tag[] getTagsPerProduct(int productId,
                                  int langId)
                           throws com.workingdogs.village.DataSetException,
                                  org.apache.torque.TorqueException,
                                  com.konakart.app.KKException
```
    Get the tags for a product.
    
    Parameters:
    
    productId - the productId
    
    langId - the langId
    
    Returns:
    
    Returns the tags for a product or an empty array if there are none.
    
    Throws:
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - updateProductViewedCount
```
public void updateProductViewedCount(int productId,
                                     int languageId)
                              throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Increments the viewed count for the product.
    
    Specified by:
    
    updateProductViewedCount in interface ProductMgrIf
    
    Parameters:
    
    productId - the productId
    
    languageId - the languageId
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAllSpecials
```
public Products getAllSpecials(java.lang.String sessionId,
                               DataDescriptorIf dataDesc,
                               int languageId)
                        throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Returns all special priced products
    
    Specified by:
    
    getAllSpecials in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    languageId - the languageId
    
    Returns:
    
    Array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getSpecialsPerCategory
```
public Products getSpecialsPerCategory(java.lang.String sessionId,
                                       DataDescriptorIf dataDescriptor,
                                       int categoryId,
                                       boolean searchInSubCats,
                                       int languageId)
                                throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Returns all special priced products for a category
    
    Specified by:
    
    getSpecialsPerCategory in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDescriptor - the dataDescriptor
    
    categoryId - the categoryId
    
    searchInSubCats - the searchInSubCats
    
    languageId - the languageId
    
    Returns:
    
    Return an array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - addTax
```
protected void addTax(Customer cust,
                      Products products,
                      Product[] productArray)
               throws java.lang.Exception
```
    We iterate through the array of products and for each product, we set the price including tax. If the user isn't logged in, we use the country and zone of the store to determine whether any tax is due. Otherwise we use the country id and zone of the primary address of the logged in customer.
    As input we use products if it isn't null, otherwise we use prodArray.
    
    Parameters:
    
    cust - the cust
    
    productArray - the productArray
    
    products - the products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - addTax
```
protected void addTax(Customer cust,
                      Product product)
               throws java.lang.Exception
```
    We set the price of the product including tax for the customer identified by cust. We use the country id and zone of the primary address of the customer.
    
    Parameters:
    
    cust - the cust
    
    product - the product
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductsFromIds
```
public Product[] getProductsFromIds(java.lang.String sessionId,
                                    java.util.ArrayList<java.lang.Integer> prodIdList,
                                    int languageId)
                             throws java.lang.Exception
```
    Returns an array of products referenced by the ids in prodIdList.
    
    Specified by:
    
    getProductsFromIds in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    prodIdList - the prodIdList
    
    languageId - the languageId
    
    Returns:
    
    An array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductsFromIdsWithOptions
```
public Product[] getProductsFromIdsWithOptions(java.lang.String sessionId,
                                               java.util.ArrayList<java.lang.Integer> prodIdList,
                                               int languageId,
                                               FetchProductOptionsIf options)
                                        throws java.lang.Exception
```
    Returns an array of products referenced by the ids in prodIdList.
    
    Specified by:
    
    getProductsFromIdsWithOptions in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    prodIdList - the prodIdList
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    An array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductsFromIdsWithOptions
```
public Product[] getProductsFromIdsWithOptions(java.lang.String sessionId,
                                               DataDescriptorIf dataDesc,
                                               int[] prodIdArray,
                                               int languageId,
                                               FetchProductOptionsIf options)
                                        throws java.lang.Exception
```
    Returns an array of products referenced by the ids in prodIdArray.
    
    Specified by:
    
    getProductsFromIdsWithOptions in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    prodIdArray - the prodIdArray
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    An array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - searchForProducts
```
public Products searchForProducts(java.lang.String sessionId,
                                  DataDescriptorIf dataDesc,
                                  ProductSearchIf prodSearch,
                                  int languageId)
                           throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Returns products matching the search criteria.
    
    Specified by:
    
    searchForProducts in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    prodSearch - the prodSearch
    
    languageId - the languageId
    
    Returns:
    
    Return a Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - searchForProductsWithOptions
```
public Products searchForProductsWithOptions(java.lang.String sessionId,
                                             DataDescriptorIf dataDesc,
                                             ProductSearchIf prodSearch,
                                             int languageId,
                                             FetchProductOptionsIf options)
                                      throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Returns products matching the search criteria. An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    
    Specified by:
    
    searchForProductsWithOptions in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    prodSearch - the prodSearch
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Return a Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - useSpecialPrice
```
protected boolean useSpecialPrice()
```
    This can be specialized to return false if special prices aren't used. In this case the query that filters products by price runs faster.
    
    Returns:
    
    Returns a boolean
  - fetchDescriptionsSeparately
```
protected boolean fetchDescriptionsSeparately()
                                       throws com.konakart.app.KKException
```
    This can be specialized to modify the way the product descriptions are queried or the configuration variable can be set to the value you require to be returned here.
    
    Returns:
    
    Returns true to fetch the product descriptions separately (typically used when using Oracle CLOBs for storing product descriptions). Returns false to fetch the product descriptions as part of the main product query.
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - searchForProductsPrivate
```
protected Products searchForProductsPrivate(KKCriteria criteria,
                                            java.lang.String apiCall,
                                            java.lang.String sessionId,
                                            DataDescriptorIf dataDescriptor,
                                            ProductSearchIf productSearch,
                                            java.util.ArrayList<java.lang.Integer> productIdList,
                                            int languageId,
                                            FetchProductOptionsIf options)
                                     throws java.lang.Exception
```
    Returns products matching the search criteria in the format defined by the data descriptor.
    
    Parameters:
    
    criteria - the criteria
    
    apiCall - the apiCall
    
    sessionId - the sessionId
    
    dataDescriptor - the dataDescriptor
    
    productSearch - the productSearch
    
    productIdList - If not null, it must contain a list of productIds which will be added to an IN clause.
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Return a Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCustomAttrs
```
protected java.lang.String getCustomAttrs(int productId)
                                   throws java.lang.Exception
```
    Get the custom_attrs for the product with the specified Id
    
    Parameters:
    
    productId - the productId
    
    Returns:
    
    the custom_attrs as a String
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - doTierPricesExist
```
protected boolean doTierPricesExist()
                             throws java.lang.Exception
```
    Returns true if at least one TierPrice record exists in the database. Used to determine whether the functionality is being used.
    
    Returns:
    
    Returns true if at least one TierPrice record exists in the database
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getTierPrices
```
protected TierPrice[] getTierPrices(Product prod,
                                    int productPriceId,
                                    FetchProductOptionsIf options)
                             throws org.apache.torque.TorqueException,
                                    com.konakart.app.KKException,
                                    com.workingdogs.village.DataSetException
```
    Return the An array of TierPrice objects (or null) for the product referenced by productId
    
    Parameters:
    
    prod - the prod
    
    productPriceId - the productPriceId
    
    options - the options
    
    Returns:
    
    Returns an array of TierPrice objects
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - setCriteriaWithStandardAttributes
```
protected void setCriteriaWithStandardAttributes(KKCriteria c,
                                                 int languageId,
                                                 FetchProductOptionsIf options,
                                                 boolean singleProduct)
                                          throws org.apache.torque.TorqueException,
                                                 com.konakart.app.KKException,
                                                 com.workingdogs.village.DataSetException,
                                                 java.lang.Exception
```
    Initializes the criteria with the standard attributes for the product.
    
    Parameters:
    
    c - the c
    
    languageId - the languageId
    
    options - the options
    
    singleProduct - the singleProduct
    
    Throws:
    
    java.lang.Exception - an unexpected exception
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
  - setCriteriaWithStandardAttributes
```
protected void setCriteriaWithStandardAttributes(KKCriteria c,
                                                 int languageId,
                                                 boolean manuOuterJoin,
                                                 boolean multiStoreSearch,
                                                 FetchProductOptionsIf options,
                                                 DataDescriptorIf dd,
                                                 boolean singleProduct,
                                                 ProductSearchIf prodSearch)
                                          throws org.apache.torque.TorqueException,
                                                 com.konakart.app.KKException,
                                                 com.workingdogs.village.DataSetException,
                                                 java.lang.Exception
```
    Initializes the criteria with the standard attributes for the product. Depending on the value of manuOuterJoin we do a normal or outer join with the manufacturers table.
    
    Parameters:
    
    c - the c
    
    languageId - the languageId
    
    manuOuterJoin - the manuOuterJoin
    
    multiStoreSearch - the multiStoreSearch
    
    options - the options
    
    dd - the dd
    
    singleProduct - the singleProduct
    
    prodSearch - the product search object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
  - setProductsSharedCriteria
```
protected void setProductsSharedCriteria(KKCriteria c,
                                         boolean getPriceId,
                                         FetchProductOptionsIf options)
                                  throws com.konakart.app.KKException
```
    Add criteria to get shared products from the database
    
    Parameters:
    
    c - the c
    
    getPriceId - the getPriceId
    
    options - the options
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - manageDataDescriptor
```
protected void manageDataDescriptor(DataDescriptorIf dataDesc,
                                    org.apache.torque.util.Criteria c,
                                    java.lang.String price)
```
    Provides common code to deal with the management of the DataDescriptor. The price is passed in because in the case of specials, we use the specials price. In the case of products that may not have the special price set, we use a virtual column that is either set to the price or the special price if it exists. It calls manageDataDescriptor(DataDescriptorIf dataDesc, Criteria c, String price, boolean addConstraints) with addConstraints set to true.
    
    Parameters:
    
    dataDesc - the dataDesc
    
    c - the c
    
    price - the price
  - manageDataDescriptor
```
protected void manageDataDescriptor(DataDescriptorIf dataDesc,
                                    org.apache.torque.util.Criteria c,
                                    java.lang.String price,
                                    boolean addConstraints)
```
    Provides common code to deal with the management of the DataDescriptor. The price is passed in because in the case of specials, we use the specials price. In the case of products that may not have the special price set, we use a virtual column that is either set to the price or the special price if it exists.
    
    Parameters:
    
    dataDesc - the dataDesc
    
    c - the c
    
    price - the price
    
    addConstraints - If set to true, the custom field constraints are added.
  - getCount
```
protected int getCount(java.lang.String sessionId,
                       java.lang.String apiCall,
                       DataDescriptorIf dataDesc,
                       ProductSearchIf prodSearch,
                       KKCriteria criteria,
                       boolean fixQuery,
                       boolean tagCount,
                       boolean multiStoreSearch,
                       int languageId,
                       FetchProductOptionsIf options)
                throws java.lang.Exception
```
    This method is mainly used for paging.
    
    Parameters:
    
    sessionId - the sessionId
    
    apiCall - the apiCall
    
    dataDesc - the dataDesc
    
    prodSearch - the prodSearch
    
    criteria - the criteria
    
    fixQuery - the fixQuery
    
    tagCount - the tagCount
    
    multiStoreSearch - the multiStoreSearch
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    The number of records present in the database matching the given criteria
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getOption
```
public Option getOption(int productId,
                        int optionId,
                        int optionValueId,
                        int priceId,
                        int languageId,
                        FetchProductOptionsIf options)
                 throws java.lang.Exception
```
    Finds a single Option object for the parameters passed in by reading from the product_attributes, product_options and product_options_values tables.
    
    Specified by:
    
    getOption in interface ProductMgrIf
    
    Parameters:
    
    productId - the productId
    
    optionId - the optionId
    
    optionValueId - the optionValueId
    
    priceId - the priceId
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Returns an Option object or null if not found
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getBestSellersWithOptions
```
public Product[] getBestSellersWithOptions(DataDescriptorIf dataDesc,
                                           int categoryId,
                                           int languageId,
                                           FetchProductOptionsIf options)
                                    throws java.lang.Exception
```
    Returns an array of bestseller products for the category and its children. The products are returned in the language referenced by languageId. If the categoryId=0 then it is not used as a constraint for the query.
    
    Specified by:
    
    getBestSellersWithOptions in interface ProductMgrIf
    
    Parameters:
    
    dataDesc - the dataDesc
    
    categoryId - the categoryId
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    An array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - addProductDescriptions
```
protected void addProductDescriptions(Product[] prods,
                                      int langId,
                                      boolean multiStoreSearch)
                               throws java.lang.Exception
```
    Adds the description to an array of products
    
    Parameters:
    
    prods - the prods
    
    langId - the langId
    
    multiStoreSearch - the multiStoreSearch
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getBestSellers
```
public Product[] getBestSellers(DataDescriptorIf dataDesc,
                                int categoryId,
                                int languageId)
                         throws java.lang.Exception
```
    Calls getBestSellersWithOptions
    
    Specified by:
    
    getBestSellers in interface ProductMgrIf
    
    Parameters:
    
    dataDesc - the dataDesc
    
    categoryId - the categoryId
    
    languageId - the languageId
    
    Returns:
    
    An array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getOrderHistoryWithOptions
```
public Product[] getOrderHistoryWithOptions(DataDescriptorIf dataDesc,
                                            java.lang.String sessionId,
                                            int languageId,
                                            FetchProductOptionsIf options)
                                     throws java.lang.Exception
```
    Get a list of the products ordered by the customer referenced by the sessionId.
    
    Specified by:
    
    getOrderHistoryWithOptions in interface ProductMgrIf
    
    Parameters:
    
    dataDesc - the dataDesc
    
    sessionId - the sessionId
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Returns a list of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getOrderHistory
```
public Product[] getOrderHistory(DataDescriptorIf dataDesc,
                                 java.lang.String sessionId,
                                 int languageId)
                          throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Get a list of the products ordered by the customer referenced by the sessionId.
    
    Specified by:
    
    getOrderHistory in interface ProductMgrIf
    
    Parameters:
    
    dataDesc - the dataDesc
    
    sessionId - the sessionId
    
    languageId - the languageId
    
    Returns:
    
    Returns a list of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAlsoPurchasedWithOptions
```
public Product[] getAlsoPurchasedWithOptions(java.lang.String sessionId,
                                             DataDescriptorIf dataDesc,
                                             int productId,
                                             int languageId,
                                             FetchProductOptionsIf options)
                                      throws java.lang.Exception
```
    Find products that were in the same order as orders containing the product referenced by productId. The return order of the products is by purchase date (most recent first). The DataDescriptor determines the number of products returned.
    
    Specified by:
    
    getAlsoPurchasedWithOptions in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    productId - the productId
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAlsoPurchased
```
public Product[] getAlsoPurchased(java.lang.String sessionId,
                                  DataDescriptorIf dataDesc,
                                  int productId,
                                  int languageId)
                           throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Find products that were in the same order as orders containing the product referenced by productId. The return order of the products is by purchase date (most recent first). The DataDescriptor determines the number of products returned.
    
    Specified by:
    
    getAlsoPurchased in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    productId - the productId
    
    languageId - the languageId
    
    Returns:
    
    Array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getBundlesThatProductBelongsTo
```
public Products getBundlesThatProductBelongsTo(java.lang.String sessionId,
                                               DataDescriptorIf dataDesc,
                                               int productId,
                                               int languageId,
                                               FetchProductOptionsIf options)
                                        throws java.lang.Exception
```
    The method fetches an array of bundles (products of type bundle), all of which contain the product with id productId as one of the bundled products. Each of the returned products has the bundledProducts attribute populated with all of the bundled products. The quantity attribute of each bundled product determines the number of instances of the product within the bundle and the encodedOptionValues attribute of each bundled product contains a string with the encoded option values determining the configuration of the product (e.g size, color etc.).
    
    Specified by:
    
    getBundlesThatProductBelongsTo in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    productId - the productId
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Returns a Products object containing an array of products, each with a populated bundledProducts attribute containing the products within the bundle.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getBundlesThatProductsBelongTo
```
public Products getBundlesThatProductsBelongTo(java.lang.String sessionId,
                                               DataDescriptorIf dataDescriptor,
                                               int[] productIds,
                                               boolean exactMatch,
                                               int languageId,
                                               FetchProductOptionsIf options)
                                        throws java.lang.Exception
```
    The method fetches an array of bundles (products of type bundle), all of which contain the product ids productIds as one or more of the bundled products. Each of the returned products has the bundledProducts attribute populated with all of the bundled products. The quantity attribute of each bundled product determines the number of instances of the product within the bundle and the encodedOptionValues attribute of each bundled product contains a string with the encoded option values determining the configuration of the product (e.g size, color etc.).
    
    Specified by:
    
    getBundlesThatProductsBelongTo in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDescriptor - the dataDescriptor
    
    productIds - the productIds
    
    exactMatch - determines whether the call should return only bundles which contain exactly the products sent in the array of product IDs, or return all the bundles which contain at least all the products in the passed product IDs.
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Returns a Products object containing an array of products, each with a populated bundledProducts attribute containing the products within the bundle.
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - setBundledProducts
```
protected void setBundledProducts(ProductIf currentParent,
                                  java.util.ArrayList<ProductIf> childProdList)
```
    Private method to avoid duplicating code
    
    Parameters:
    
    currentParent - the currentParent
    
    childProdList - the childProdList
  - getRelatedProducts
```
public Products getRelatedProducts(java.lang.String sessionId,
                                   DataDescriptorIf dataDesc,
                                   int productId,
                                   int relationType,
                                   int languageId)
                            throws java.lang.Exception
```
    Find products related to the product defined by the productId parameter. The relationType defines the relation. Valid values for relationType are:
    - 0 All relationships
    - 1 Up Selling. Normally a superior version of the same product.
    - 2 Cross Selling. Normally similar or related products.
    - 3 Accessories
    - 4 Dependent Item. Normally cannot be sold independently such as a warranty.
    - 5 This relationship can be used when productId is the id of a "bundle" product. It returns all products that are part of the bundle.
    Specified by:
    
    getRelatedProducts in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    productId - the productId
    
    relationType - the relationType
    
    languageId - the languageId
    
    Returns:
    
    A products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getRelatedProductsWithOptions
```
public Products getRelatedProductsWithOptions(java.lang.String sessionId,
                                              DataDescriptorIf dataDesc,
                                              int productId,
                                              int relationType,
                                              int languageId,
                                              FetchProductOptionsIf options)
                                       throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    Find products related to the product defined by the productId parameter. The relationType defines the relation. Valid values for relationType are:
    - 0 All relationships
    - 1 Up Selling. Normally a superior version of the same product.
    - 2 Cross Selling. Normally similar or related products.
    - 3 Accessories
    - 4 Dependent Item. Normally cannot be sold independently such as a warranty.
    - 5 This relationship can be used when productId is the id of a "bundle" product. It returns all products that are part of the bundle.
    An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    Specified by:
    
    getRelatedProductsWithOptions in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    productId - the productId
    
    relationType - the relationType
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    A products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getRelatedProducts
```
protected Products getRelatedProducts(java.lang.String sessionId,
                                      DataDescriptorIf dataDescriptor,
                                      int productId,
                                      int relationType,
                                      int languageId,
                                      java.util.HashMap<java.lang.String,Product> bundleProductMap,
                                      int loopInput,
                                      int quantity,
                                      FetchProductOptionsIf options)
                               throws java.lang.Exception
```
    A protected version of getRelatedProducts with a hash map passed in for recursion
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDescriptor - the dataDescriptor
    
    productId - the productId
    
    relationType - the relationType
    
    languageId - the languageId
    
    bundleProductMap - HashMap used to keep track of products during recursion.
    
    loopInput - Used to stop recursion forever. Throws an exception if recursion occurs when a bundle product is set to be a product within the bundle.
    
    quantity - Used to multiply quantity during recursion. i.e. A bundled product may have a quantity of two and itself be a bundle. This means that all of the products in its bundle have to be multiplied by two.
    
    options - the options
    
    Returns:
    
    A products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAllProductRelationships
```
public ProductRelationship[] getAllProductRelationships()
                                                 throws java.lang.Exception
```
    Returns all product relationships in a single call.
    
    Specified by:
    
    getAllProductRelationships in interface ProductMgrIf
    
    Returns:
    
    Returns an array of ProductRelationship objects
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getSku
```
public java.lang.String getSku(OrderProductIf orderProd)
                        throws com.konakart.app.KKException,
                               org.apache.torque.TorqueException,
                               com.workingdogs.village.DataSetException
```
    This method is deprecated since release 4.0.0.0 because an SKU attribute was added to the OrderProduct.
    
    Specified by:
    
    getSku in interface ProductMgrIf
    
    Parameters:
    
    orderProd - the orderProd
    
    Returns:
    
    Returns the SKU for the OrderProduct
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - getSku
```
protected java.lang.String getSku(int productId)
                           throws org.apache.torque.TorqueException,
                                  com.workingdogs.village.DataSetException,
                                  com.konakart.app.KKException
```
    Gets the SKU for a product directly from the product table.
    
    Parameters:
    
    productId - the productId
    
    Returns:
    
    Returns the SKU
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - updateProductQuantity
```
public int updateProductQuantity(int productId,
                                 OptionIf[] opts,
                                 int quantitySold,
                                 boolean setStatus)
                          throws java.lang.Exception
```
    The product quantity is updated by subtracting quantitySold from the current quantity. If setStatus is set to true, we make the product unavailable (by setting the product status to 0) if the quantity falls to zero or below.
    
    Specified by:
    
    updateProductQuantity in interface ProductMgrIf
    
    Parameters:
    
    productId - the productId
    
    opts - the opts
    
    quantitySold - the quantitySold
    
    setStatus - the setStatus
    
    Returns:
    
    The new quantity
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - updateProductQuantity
```
public int updateProductQuantity(int productId,
                                 OptionIf[] opts,
                                 java.lang.String encodedOptions,
                                 int quantitySold,
                                 boolean setStatus)
                          throws java.lang.Exception
```
    The product quantity is updated by subtracting quantitySold from the current quantity. If setStatus is set to true, we make the product unavailable (by setting the product status to 0) if the quantity falls to zero or below.
    This method either uses opts or encodedOptions depending on which one isn't set to null.
    
    Specified by:
    
    updateProductQuantity in interface ProductMgrIf
    
    Parameters:
    
    productId - the productId
    
    opts - the opts
    
    encodedOptions - the encodedOptions
    
    quantitySold - the quantitySold
    
    setStatus - the setStatus
    
    Returns:
    
    The new quantity
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - updateProductQuantityWithOptions
```
public int updateProductQuantityWithOptions(int productId,
                                            OptionIf[] opts,
                                            java.lang.String encodedOptions,
                                            int quantitySold,
                                            boolean setStatus,
                                            FetchProductOptionsIf options)
                                     throws java.lang.Exception
```
    The product quantity is updated by subtracting quantitySold from the current quantity. If setStatus is set to true, we make the product unavailable (by setting the product status to 0) if the quantity falls to zero or below.
    This method either uses opts or encodedOptions depending on which one isn't set to null.
    
    Specified by:
    
    updateProductQuantityWithOptions in interface ProductMgrIf
    
    Parameters:
    
    productId - the productId
    
    opts - the opts
    
    encodedOptions - the encodedOptions
    
    quantitySold - the quantitySold
    
    setStatus - the setStatus
    
    options - the options
    
    Returns:
    
    The new quantity
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - updateBundleProductQuantityWithOptions
```
protected void updateBundleProductQuantityWithOptions(int productId,
                                                      int quantitySold,
                                                      boolean setStatus,
                                                      FetchProductOptionsIf options)
                                               throws java.lang.Exception
```
    Updates the quantities for a bundle product.
    
    Parameters:
    
    productId - the productId
    
    quantitySold - the quantitySold
    
    setStatus - the setStatus
    
    options - the options
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - decProductQuantitiesWithOptions
```
protected int decProductQuantitiesWithOptions(int productId,
                                              int quantitySold,
                                              boolean setProductStatus,
                                              boolean onlyOrdered,
                                              FetchProductOptionsIf options)
                                       throws java.lang.Exception
```
    An internal method to avoid code duplication. It reads the product object to get the current quantity and current products ordered. These values are updated with respect to the quantitySold parameter and then re-written to the DB.
    If onlyOrdered == true, we don't touch the quantity attribute and only update the ordered attribute.
    If setProductStatus is set to true, the status of the product is changed if the quantity falls below zero.
    
    Parameters:
    
    productId - the productId
    
    quantitySold - the quantitySold
    
    setProductStatus - the setProductStatus
    
    onlyOrdered - the onlyOrdered
    
    options - the options
    
    Returns:
    
    Returns the current quantity
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - updateProductsOrdered
```
public void updateProductsOrdered(OrderIf order)
                           throws java.lang.Exception
```
    Update the products ordered count for the products sold in an order
    
    Specified by:
    
    updateProductsOrdered in interface ProductMgrIf
    
    Parameters:
    
    order - the order
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductQuantity
```
public ProductQuantityIf getProductQuantity(java.lang.String encodedProductId)
                                     throws java.lang.Exception
```
    The stock level of the product is returned. An exception is thrown if the product doesn't exist or if the encoded product id has an invalid format. The format of the encoded product id is 1{2}3{4}5 where the product id = 1, the first optionId / valueId pair have ids of 2,3 and the 2nd optionId / valueId pair have ids of 4,5. If there are no option / value pairs then we use the stock level from the product object. If there is at least one option / value pair, we attempt to find the quantity in the product quantity table. If we can't find it in the product_quantity table we look for at least one record in the product_quantity table for this product id. If we find something then we assume that the quantity is zero. If we find no records, we use the quantity from the product object.
    
    Specified by:
    
    getProductQuantity in interface ProductMgrIf
    
    Parameters:
    
    encodedProductId - the encodedProductId
    
    Returns:
    
    Stock level
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductQuantityWithOptions
```
public ProductQuantityIf getProductQuantityWithOptions(java.lang.String encodedProductId,
                                                       FetchProductOptionsIf options)
                                                throws java.lang.Exception
```
    The stock level of the product is returned. An exception is thrown if the product doesn't exist or if the encoded product id has an invalid format. The format of the encoded product id is 1{2}3{4}5 where the product id = 1, the first optionId / valueId pair have ids of 2,3 and the 2nd optionId / valueId pair have ids of 4,5. If there are no option / value pairs then we use the stock level from the product object. If there is at least one option / value pair, we attempt to find the quantity in the product quantity table. If we can't find it in the product_quantity table we look for at least one record in the product_quantity table for this product id. If we find something then we assume that the quantity is zero. If we find no records, we use the quantity from the product object.
    
    Specified by:
    
    getProductQuantityWithOptions in interface ProductMgrIf
    
    Parameters:
    
    encodedProductId - the encodedProductId
    
    options - the options
    
    Returns:
    
    Stock level
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - createProductQuantityEncodedKeyFromOptions
```
public java.lang.String createProductQuantityEncodedKeyFromOptions(OptionIf[] opts)
```
    Takes in an an array of options and returns an encoded key for the products_quantity table
    The format of the encoded key for the products_quantity table is 3{4}4{6} which means product_options of id==3 and product_options_values of id==4 followed by product_options of id==4 and product_options_values of id==6. The order is very important since the product option ids must be in ascending order.
    
    Specified by:
    
    createProductQuantityEncodedKeyFromOptions in interface ProductMgrIf
    
    Parameters:
    
    opts - the opts
    
    Returns:
    
    Returns the encoded key for the products_quantity table
  - createOptionsFromProductQuantityEncodedKey
```
public OptionIf[] createOptionsFromProductQuantityEncodedKey(java.lang.String encodedKey)
```
    Receives an encoded key from the products_quantity table in the format 3{4}4{6} and creates an array of Option objects.
    
    Specified by:
    
    createOptionsFromProductQuantityEncodedKey in interface ProductMgrIf
    
    Parameters:
    
    encodedKey - the encodedKey
    
    Returns:
    
    Return an array of Option objects
  - createProductQuantityEncodedKeyFromEncodedProductId
```
public ProductQuantity createProductQuantityEncodedKeyFromEncodedProductId(java.lang.String encodedProductId)
                                                                    throws com.konakart.app.KKException
```
    Takes in an encodedProductId and returns an encoded key for the products_quantity table
    The format of the encoded product id is 1{2}3{4}5 where the product id = 1, the first optionId / valueId pair have ids of 2,3 and the 2nd optionId / valueId pair have ids of 4,5.
    The format of the encoded key for the products_quantitytable is 3{4}4{6} which means product_options of id==3 and product_options_values of id==4 followed by product_options of id==4 and product_options_values of id==6. The order is very important since the product option ids must be in ascending order.
    
    Specified by:
    
    createProductQuantityEncodedKeyFromEncodedProductId in interface ProductMgrIf
    
    Parameters:
    
    encodedProductId - the encodedProductId
    
    Returns:
    
    Returns the encoded key for the products_quantity table
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - createEncodedProductIdFromProductQuantityEncodedKey
```
public java.lang.String createEncodedProductIdFromProductQuantityEncodedKey(int productId,
                                                                            java.lang.String productQuantityEncodedKey)
```
    Takes in a productQuantityEncodedKey and a productId and returns an encoded product Id. for the products_quantity table
    The format of the encoded product id is 1{2}3{4}5 where the product id = 1, the first optionId / valueId pair have ids of 2,3 and the 2nd optionId / valueId pair have ids of 4,5.
    The format of the encoded key for the products_quantitytable is 3{4}4{6} which means product_options of id==3 and product_options_values of id==4 followed by product_options of id==4 and product_options_values of id==6. The order is very important since the product option ids must be in ascending order.
    
    Specified by:
    
    createEncodedProductIdFromProductQuantityEncodedKey in interface ProductMgrIf
    
    Parameters:
    
    productId - the productId
    
    productQuantityEncodedKey - the productQuantityEncodedKey
    
    Returns:
    
    Returns the encoded productId
  - getProductQuantityWithOptions
```
protected ProductQuantityIf getProductQuantityWithOptions(int productId,
                                                          FetchProductOptionsIf options)
                                                   throws java.lang.Exception
```
    The stock level and available date of the product is returned assuming it has no attributes. An exception is thrown if the product doesn't exist.
    
    Parameters:
    
    productId - the productId
    
    options - the options
    
    Returns:
    
    Stock level
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductQuantitiesPerProductWithOptions
```
protected ProductQuantityIf[] getProductQuantitiesPerProductWithOptions(int productId,
                                                                        FetchProductOptionsIf options,
                                                                        java.util.HashMap<java.lang.String,Option> optionMap)
                                                                 throws org.apache.torque.TorqueException,
                                                                        com.workingdogs.village.DataSetException,
                                                                        com.konakart.app.KKException
```
    Return all of the product quantities associated with a product
    
    Parameters:
    
    productId - the productId
    
    options - the options
    
    optionMap - the optionMap
    
    Returns:
    
    Returns a ProductQuantityIf[]
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - getProductQuantityPerProductWithOptions
```
protected ProductQuantityIf getProductQuantityPerProductWithOptions(int productId,
                                                                    java.lang.String encodedOptionValues,
                                                                    FetchProductOptionsIf options)
                                                             throws org.apache.torque.TorqueException,
                                                                    com.workingdogs.village.DataSetException,
                                                                    com.konakart.app.KKException
```
    Return all of the product quantities associated with a product
    
    Parameters:
    
    productId - the productId
    
    encodedOptionValues - the encodedOptionValues
    
    options - the options
    
    Returns:
    
    Returns a ProductQuantityIf object
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - getProductType
```
protected int getProductType(int productId)
                      throws org.apache.torque.TorqueException,
                             com.konakart.app.KKException,
                             com.workingdogs.village.DataSetException
```
    Return the product type
    
    Parameters:
    
    productId - the productId
    
    Returns:
    
    Returns the product type
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - getLightProduct
```
protected Product getLightProduct(int productId)
                           throws org.apache.torque.TorqueException,
                                  com.konakart.app.KKException,
                                  com.workingdogs.village.DataSetException
```
    Fetches a very "light" product with few attributes
    
    Parameters:
    
    productId - the productId
    
    Returns:
    
    Returns a product
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - insertDigitalDownload
```
public int insertDigitalDownload(java.lang.String sessionId,
                                 int productId)
                          throws java.lang.Exception
```
    Create and insert a digital download record for the product identified by the productId and the customer identified by the sessionId. If the digital download already exists, then we overwrite it with the new one.
    
    Specified by:
    
    insertDigitalDownload in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    productId - the productId
    
    Returns:
    
    Returns the id of the inserted Digital Download
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - insertDigitalDownload
```
public int insertDigitalDownload(int customerId,
                                 int productId)
                          throws java.lang.Exception
```
    Create and insert a digital download record for the product identified by the productId and the customer identified by the customerId. If the digital download already exists, then we overwrite it with the new one.
    
    Specified by:
    
    insertDigitalDownload in interface ProductMgrIf
    
    Parameters:
    
    productId - the productId
    
    customerId - the customerId
    
    Returns:
    
    Returns the id of the inserted Digital Download
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - insertGiftCertificateDigitalDownload
```
public int insertGiftCertificateDigitalDownload(int customerId,
                                                int productId,
                                                java.lang.String filePath)
                                         throws java.lang.Exception
```
    Create and insert a digital download record for the product identified by the productId and the customer identified by the customerId. The file path of the digital download will be used instead of the file path in the product object, to download the certificate.
    
    Specified by:
    
    insertGiftCertificateDigitalDownload in interface ProductMgrIf
    
    Parameters:
    
    customerId - the customerId
    
    productId - the productId
    
    filePath - the filePath
    
    Returns:
    
    Returns the id of the inserted Digital Download
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getMaxDownloadDays
```
protected int getMaxDownloadDays(Product prod)
                          throws org.apache.torque.TorqueException,
                                 com.konakart.app.KKException,
                                 com.workingdogs.village.DataSetException,
                                 java.lang.Exception
```
    Common code to get the maximum number of download days
    
    Parameters:
    
    prod - the prod
    
    Returns:
    
    Returns the maximum number of download days
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    java.lang.Exception - an unexpected exception
  - getExpiryDate
```
protected java.util.Date getExpiryDate(int maxDownloadDays)
```
    Common code to get the expiry date
    
    Parameters:
    
    maxDownloadDays - the maxDownloadDays
    
    Returns:
    
    Returns the expiry date
  - getMaxNumDownloads
```
protected int getMaxNumDownloads(Product prod)
                          throws org.apache.torque.TorqueException,
                                 com.konakart.app.KKException,
                                 com.workingdogs.village.DataSetException,
                                 java.lang.Exception
```
    Common code to get the maximum number of downloads
    
    Parameters:
    
    prod - the prod
    
    Returns:
    
    Returns the maximum number of downloads
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    java.lang.Exception - an unexpected exception
  - getDigitalDownloadsWithOptions
```
public DigitalDownload[] getDigitalDownloadsWithOptions(java.lang.String sessionId,
                                                        int languageId,
                                                        FetchDigitalDownloadOptionsIf ddOptions,
                                                        FetchProductOptionsIf prodOptions)
                                                 throws java.lang.Exception
```
    Returns an array of Digital Download objects for the customer identified by the sessionId parameter. The ddOptions parameter allows you to define whether the product attribute of the returned Digital Download objects is populated. If the DD_DELETE_ON_EXPIRATION configuration variable is set to "true", then the objects read from the database that have expired are automatically deleted. This avoids having to maintain the database table.
    
    Specified by:
    
    getDigitalDownloadsWithOptions in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    languageId - the languageId
    
    ddOptions - the ddOptions
    
    prodOptions - the prodOptions
    
    Returns:
    
    Returns an array of DigitalDownload objects
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getDigitalDownloads
```
public DigitalDownload[] getDigitalDownloads(java.lang.String sessionId)
                                      throws java.lang.Exception
```
    Returns an array of Digital Download objects for the customer identified by the sessionId parameter. The product attribute of the Digital Download objects is not populated. If the DD_DELETE_ON_EXPIRATION configuration variable is set to "true", then the objects read from the database that have expired are automatically deleted. This avoids having to maintain the database table.
    
    Specified by:
    
    getDigitalDownloads in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    Returns:
    
    Returns an array of DigitalDownload objects
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getDigitalDownload
```
protected DigitalDownload getDigitalDownload(int customerId,
                                             int productId)
                                      throws com.konakart.app.KKException,
                                             org.apache.torque.TorqueException,
                                             com.workingdogs.village.DataSetException
```
    Returns a Digital Download object for the customerId and productId passed in as parameters. Returns null if no object exists.
    
    Parameters:
    
    customerId - the customerId
    
    productId - the productId
    
    Returns:
    
    Returns an DigitalDownload object
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - getDigitalDownloadById
```
public DigitalDownload getDigitalDownloadById(java.lang.String sessionId,
                                              int digitalDownloadId)
                                       throws java.lang.Exception
```
    Returns a Digital Download object for the digital download id. Returns null if no object exists.
    
    Specified by:
    
    getDigitalDownloadById in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    digitalDownloadId - the digitalDownloadId
    
    Returns:
    
    Returns an DigitalDownload object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getDigitalDownloadById
```
public DigitalDownload getDigitalDownloadById(int digitalDownloadId)
                                       throws com.konakart.app.KKException,
                                              org.apache.torque.TorqueException,
                                              com.workingdogs.village.DataSetException
```
    Returns a Digital Download object for the digital download id. Returns null if no object exists.
    
    Specified by:
    
    getDigitalDownloadById in interface ProductMgrIf
    
    Parameters:
    
    digitalDownloadId - the digitalDownloadId
    
    Returns:
    
    Returns an DigitalDownload object
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - editDigitalDownload
```
public void editDigitalDownload(java.lang.String sessionId,
                                DigitalDownloadIf digitalDownload)
                         throws java.lang.Exception
```
    Edits the digital download object
    
    Specified by:
    
    editDigitalDownload in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    digitalDownload - the digitalDownload
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - editDigitalDownload
```
public void editDigitalDownload(DigitalDownloadIf digitalDownload)
                         throws com.konakart.app.KKException,
                                org.apache.torque.TorqueException,
                                com.workingdogs.village.DataSetException
```
    Edits the digital download object
    
    Specified by:
    
    editDigitalDownload in interface ProductMgrIf
    
    Parameters:
    
    digitalDownload - the digitalDownload
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - setDigitalDownloadCriteria
```
protected void setDigitalDownloadCriteria(KKCriteria c)
                                   throws com.konakart.app.KKException
```
    Sets the criteria with the standard attributes so as not to have to repeat this code many times.
    
    Parameters:
    
    c - the c
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - updateDigitalDownloadCount
```
public int updateDigitalDownloadCount(java.lang.String sessionId,
                                      int productId)
                               throws java.lang.Exception
```
    Updates the count of the Digital Download that defines how many times it has been downloaded.
    
    Specified by:
    
    updateDigitalDownloadCount in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    productId - the productId
    
    Returns:
    
    Returns the new count
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - updateDigitalDownloadCountById
```
public int updateDigitalDownloadCountById(java.lang.String sessionId,
                                          int digitalDownloadId)
                                   throws java.lang.Exception
```
    Updates the count of the Digital Download (identified by id) that defines how many times it has been downloaded. This is used when there may be many digital downloads for the same product pointing to different files. i.e. Tickets
    
    Specified by:
    
    updateDigitalDownloadCountById in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    digitalDownloadId - the digitalDownloadId
    
    Returns:
    
    Returns the new count
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - deleteDigitalDownload
```
protected void deleteDigitalDownload(DigitalDownload dd)
                              throws org.apache.torque.TorqueException,
                                     com.konakart.app.KKException
```
    Deletes the digital download passed in as a parameter
    
    Parameters:
    
    dd - the dd
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - validateDigitalDownload
```
protected Product validateDigitalDownload(int productId)
                                   throws java.lang.Exception
```
    Validate the digital download productId
    
    Parameters:
    
    productId - the productId
    
    Returns:
    
    the product if it's a digital download product or a gift certificate product otherwise an exception is thrown
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getPriceId
```
public int getPriceId(Customer customer)
```
    Get the priceId from the customer
    
    Specified by:
    
    getPriceId in interface ProductMgrIf
    
    Parameters:
    
    customer - the customer
    
    Returns:
    
    Returns the priceId
  - setProductPrice
```
protected void setProductPrice(Product prod,
                               int productPriceId)
                        throws com.konakart.app.KKException
```
    Edit the product to use the correct price based on the product price Id
    
    Parameters:
    
    prod - the prod
    
    productPriceId - the productPriceId
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - setOptionPrice
```
protected void setOptionPrice(Option opt,
                              Product prod,
                              int productId,
                              int productPriceId)
                       throws com.konakart.app.KKException,
                              org.apache.torque.TorqueException,
                              com.workingdogs.village.DataSetException
```
    Edit the product option to use the correct price based on the product price Id
    
    Parameters:
    
    opt - the opt
    
    prod - the prod
    
    productId - the productId
    
    productPriceId - the productPriceId
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - getBundleProductQuantityWithOptions
```
protected ProductQuantityIf getBundleProductQuantityWithOptions(Product product,
                                                                FetchProductOptionsIf options)
                                                         throws java.lang.Exception
```
    Get the quantity and date available of a bundle product. We don't require the options of a bundle product since these don't affect the products that are part of the bundle.
    
    Parameters:
    
    product - the product
    
    options - the options
    
    Returns:
    
    The quantity available of a bundle product
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getTagGroupsPerCategory
```
public TagGroup[] getTagGroupsPerCategory(int categoryId,
                                          boolean getProdCount,
                                          int languageId)
                                   throws java.lang.Exception
```
    Return an array of TagGroup objects for a category. Each TagGroup is populated with an array of Tags which are sorted first by sort order and then by name. An empty array is returned if no TagGroup objects exist.
    
    Specified by:
    
    getTagGroupsPerCategory in interface ProductMgrIf
    
    Parameters:
    
    categoryId - - If set to -1 then all tag groups are returned
    
    getProdCount - the getProdCount
    
    languageId - the languageId
    
    Returns:
    
    Returns an array of TagGroup objects
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getTagGroupsPerCategoryWithOptions
```
public TagGroup[] getTagGroupsPerCategoryWithOptions(int categoryId,
                                                     int languageId,
                                                     FetchTagGroupOptionsIf options)
                                              throws java.lang.Exception
```
    Return an array of TagGroup objects for a category. The options object allows you to define:
    - Whether to populate the tag groups with tags. When using Solr for faceted searching, this can be set to false since the tags aren't required
    - Whether to populate the Tag objects with the number of products count
    Specified by:
    
    getTagGroupsPerCategoryWithOptions in interface ProductMgrIf
    
    Parameters:
    
    categoryId - - If set to -1 then all tag groups are returned
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Returns an array of TagGroup objects
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getTagsPerCategory
```
public TagIf[] getTagsPerCategory(int categoryId,
                                  boolean getProdCount,
                                  int languageId)
                           throws java.lang.Exception
```
    Return an array of Tag objects for a category. An empty array is returned if no Tag objects exist. The Tags are sorted first by sort order and then by name.
    
    Specified by:
    
    getTagsPerCategory in interface ProductMgrIf
    
    Parameters:
    
    categoryId - - If set to -1 then all tags are returned
    
    getProdCount - the getProdCount
    
    languageId - the languageId
    
    Returns:
    
    Returns an array of Tag objects
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getTagGroup
```
public TagGroupIf getTagGroup(int tagGroupId,
                              boolean getProdCount,
                              int languageId)
                       throws java.lang.Exception
```
    Returns a TagGroup object for the id passed in as a parameter. The TagGroup is populated with an array of Tags which are sorted first by sort order and then by name. Null is returned if the TagGroup object doesn't exist.
    
    Specified by:
    
    getTagGroup in interface ProductMgrIf
    
    Parameters:
    
    tagGroupId - the tagGroupId
    
    getProdCount - the getProdCount
    
    languageId - the languageId
    
    Returns:
    
    Returns a TagGroup object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getTag
```
public TagIf getTag(int tagId,
                    boolean getProdCount,
                    int languageId)
             throws java.lang.Exception
```
    Returns a Tag object for the id passed in as a parameter.
    
    Specified by:
    
    getTag in interface ProductMgrIf
    
    Parameters:
    
    tagId - the tagId
    
    getProdCount - the getProdCount
    
    languageId - the languageId
    
    Returns:
    
    Returns a Tag object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getTagsPerTagGroup
```
protected TagIf[] getTagsPerTagGroup(int tagGroupId,
                                     boolean getProdCount,
                                     int languageId)
                              throws com.workingdogs.village.DataSetException,
                                     org.apache.torque.TorqueException,
                                     com.konakart.app.KKException
```
    Returns an array of Tags for a TagGroup
    
    Parameters:
    
    tagGroupId - - If set to -1 then all tags are returned
    
    getProdCount - the getProdCount
    
    languageId - the languageId
    
    Returns:
    
    Returns an array of Tags
    
    Throws:
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - synchronizeTagProductCount
```
protected void synchronizeTagProductCount()
                                   throws org.apache.torque.TorqueException,
                                          com.workingdogs.village.DataSetException,
                                          com.konakart.app.KKException
```
    We save the product count for each tag, in a hash table. The hash table is only ever cleared when we detect that a new mapping has been added or that an existing one has been deleted.
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - getLastAddedDateFromTagToProduct
```
protected java.util.Date getLastAddedDateFromTagToProduct()
                                                   throws com.workingdogs.village.DataSetException,
                                                          org.apache.torque.TorqueException,
                                                          com.konakart.app.KKException
```
    Get the last date added for a tag to product record
    
    Returns:
    
    Returns the last date added for a tag to product record
    
    Throws:
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - getTagToProductCount
```
protected int getTagToProductCount()
                            throws com.workingdogs.village.DataSetException,
                                   org.apache.torque.TorqueException,
                                   com.konakart.app.KKException
```
    Get the number of records in the tag to product table
    
    Returns:
    
    Returns the number of records in the tag to product tables
    
    Throws:
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - getProductCountForTag
```
protected void getProductCountForTag(TagIf tag)
                              throws com.workingdogs.village.DataSetException,
                                     org.apache.torque.TorqueException,
                                     com.konakart.app.KKException
```
    Get the number of products for a tag and add the number to the tag object
    
    Parameters:
    
    tag - the tag
    
    Throws:
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - setTagCriteriaWithStandardAttributes
```
protected void setTagCriteriaWithStandardAttributes(KKCriteria c,
                                                    int languageId)
```
    Set the Criteria attribute with standard attributes for a Tag object
    
    Parameters:
    
    c - the c
    
    languageId - the languageId
  - setTagGroupCriteriaWithStandardAttributes
```
protected void setTagGroupCriteriaWithStandardAttributes(KKCriteria c,
                                                         int languageId)
```
    Set the Criteria attribute with standard attributes for a TagGroup object
    
    Parameters:
    
    c - the c
    
    languageId - the languageId
  - getProductReorderLevel
```
public int getProductReorderLevel(int productId)
                           throws org.apache.torque.TorqueException,
                                  com.workingdogs.village.DataSetException,
                                  com.konakart.app.KKException
```
    Return the re-order level of the product.
    
    Specified by:
    
    getProductReorderLevel in interface ProductMgrIf
    
    Parameters:
    
    productId - the productId
    
    Returns:
    
    Returns the re-order level of the product.
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - doesProductExist
```
public boolean doesProductExist(int productId)
                         throws org.apache.torque.TorqueException,
                                com.workingdogs.village.DataSetException,
                                com.konakart.app.KKException
```
    Figure out whether a product exists
    
    Specified by:
    
    doesProductExist in interface ProductMgrIf
    
    Parameters:
    
    productId - the productId
    
    Returns:
    
    Returns true if the product exists
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
  - getPaymentScheduleId
```
public int getPaymentScheduleId(int productId)
                         throws org.apache.torque.TorqueException,
                                com.konakart.app.KKException,
                                com.workingdogs.village.DataSetException
```
    Description copied from interface: ProductMgrIf
    
    A utility method to return just the Payment Schedule Id from a product to determine whether it requires recurring billing.
    
    Specified by:
    
    getPaymentScheduleId in interface ProductMgrIf
    
    Parameters:
    
    productId - the productId
    
    Returns:
    
    Returns the PaymentSchedule Id
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - getProductPerSku
```
public Product getProductPerSku(java.lang.String sessionId,
                                java.lang.String sku,
                                int languageId)
                         throws java.lang.Exception
```
    Get a product from its SKU. If the SKU refers to a particular configuration of the product (i.e. Blue shirt, size small) then the product object is only populated with the options that match the SKU.
    
    Specified by:
    
    getProductPerSku in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    sku - the sku
    
    languageId - the languageId
    
    Returns:
    
    Return the product
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductPerSkuWithOptions
```
public Product getProductPerSkuWithOptions(java.lang.String sessionId,
                                           java.lang.String sku,
                                           int languageId,
                                           FetchProductOptionsIf options)
                                    throws java.lang.Exception
```
    Get a product from its SKU. If the SKU refers to a particular configuration of the product (i.e. Blue shirt, size small) then the product object is only populated with the options that match the SKU.
    
    Specified by:
    
    getProductPerSkuWithOptions in interface ProductMgrIf
    
    Parameters:
    
    sessionId - the sessionId
    
    sku - the sku
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Return the product
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - addProductsToStoresConstraint
```
protected void addProductsToStoresConstraint(KKCriteria c,
                                             org.apache.torque.map.ColumnMap cm)
                                      throws com.konakart.app.KKException
```
    If we're sharing products we need to add a constraint to the criteria object so that we only get records if there is a record for this product and storeId in the products_to_stores table.
    
    Parameters:
    
    c - the criteria that we will add our constraint to if necessary
    
    cm - the column used to join the products_to_stores products_id to
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - selectActiveProduct
```
protected int selectActiveProduct(java.lang.String sessionId,
                                  java.util.ArrayList<java.lang.Integer> productIdList,
                                  int languageId,
                                  FetchProductOptionsIf options)
                           throws java.lang.Exception
```
    For the case when multiple products exist for the same SKU, we give priority to products not disabled and not invisible
    
    Parameters:
    
    sessionId - the sessionId
    
    productIdList - List of product ids
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Returns the productId of the first product we find that isn't disabled or invisible. If all products are disabled or invisible we give priority to invisible (and not disabled).
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - doesExtQuantityExist
```
protected boolean doesExtQuantityExist(int productId,
                                       java.lang.String encodedOptionValues,
                                       java.lang.String catalogId,
                                       KKCriteria selectC)
                                throws org.apache.torque.TorqueException
```
    Returns true if the external quantity record exists
    
    Parameters:
    
    productId - the productId
    
    encodedOptionValues - the encodedOptionValues
    
    catalogId - the catalogId
    
    selectC - the selectC
    
    Returns:
    
    Return true if the external quantity record exists
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
  - insertExtQuantity
```
protected void insertExtQuantity(int productId,
                                 java.lang.String encodedOptionValues,
                                 int quantity,
                                 java.lang.String catalogId,
                                 KKCriteria insertC)
                          throws org.apache.torque.TorqueException
```
    Used to insert a quantity in the external quantity table.
    
    Parameters:
    
    productId - the productId
    
    encodedOptionValues - the encodedOptionValues
    
    quantity - the quantity
    
    catalogId - the catalogId
    
    insertC - the insertC
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
  - editExtQuantity
```
protected void editExtQuantity(int productId,
                               java.lang.String encodedOptionValues,
                               int quantity,
                               java.lang.String catalogId,
                               KKCriteria selectC,
                               KKCriteria updateC)
                        throws org.apache.torque.TorqueException
```
    Used to edit a quantity in the external quantity table.
    
    Parameters:
    
    productId - the productId
    
    encodedOptionValues - the encodedOptionValues
    
    quantity - the quantity
    
    catalogId - the catalogId
    
    selectC - the selectC
    
    updateC - the updateC
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
  - getAddressesPerProduct
```
public Address[] getAddressesPerProduct(int productId)
                                 throws java.lang.Exception
```
    Returns all of the addresses for the given product.
    
    Specified by:
    
    getAddressesPerProduct in interface ProductMgrIf
    
    Parameters:
    
    productId - the productId
    
    Returns:
    
    An array of address objects ordered by primary address(es) first
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - refreshConfigs
```
public void refreshConfigs()
                    throws java.lang.Exception
```
    Refresh the configuration of the product manager
    
    Specified by:
    
    refreshConfigs in interface ProductMgrIf
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getXMLFromCustomAttrs
```
public java.lang.String getXMLFromCustomAttrs(ProdCustAttrIf[] attrDescArray)
```
    Create an XML structure for the custom attributes
    
    Specified by:
    
    getXMLFromCustomAttrs in interface ProductMgrIf
    
    Parameters:
    
    attrDescArray - Array of custom attributes
    
    Returns:
    
    Returns an XML structure
  - getCustomAttrsFromXML
```
public ProdCustAttr[] getCustomAttrsFromXML(java.lang.String xml)
```
    Create an array of custom attributes from the XML
    
    Specified by:
    
    getCustomAttrsFromXML in interface ProductMgrIf
    
    Parameters:
    
    xml - The custom attribute data in xml format
    
    Returns:
    
    Returns an array of ProdCustAttr objects
  - sendQuery
```
protected java.util.List<com.workingdogs.village.Record> sendQuery(java.lang.String sessionId,
                                                                   java.lang.String apiCall,
                                                                   KKCriteria crit,
                                                                   DataDescriptorIf dataDesc,
                                                                   ProductSearchIf prodSearch,
                                                                   int languageId,
                                                                   boolean fixQuery,
                                                                   FetchProductOptionsIf options)
                                                            throws java.lang.Exception
```
    Common code to send a query string
    
    Parameters:
    
    sessionId - the sessionId
    
    apiCall - the apiCall
    
    crit - the crit
    
    dataDesc - the dataDesc
    
    prodSearch - the prodSearch
    
    fixQuery - the fixQuery
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Returns a list of Record objects
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - beforeSendQuery
```
protected java.lang.String beforeSendQuery(java.lang.String sessionId,
                                           java.lang.String apiCall,
                                           java.lang.String queryString,
                                           DataDescriptorIf dataDesc,
                                           ProductSearchIf prodSearch,
                                           int languageId,
                                           FetchProductOptionsIf options)
                                    throws java.lang.Exception
```
    Method that can be used to customize the query string before being sent to the database.
    
    Parameters:
    
    sessionId - The sessionId of the logged in user
    
    apiCall - Name of the Api call sending the query
    
    queryString - Query string that will be sent to the database
    
    dataDesc - DataDescriptor object
    
    prodSearch - ProductSearch object which may be null
    
    languageId - Language id
    
    options - the options
    
    Returns:
    
    Returns the customized query string
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - beforeSendCriteria
```
protected KKCriteria beforeSendCriteria(java.lang.String sessionId,
                                        java.lang.String apiCall,
                                        KKCriteria criteria,
                                        DataDescriptorIf dataDesc,
                                        ProductSearchIf prodSearch,
                                        int languageId,
                                        FetchProductOptionsIf options)
                                 throws java.lang.Exception
```
    Method that can be used to customize the KKCriteria object before it is used to create the query string that is sent to the database.
    
    Parameters:
    
    sessionId - The sessionId of the logged in user
    
    apiCall - Name of the Api call sending the query
    
    criteria - KKCriteria object that will be used to create the query string
    
    dataDesc - DataDescriptor object
    
    prodSearch - ProductSearch object which may be null
    
    languageId - Language id
    
    options - the options
    
    Returns:
    
    Returns the customized Torque Criteria
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - isCustomAttrAnOracleCLOB
```
public static boolean isCustomAttrAnOracleCLOB()
```
    Is the custom_attrs column is an Oracle CLOB? We only check once and save the result in a static variable.
    
    Returns:
    
    the customAttrAnOracleCLOB
  - updateProductReviewInfo
```
public void updateProductReviewInfo(int productId)
                             throws java.lang.Exception
```
    The product referenced by the productId parameter is updated with information regarding the average rating and the number of reviews present for the product.
    
    Specified by:
    
    updateProductReviewInfo in interface ProductMgrIf
    
    Parameters:
    
    productId - the productId
    
    Throws:
    
    java.lang.Exception - an unexpected 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
    
    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.
  - getProductViewCountMaxRetries
```
public int getProductViewCountMaxRetries()
```
    Specified by:
    
    getProductViewCountMaxRetries in interface ProductMgrIf
    
    Returns:
    
    Returns the maximum number of optimistic concurrency retries when setting the product viewed count
  - setProductViewCountMaxRetries
```
public void setProductViewCountMaxRetries(int productViewCountMaxRetries)
```
    The maximum number of optimistic concurrency retries when setting the product viewed count
    
    Specified by:
    
    setProductViewCountMaxRetries in interface ProductMgrIf
    
    Parameters:
    
    productViewCountMaxRetries - the productViewCountMaxRetries
  - 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 .
    
    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 .
    
    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 .
    
    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 .
    
    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 .
    
    Parameters:
    
    c - the c
    
    productId - the productId
    
    options - the options
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - setStockReservationCriteriaOnProduct
```
protected void setStockReservationCriteriaOnProduct(KKCriteria c,
                                                    FetchProductOptionsIf options)
                                             throws com.konakart.app.KKException
```
    Add criteria for getting stock reservation information .
    
    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 .
    
    Parameters:
    
    c - the c
    
    productId - the productId
    
    options - the options
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - reserveStock
```
public Basket[] reserveStock(java.lang.String sessionId,
                             BasketIf[] basketItems,
                             StockReservationOptionsIf stockReservationOptions)
                      throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    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
    
    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
  - cacheThisProduct
```
public boolean cacheThisProduct(Product product)
                         throws com.konakart.app.KKException
```
    Description copied from interface: ProductMgrIf
    
    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
    
    Parameters:
    
    product - the product to be considered for caching
    
    Returns:
    
    true if the product should be cached otherwise false
    
    Throws:
    
    com.konakart.app.KKException - in unexpected circumstances
  - removeStockReservationsForBasketItems
```
public int removeStockReservationsForBasketItems(java.lang.String sessionId,
                                                 BasketIf[] basketItems,
                                                 StockReservationOptionsIf options)
                                          throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    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
    
    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
```
    Description copied from interface: ProductMgrIf
    
    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
    
    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
```
    Description copied from interface: ProductMgrIf
    
    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
    
    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
```
    Description copied from interface: ProductMgrIf
    
    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
    
    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
```
    Description copied from interface: ProductMgrIf
    
    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
    
    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
```
    Description copied from interface: ProductMgrIf
    
    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
    
    Parameters:
    
    customerId - the customerId
    
    idArray - the idArray
    
    options - the options
    
    Returns:
    
    Returns the number of reservations removed
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getCatalogPerKey
```
public Catalog getCatalogPerKey(java.lang.String catalogKey)
                         throws java.lang.Exception
```
    Description copied from interface: ProductMgrIf
    
    Returns a catalog object for the catalog key.
    
    Specified by:
    
    getCatalogPerKey in interface ProductMgrIf
    
    Parameters:
    
    catalogKey - the catalogKey
    
    Returns:
    
    Returns a catalog object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - isEnhancedVariantHandlingModeEnabled
```
protected boolean isEnhancedVariantHandlingModeEnabled()
                                                throws com.konakart.app.KKException
```
    Check in the static data if enhanced variant handling mode is enabled.
    
    Returns:
    
    true if is enabled
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - getVariantPricesPerProductWithOptions
```
protected VariantPriceIf[] getVariantPricesPerProductWithOptions(int productId,
                                                                 FetchProductOptionsIf options,
                                                                 java.util.HashMap<java.lang.String,Option> optionMap)
                                                          throws org.apache.torque.TorqueException,
                                                                 com.workingdogs.village.DataSetException,
                                                                 com.konakart.app.KKException
```
    Return all of the variant prices associated with a product
    
    Parameters:
    
    productId - the productId
    
    options - the options
    
    optionMap - the optionMap
    
    Returns:
    
    Returns a VariantPriceIf[]
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException 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 .
    
    Parameters:
    
    c - the c
    
    productId - the productId
    
    options - the options
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - getVariantPrices
```
protected VariantPriceIf[] getVariantPrices(Product prod,
                                            int productPriceId,
                                            FetchProductOptionsIf options)
                                     throws org.apache.torque.TorqueException,
                                            com.konakart.app.KKException,
                                            com.workingdogs.village.DataSetException
```
    Return the An array of VariantPrice objects (or null) for the product referenced by productId
    
    Parameters:
    
    prod - the prod
    
    productPriceId - the productPriceId
    
    options - the options
    
    Returns:
    
    Returns an array of VariantPrice objects
    
    Throws:
    
    org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)
    
    com.konakart.app.KKException - an unexpected KKException exception
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
  - 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
    
    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
    
    Parameters:
    
    productIds - List with acutaly Locked Products
    
    Returns:
    
    Returns status
    
    Throws:
    
    java.lang.Exception - an unexpected KKException exception

Class ProductMgr

Nested Class Summary

Field Summary

Fields inherited from class com.konakart.bl.BaseMgr

Constructor Summary

Method Summary

Methods inherited from class com.konakart.bl.BaseMgr

Methods inherited from class java.lang.Object

Field Detail

log

DONT_INCLUDE

ALL_RELATIONSHIPS

UP_SELL

CROSS_SELL

ACCESSORY

DEPENDENT_ITEM

BUNDLED_PRODUCT_RELATIONSHIP

CUSTOM_RELATIONSHIP_1

CUSTOM_RELATIONSHIP_2

CUSTOM_RELATIONSHIP_3

CUSTOM_RELATIONSHIP_4

CUSTOM_RELATIONSHIP_5

PHYSICAL_PRODUCT

DIGITAL_DOWNLOAD

FREE_SHIPPING

BUNDLE_PRODUCT_TYPE

FREE_SHIPPING_BUNDLE_PRODUCT_TYPE

GIFT_CERTIFICATE_PRODUCT_TYPE

BOOKABLE_PRODUCT_TYPE

VIRTUAL_PRODUCT_TYPE

staticDataHM

customAttrAnOracleCLOB

productViewCountMaxRetries

updateStockMutex

reserveStockMutex

prodViewMutex

tagMutex

prodMgrMutex

Constructor Detail

ProductMgr

Method Detail

getProductsPerCategory

getProductsPerCategoryWithOptions

getProductsPerCategoryPerManufacturer

getProductsPerCategoryPerManufacturerWithOptions

getAllProducts

getAllProductsWithOptions

getProductsPerManufacturer

getProductsPerManufacturerWithOptions

getProductsAllCases

getTaxClassId

getProduct

getProductWithOptions

getProduct

getProductWithOptions

getProductWithOptions

getProductWithOptions

getProductOptions

getTagsPerProduct

updateProductViewedCount

getAllSpecials

getSpecialsPerCategory

addTax

addTax

getProductsFromIds

getProductsFromIdsWithOptions

getProductsFromIdsWithOptions

searchForProducts

searchForProductsWithOptions

useSpecialPrice

fetchDescriptionsSeparately

searchForProductsPrivate

getCustomAttrs

doTierPricesExist

getTierPrices

setCriteriaWithStandardAttributes

setCriteriaWithStandardAttributes

setProductsSharedCriteria

manageDataDescriptor

manageDataDescriptor