ProductMgrIf (KonaKart Server Engine API Documentation)

All Known Implementing Classes:

ProductMgr, ProductMgrEE, ProductMgrWond
```
public interface ProductMgrIf
```
ProductMgrIf Interface which an implementation of this manager must adhere to.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`cacheThisProduct(Product product)` Should this particular product be cached? The default implementation returns false for null products and Bundle products (according to the setting of the configuration value) and simply returns true for every other product.
`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_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.
`boolean`	`doesProductExist(int productId)` Figure out whether a product exists
`void`	`editDigitalDownload(DigitalDownloadIf digitalDownload)` Edits the digital download object.
`void`	`editDigitalDownload(java.lang.String sessionId, DigitalDownloadIf digitalDownload)` Edits the digital download object and checks that it belongs to the customer identified by the sessionId.
`Address[]`	`getAddressesPerProduct(int productId)` Gets an array of Address objects that have been defined for the product referenced by the productId.
`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)` Returns an array of bestseller products for the category and its children.
`Product[]`	`getBestSellersWithOptions(DataDescriptorIf dataDesc, int categoryId, int languageId, FetchProductOptionsIf options)` Returns an array of bestseller products for the category and its children.
`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.
`ProdCustAttr[]`	`getCustomAttrsFromXML(java.lang.String xml)` Create an array of custom attributes from the XML
`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.
`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 cust)` 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.
`ProductImages`	`getProductImages(ProductImagesOptionsIf options)` Get the image file names associated with the product whose id is specified.
`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.
`ProductQuantityIf`	`getProductQuantity(java.lang.String encodedProductId)` The stock level and date available of the product is returned.
`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.
`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.
`int`	`getProductViewCountMaxRetries()`
`Product`	`getProductWithOptions(int customerId, int productId, int languageId, FetchProductOptionsIf options)` Fetches a fully populated product object for a customer referenced by customerId.
`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.
`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.
`java.lang.String`	`getSku(OrderProductIf orderProd)` Get the SKU for an orderProduct object.
`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.
`int`	`getTaxClassId(int productId)` Returns the tax class id for 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.
`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.
`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.
`Products`	`searchForProductsWithOptions(java.lang.String sessionId, DataDescriptorIf dataDesc, ProductSearchIf prodSearch, int languageId, FetchProductOptionsIf options)` Returns products matching the search criteria.
`void`	`setProductViewCountMaxRetries(int productViewCountMaxRetries)` The maximum number of optimistic concurrency retries when setting the product viewed count
`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. It's normally called after a review is inserted.
`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.

- Method Detail
  - getProductsPerCategory
```
Products getProductsPerCategory(java.lang.String sessionId,
                                DataDescriptorIf dataDesc,
                                int categoryId,
                                boolean searchInSubCats,
                                int languageId)
                         throws java.lang.Exception
```
    Returns the products for a category
    
    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
```
Products getProductsPerCategoryWithOptions(java.lang.String sessionId,
                                           DataDescriptorIf dataDesc,
                                           int categoryId,
                                           boolean searchInSubCats,
                                           int languageId,
                                           FetchProductOptionsIf options)
                                    throws java.lang.Exception
```
    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.
    
    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
```
Products getProductsPerCategoryPerManufacturer(java.lang.String sessionId,
                                               DataDescriptorIf dataDesc,
                                               int categoryId,
                                               int manufacturerId,
                                               int languageId)
                                        throws java.lang.Exception
```
    Returns the products for a category and a manufacturer
    
    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
```
Products getProductsPerCategoryPerManufacturerWithOptions(java.lang.String sessionId,
                                                          DataDescriptorIf dataDesc,
                                                          int categoryId,
                                                          int manufacturerId,
                                                          int languageId,
                                                          FetchProductOptionsIf options)
                                                   throws java.lang.Exception
```
    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.
    
    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
```
Products getAllProducts(java.lang.String sessionId,
                        DataDescriptorIf dataDesc,
                        int languageId)
                 throws java.lang.Exception
```
    Returns all products
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    languageId - the languageId
    
    Returns:
    
    Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAllProductsWithOptions
```
Products getAllProductsWithOptions(java.lang.String sessionId,
                                   DataDescriptorIf dataDesc,
                                   int languageId,
                                   FetchProductOptionsIf options)
                            throws java.lang.Exception
```
    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.
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductsPerManufacturer
```
Products getProductsPerManufacturer(java.lang.String sessionId,
                                    DataDescriptorIf dataDesc,
                                    int manufacturerId,
                                    int languageId)
                             throws java.lang.Exception
```
    Returns the products for a manufacturer
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    manufacturerId - the manufacturerId
    
    languageId - the languageId
    
    Returns:
    
    Products object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductsPerManufacturerWithOptions
```
Products getProductsPerManufacturerWithOptions(java.lang.String sessionId,
                                               DataDescriptorIf dataDesc,
                                               int manufacturerId,
                                               int languageId,
                                               FetchProductOptionsIf options)
                                        throws java.lang.Exception
```
    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.
    
    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
  - getTaxClassId
```
int getTaxClassId(int productId)
           throws org.apache.torque.TorqueException,
                  com.konakart.app.KKException,
                  com.workingdogs.village.DataSetException
```
    Returns the tax class id for a product
    
    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
```
Product getProduct(java.lang.String sessionId,
                   int productId,
                   int languageId)
            throws java.lang.Exception
```
    Fetches a fully populated product object. If there is a valid sessionId, the prices are calculated for the logged in customer.
    
    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
```
Product getProductWithOptions(java.lang.String sessionId,
                              int productId,
                              int languageId,
                              FetchProductOptionsIf options)
                       throws java.lang.Exception
```
    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.
    
    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
```
Product getProduct(int customerId,
                   int productId,
                   int languageId)
            throws java.lang.Exception
```
    Fetches a fully populated product object for a customer referenced by customerId.
    
    Parameters:
    
    customerId - the customerId
    
    productId - the productId
    
    languageId - the languageId
    
    Returns:
    
    Returns a product object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductWithOptions
```
Product getProductWithOptions(int customerId,
                              int productId,
                              int languageId,
                              FetchProductOptionsIf options)
                       throws java.lang.Exception
```
    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.
    
    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
  - updateProductViewedCount
```
void updateProductViewedCount(int productId,
                              int languageId)
                       throws java.lang.Exception
```
    Increments the viewed count for the product.
    
    Parameters:
    
    productId - the productId
    
    languageId - the languageId
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAllSpecials
```
Products getAllSpecials(java.lang.String sessionId,
                        DataDescriptorIf dataDesc,
                        int languageId)
                 throws java.lang.Exception
```
    Returns all special priced products
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    languageId - the languageId
    
    Returns:
    
    Array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getSpecialsPerCategory
```
Products getSpecialsPerCategory(java.lang.String sessionId,
                                DataDescriptorIf dataDescriptor,
                                int categoryId,
                                boolean searchInSubCats,
                                int languageId)
                         throws java.lang.Exception
```
    Returns all special priced products for a category
    
    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
  - getProductsFromIds
```
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.
    
    Parameters:
    
    sessionId - the sessionId
    
    prodIdList - the prodIdList
    
    languageId - the languageId
    
    Returns:
    
    An array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductsFromIdsWithOptions
```
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. An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    
    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
```
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. An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    
    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
```
Products searchForProducts(java.lang.String sessionId,
                           DataDescriptorIf dataDesc,
                           ProductSearchIf prodSearch,
                           int languageId)
                    throws java.lang.Exception
```
    Returns products matching the search criteria.
    
    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
```
Products searchForProductsWithOptions(java.lang.String sessionId,
                                      DataDescriptorIf dataDesc,
                                      ProductSearchIf prodSearch,
                                      int languageId,
                                      FetchProductOptionsIf options)
                               throws java.lang.Exception
```
    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.
    
    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
  - getOption
```
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.
    
    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
  - getBestSellers
```
Product[] getBestSellers(DataDescriptorIf dataDesc,
                         int categoryId,
                         int languageId)
                  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.
    
    Parameters:
    
    dataDesc - the dataDesc
    
    categoryId - the categoryId
    
    languageId - the languageId
    
    Returns:
    
    An array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getBestSellersWithOptions
```
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. An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    
    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
  - getOrderHistory
```
Product[] getOrderHistory(DataDescriptorIf dataDesc,
                          java.lang.String sessionId,
                          int languageId)
                   throws java.lang.Exception
```
    Get a list of the products ordered by the customer referenced by the sessionId.
    
    Parameters:
    
    dataDesc - the dataDesc
    
    sessionId - the sessionId
    
    languageId - the languageId
    
    Returns:
    
    Returns a list of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getOrderHistoryWithOptions
```
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. An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    
    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
  - getAlsoPurchased
```
Product[] getAlsoPurchased(java.lang.String sessionId,
                           DataDescriptorIf dataDesc,
                           int productId,
                           int languageId)
                    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.
    
    Parameters:
    
    sessionId - the sessionId
    
    dataDesc - the dataDesc
    
    productId - the productId
    
    languageId - the languageId
    
    Returns:
    
    Array of products
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getAlsoPurchasedWithOptions
```
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. An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    
    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
  - getRelatedProducts
```
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.
    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
```
Products getRelatedProductsWithOptions(java.lang.String sessionId,
                                       DataDescriptorIf dataDesc,
                                       int productId,
                                       int relationType,
                                       int languageId,
                                       FetchProductOptionsIf options)
                                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.
    An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    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
  - getSku
```
java.lang.String getSku(OrderProductIf orderProd)
                 throws com.konakart.app.KKException,
                        org.apache.torque.TorqueException,
                        com.workingdogs.village.DataSetException
```
    Get the SKU for an orderProduct object. If it has no options we look directly for the SKU in the product table. Otherwise we look in the productQuantities table. If we can't find it there, then we look in the product table.
    
    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)
  - updateProductQuantity
```
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.
    
    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
```
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.
    
    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
```
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. An options object is passed in to customize where the quantity is stored. This could be in an external table.
    
    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
  - getProductQuantity
```
ProductQuantityIf getProductQuantity(java.lang.String encodedProductId)
                              throws java.lang.Exception
```
    The stock level and date available 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.
    
    Parameters:
    
    encodedProductId - the encodedProductId
    
    Returns:
    
    Product Quantity object containing the Stock level and available date
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - insertDigitalDownload
```
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.
    
    Parameters:
    
    sessionId - the sessionId
    
    productId - the productId
    
    Returns:
    
    Returns the id of the inserted Digital Download
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - insertDigitalDownload
```
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.
    
    Parameters:
    
    customerId - the customerId
    
    productId - the productId
    
    Returns:
    
    Returns the id of the inserted Digital Download
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getDigitalDownloads
```
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. Regardless of the setting of DD_DELETE_ON_EXPIRATION, only valid (not expired) objects are ever returned.
    
    Parameters:
    
    sessionId - the sessionId
    
    Returns:
    
    Returns an array of DigitalDownload objects
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getDigitalDownloadsWithOptions
```
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. Regardless of the setting of DD_DELETE_ON_EXPIRATION, only valid (not expired) objects are ever returned.
    
    Parameters:
    
    sessionId - the sessionId
    
    languageId - the languageId
    
    ddOptions - Options object that allows you to define whether the product attribute of the returned Digital Download objects is populated
    
    prodOptions - the prodOptions
    
    Returns:
    
    Returns an array of DigitalDownload objects
    
    Throws:
    
    java.lang.Exception - an unexpected exception
    
    com.konakart.app.KKException - an unexpected KKException exception
  - updateDigitalDownloadCount
```
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.
    
    Parameters:
    
    sessionId - the sessionId
    
    productId - the productId
    
    Returns:
    
    Returns the new count
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - updateDigitalDownloadCountById
```
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
    
    Parameters:
    
    sessionId - the sessionId
    
    digitalDownloadId - the digitalDownloadId
    
    Returns:
    
    Returns the new count
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getPriceId
```
int getPriceId(Customer cust)
```
    Get the priceId from the customer
    
    Parameters:
    
    cust - the cust
    
    Returns:
    
    Returns the priceId
  - getTagGroupsPerCategory
```
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.
    
    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
```
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
    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
```
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.
    
    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
```
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.
    
    Parameters:
    
    tagGroupId - the tagGroupId
    
    getProdCount - the getProdCount
    
    languageId - the languageId
    
    Returns:
    
    Returns a TagGroup object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getTag
```
TagIf getTag(int tagId,
             boolean getProdCount,
             int languageId)
      throws java.lang.Exception
```
    Returns a Tag object for the id passed in as a parameter.
    
    Parameters:
    
    tagId - the tagId
    
    getProdCount - the getProdCount
    
    languageId - the languageId
    
    Returns:
    
    Returns a Tag object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - createEncodedProductIdFromProductQuantityEncodedKey
```
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.
    
    Parameters:
    
    productId - the productId
    
    productQuantityEncodedKey - the productQuantityEncodedKey
    
    Returns:
    
    Returns the encoded productId
  - createProductQuantityEncodedKeyFromEncodedProductId
```
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.
    
    Parameters:
    
    encodedProductId - the encodedProductId
    
    Returns:
    
    Returns the encoded key for the products_quantity table
    
    Throws:
    
    com.konakart.app.KKException - an unexpected KKException exception
  - createProductQuantityEncodedKeyFromOptions
```
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_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.
    
    Parameters:
    
    opts - the opts
    
    Returns:
    
    Returns the encoded key for the products_quantity table
  - getProductReorderLevel
```
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.
    
    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
  - getProductQuantityWithOptions
```
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. An options object is passed in to customize from where some of the product attributes (such as price and quantity) are fetched from.
    
    Parameters:
    
    encodedProductId - the encodedProductId
    
    options - the options
    
    Returns:
    
    Stock level
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - doesProductExist
```
boolean doesProductExist(int productId)
                  throws org.apache.torque.TorqueException,
                         com.workingdogs.village.DataSetException,
                         com.konakart.app.KKException
```
    Figure out whether a product exists
    
    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
  - insertGiftCertificateDigitalDownload
```
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.
    
    Parameters:
    
    customerId - the customerId
    
    productId - the productId
    
    filePath - the filePath
    
    Returns:
    
    Returns the key of the inserted Digital Download
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getPaymentScheduleId
```
int getPaymentScheduleId(int productId)
                  throws org.apache.torque.TorqueException,
                         com.konakart.app.KKException,
                         com.workingdogs.village.DataSetException
```
    A utility method to return just the Payment Schedule Id from a product to determine whether it requires recurring billing.
    
    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)
  - getProductPerSkuWithOptions
```
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.
    
    Parameters:
    
    sessionId - the sessionId
    
    sku - the sku
    
    languageId - the languageId
    
    options - the options
    
    Returns:
    
    Return the product
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductPerSku
```
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.
    
    Parameters:
    
    sessionId - the sessionId
    
    sku - the sku
    
    languageId - the languageId
    
    Returns:
    
    Return the product
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - editDigitalDownload
```
void editDigitalDownload(java.lang.String sessionId,
                         DigitalDownloadIf digitalDownload)
                  throws java.lang.Exception
```
    Edits the digital download object and checks that it belongs to the customer identified by the sessionId.
    
    Parameters:
    
    sessionId - the sessionId
    
    digitalDownload - the digitalDownload
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - editDigitalDownload
```
void editDigitalDownload(DigitalDownloadIf digitalDownload)
                  throws com.konakart.app.KKException,
                         org.apache.torque.TorqueException,
                         com.workingdogs.village.DataSetException
```
    Edits the digital download object.
    
    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)
  - getDigitalDownloadById
```
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. A check is made to verify that the digital download object belongs to the customer identified by the sessionId.
    
    Parameters:
    
    sessionId - the sessionId
    
    digitalDownloadId - the digitalDownloadId
    
    Returns:
    
    Returns a DigitalDownload object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getDigitalDownloadById
```
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.
    
    Parameters:
    
    digitalDownloadId - the digitalDownloadId
    
    Returns:
    
    Returns a 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)
  - getAddressesPerProduct
```
Address[] getAddressesPerProduct(int productId)
                          throws java.lang.Exception
```
    Gets an array of Address objects that have been defined for the product referenced by the productId. The primary address(es) are first in the list.
    
    Parameters:
    
    productId - the productId
    
    Returns:
    
    Returns an array of Address objects
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - refreshConfigs
```
void refreshConfigs()
             throws java.lang.Exception
```
    Refresh the configuration of the product manager
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - createOptionsFromProductQuantityEncodedKey
```
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.
    
    Parameters:
    
    encodedKey - the encodedKey
    
    Returns:
    
    Return an array of Option objects
  - updateProductReviewInfo
```
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.
    It's normally called after a review is inserted.
    
    Parameters:
    
    productId - the productId
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getBundlesThatProductBelongsTo
```
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.).
    
    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
```
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.).
    
    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
  - getProductImages
```
ProductImages getProductImages(ProductImagesOptionsIf options)
                        throws com.konakart.app.KKException
```
    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.
    
    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.
  - updateProductsOrdered
```
void updateProductsOrdered(OrderIf order)
                    throws java.lang.Exception
```
    Update the products ordered count for the products sold in an order
    
    Parameters:
    
    order - the order
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - cacheThisProduct
```
boolean cacheThisProduct(Product product)
                  throws com.konakart.app.KKException
```
    Should this particular product be cached? The default implementation returns false for null products and Bundle products (according to the setting of the configuration value) and simply returns true for every other product. The idea of this interface is that it is provided to be overridden so that you can choose not to cache certain products.
    Only relevant in the Enterprise version.
    
    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
```
int removeStockReservationsForBasketItems(java.lang.String sessionId,
                                          BasketIf[] basketItems,
                                          StockReservationOptionsIf options)
                                   throws java.lang.Exception
```
    This API call is used to remove stock reservations. The reservation ids are retrieved from the array of basket items passed in as a parameter. The code checks that the reservations belong to the customer referenced by the session id.
    
    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
```
int removeStockReservationsForBasketItems(int customerId,
                                          BasketIf[] basketItems,
                                          StockReservationOptionsIf options)
                                   throws java.lang.Exception
```
    This API call is used to remove stock reservations. The reservation ids are retrieved from the array of basket items passed in as a parameter. The code checks that the reservations belong to the customer referenced by the session id.
    
    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
```
int removeStockReservationsForOrderProducts(java.lang.String sessionId,
                                            OrderProductIf[] orderProducts,
                                            StockReservationOptionsIf options)
                                     throws java.lang.Exception
```
    This API call is used to remove stock reservations. The reservation ids are retrieved from the array of order products passed in as a parameter. The code checks that the reservations belong to the customer referenced by the session id.
    
    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
```
int removeStockReservationsForOrderProducts(int customerId,
                                            OrderProductIf[] orderProducts,
                                            StockReservationOptionsIf options)
                                     throws java.lang.Exception
```
    This API call is used to remove stock reservations. The reservation ids are retrieved from the array of order products passed in as a parameter. The code checks that the reservations belong to the customer referenced by the session id.
    
    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
```
int removeStockReservationsForIds(java.lang.String sessionId,
                                  int[] idArray,
                                  StockReservationOptionsIf options)
                           throws java.lang.Exception
```
    This API call is used to remove stock reservations. The reservation ids are retrieved from the array of ids passed in as a parameter. The code checks that the reservations belong to the customer referenced by the session id.
    
    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
```
int removeStockReservationsForIds(int customerId,
                                  int[] idArray,
                                  StockReservationOptionsIf options)
                           throws java.lang.Exception
```
    This API call is used to remove stock reservations. The reservation ids are retrieved from the array of ids passed in as a parameter. The code checks that the reservations belong to the customer referenced by the session id.
    
    Parameters:
    
    customerId - the customerId
    
    idArray - the idArray
    
    options - the options
    
    Returns:
    
    Returns the number of reservations removed
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - reserveStock
```
Basket[] reserveStock(java.lang.String sessionId,
                      BasketIf[] basketItems,
                      StockReservationOptionsIf stockReservationOptions)
               throws java.lang.Exception
```
    The purpose of this API call is to reserve stock in order to give a customer enough time to checkout without risking that the products being ordered become unavailable while checking out.
    The options allow you to:
    - Define the number of seconds the reservation is active for. The default is set to -1 which means that the value defined in the global configuration variable is used. A batch job should be scheduled to run at regular intervals to remove expired reservations.
    - Define whether you want to allow a partial reservation for a product if the number of items available is less than the number required. The default behavior is to not allow partial reservations.
    - Define a maximum number of reservations per customer for any one product. This is a defensive measure to prevent a customer from abandoning multiple checkouts or a (single checkout with a high quantity number) and so reserving products and preventing other customers from buying them.
    If a reservation already exists, it is deleted and a new one is inserted. The Basket items returned, as well as having the reservation information populated, also have populated the quantityInStock attribute. The reservation information is also persisted in the database.
    If any of the Basket items contain products or product variations no longer in the catalog then they are not included in the return array.
    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
  - getCatalogPerKey
```
Catalog getCatalogPerKey(java.lang.String catalogKey)
                  throws java.lang.Exception
```
    Returns a catalog object for the catalog key.
    
    Parameters:
    
    catalogKey - the catalogKey
    
    Returns:
    
    Returns a catalog object
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - getProductViewCountMaxRetries
```
int getProductViewCountMaxRetries()
```
    Returns:
    
    Returns the maximum number of optimistic concurrency retries when setting the product viewed count
  - setProductViewCountMaxRetries
```
void setProductViewCountMaxRetries(int productViewCountMaxRetries)
```
    The maximum number of optimistic concurrency retries when setting the product viewed count
    
    Parameters:
    
    productViewCountMaxRetries - the productViewCountMaxRetries
  - getCustomAttrsFromXML
```
ProdCustAttr[] getCustomAttrsFromXML(java.lang.String xml)
```
    Create an array of custom attributes from the XML
    
    Parameters:
    
    xml - The custom attribute data in xml format
    
    Returns:
    
    Returns an array of ProdCustAttr objects
  - getXMLFromCustomAttrs
```
java.lang.String getXMLFromCustomAttrs(ProdCustAttrIf[] attrDescArray)
```
    Create an XML structure for the custom attributes
    
    Parameters:
    
    attrDescArray - Array of custom attributes
    
    Returns:
    
    Returns an XML structure
  - getAllProductRelationships
```
ProductRelationship[] getAllProductRelationships()
                                          throws java.lang.Exception
```
    Returns all product relationships in a single call.
    
    Returns:
    
    Returns an array of ProductRelationship objects
    
    Throws:
    
    java.lang.Exception - an unexpected exception
  - updateProductLockItems
```
int updateProductLockItems(java.lang.String productId,
                           java.lang.String shopIds)
                    throws java.lang.Exception
```
    Lockes a Product for all shops in the ;-separated shopIds
    
    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
```
int updateProductNotLockedItems(java.lang.String[] productIds)
                         throws java.lang.Exception
```
    Resets all Locked Products which are not in the List productIds
    
    Parameters:
    
    productIds - List with acutaly Locked Products
    
    Returns:
    
    Returns status
    
    Throws:
    
    java.lang.Exception - an unexpected KKException exception

Interface ProductMgrIf

Method Summary

Method Detail

getProductsPerCategory

getProductsPerCategoryWithOptions

getProductsPerCategoryPerManufacturer

getProductsPerCategoryPerManufacturerWithOptions

getAllProducts

getAllProductsWithOptions

getProductsPerManufacturer

getProductsPerManufacturerWithOptions

getTaxClassId

getProduct

getProductWithOptions

getProduct

getProductWithOptions

updateProductViewedCount

getAllSpecials

getSpecialsPerCategory

getProductsFromIds

getProductsFromIdsWithOptions

getProductsFromIdsWithOptions

searchForProducts

searchForProductsWithOptions

getOption

getBestSellers

getBestSellersWithOptions

getOrderHistory

getOrderHistoryWithOptions

getAlsoPurchased

getAlsoPurchasedWithOptions

getRelatedProducts

getRelatedProductsWithOptions

getSku

updateProductQuantity

updateProductQuantity

updateProductQuantityWithOptions

getProductQuantity

insertDigitalDownload

insertDigitalDownload

getDigitalDownloads

getDigitalDownloadsWithOptions

updateDigitalDownloadCount

updateDigitalDownloadCountById

getPriceId

getTagGroupsPerCategory

getTagGroupsPerCategoryWithOptions

getTagsPerCategory

getTagGroup

getTag

createEncodedProductIdFromProductQuantityEncodedKey

createProductQuantityEncodedKeyFromEncodedProductId

createProductQuantityEncodedKeyFromOptions

getProductReorderLevel

getProductQuantityWithOptions

doesProductExist

insertGiftCertificateDigitalDownload

getPaymentScheduleId

getProductPerSkuWithOptions

getProductPerSku

editDigitalDownload

editDigitalDownload

getDigitalDownloadById

getDigitalDownloadById

getAddressesPerProduct

refreshConfigs

createOptionsFromProductQuantityEncodedKey

updateProductReviewInfo

getBundlesThatProductBelongsTo

getBundlesThatProductsBelongTo

getProductImages

updateProductsOrdered

cacheThisProduct

removeStockReservationsForBasketItems

removeStockReservationsForBasketItems

removeStockReservationsForOrderProducts

removeStockReservationsForOrderProducts

removeStockReservationsForIds

removeStockReservationsForIds

reserveStock