ProductIf (KonaKart Server Engine API Documentation)

All Known Implementing Classes:

Product
```
public interface ProductIf
```
Describes a product object for use within KonaKart.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`AddressIf[]`	`getAddresses()` An array containing all of the addresses defined for this product.
`BookableProductIf`	`getBookableProd()` An object containing attributes relevant to a bookable product
`int`	`getBundledProdQuantity()` When products are returned from the API call getRelatedProducts() and the relationship is a bundle relationship, they will have this attribute instantiated to show the number of times that this product appears in the bundle
`ProductIf[]`	`getBundledProducts()` Used to store an array of products bundled by this product.
`java.lang.Boolean`	`getCanOrderWhenNotInStock()` If null then we use the global value set by the config variable STOCK_ALLOW_CHECKOUT.
`int`	`getCategoryId()`
`java.lang.String`	`getComparison()` The content of this attribute should be structured data such as xml so that it can be easily used to compare product features with other products.
`java.lang.String`	`getContentType()` Valid for digital products.
`java.lang.String`	`getCustom1()`
`java.lang.String`	`getCustom10()`
`java.lang.String`	`getCustom11()`
`java.math.BigDecimal`	`getCustom1Dec()`
`int`	`getCustom1Int()`
`java.lang.String`	`getCustom2()`
`java.math.BigDecimal`	`getCustom2Dec()`
`int`	`getCustom2Int()`
`java.lang.String`	`getCustom3()`
`java.lang.String`	`getCustom4()`
`java.lang.String`	`getCustom5()`
`java.lang.String`	`getCustom6()`
`java.lang.String`	`getCustom7()`
`java.lang.String`	`getCustom8()`
`java.lang.String`	`getCustom9()`
`ProdCustAttrIf[]`	`getCustomAttrArray()` An array of ProdCustAttr objects
`java.lang.String`	`getCustomAttrs()` Contains the custom attributes in XML format
`java.lang.String`	`getCustomd1()`
`java.lang.String`	`getCustomd2()`
`java.lang.String`	`getCustomd3()`
`java.lang.String`	`getCustomd4()`
`java.lang.String`	`getCustomd5()`
`java.lang.String`	`getCustomd6()`
`java.lang.Object`	`getCustomObj()` Returns the transient Custom Object.
`java.util.Calendar`	`getDateAdded()`
`java.util.Calendar`	`getDateAvailable()`
`int`	`getDefaultQuantityInOrder()`
`int`	`getDepth()`
`java.lang.String`	`getDescription()`
`java.lang.String`	`getEncodedOptionValues()` When products are returned from the API call getRelatedProducts() and the relationship is a bundle relationship, they will have this attribute instantiated if the product in the bundle is configured with one or more options.
`java.util.Calendar`	`getExpiryDate()` The date that the product expires
`java.util.Calendar`	`getExtDateAvailable()`
`java.math.BigDecimal`	`getExtPrice0()`
`java.math.BigDecimal`	`getExtPrice1()`
`java.math.BigDecimal`	`getExtPrice2()`
`java.math.BigDecimal`	`getExtPrice3()`
`java.lang.Integer`	`getExtQuantity()`
`java.lang.String`	`getFilePath()` Valid for digital products.
`java.lang.String`	`getFormattedPrice()`
`int`	`getId()`
`java.lang.String`	`getImage()`
`java.lang.String`	`getImage2()`
`java.lang.String`	`getImage3()`
`java.lang.String`	`getImage4()`
`java.lang.String`	`getImageCrc()` The imageCrc is used to store meta data that describes the cached images for a product
`java.lang.String`	`getImageDir()` Get the name of the directory where the product image is located
`ProductImagesIf`	`getImages()` All the product image names for this product.
`byte`	`getInvisible()` When set to '1' the product is invisible and will not be returned from normal API calls.
`int`	`getLength()`
`ManufacturerIf`	`getManufacturer()`
`int`	`getManufacturerId()`
`java.lang.String`	`getManufacturerName()`
`int`	`getMaxDownloadDays()` Maximum number of days a product can be downloaded in the case of digital downloads.
`int`	`getMaxNumDownloads()` Maximum number of downloads allowed in the case of digital download products.
`int`	`getMaxQuantityInOrder()`
`int`	`getMinQuantityInOrder()`
`MiscItemIf[]`	`getMiscItems()` Miscellaneous Items associated with this product.
`MiscPriceIf[]`	`getMiscPrices()` Miscellaneous Prices associated with this product
`java.lang.String`	`getModel()`
`java.lang.String`	`getName()`
`java.math.BigDecimal`	`getNetWeightOrVolume()` The weight or volume of the raw product
`java.lang.String`	`getNetWeightOrVolumeUOM()` The unit of measure for the net weight or volume (e.g.
`int`	`getNumberReviews()`
`OptionIf[]`	`getOpts()` An array of Option objects.
`int`	`getOrdered()` The number of times that the product has been ordered.
`PaymentScheduleIf`	`getPaymentSchedule()` A product may be associated to a PaymentSchedule object when it is paid for using recurring billing.
`int`	`getPaymentScheduleId()` Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.
`java.math.BigDecimal`	`getPrice0()`
`java.math.BigDecimal`	`getPrice1()`
`java.math.BigDecimal`	`getPrice2()`
`java.math.BigDecimal`	`getPrice3()`
`java.math.BigDecimal`	`getPriceExTax()`
`int`	`getPriceId()`
`java.math.BigDecimal`	`getPriceIncTax()`
`int[]`	`getProdRelationTypeArray()` When products are returned from the API call getRelatedProducts() they will have this array initialised.
`ProductQuantityIf[]`	`getProductQuantities()` An array of productQuantity objects that define quantity in stock and availability date for different SKUs.
`PromotionResultIf[]`	`getPromotionResults()` Active promotions for this product
`int`	`getQuantity()`
`int`	`getQuantityReserved()` This attribute defines the total number of products that are currently reserved.
`java.math.BigDecimal`	`getRating()` Average product rating
`java.math.BigDecimal`	`getSearchScore()` The score returned by Solr.
`java.lang.String`	`getSizeUOM()` Size Unit of Measure
`java.lang.String`	`getSku()` The SKU is the stock keeping unit.
`java.lang.String[]`	`getSnippets()` Array of strings containing snippets which are text fragments surrounding the search keywords.
`java.util.Calendar`	`getSpecialExpiryDate()` The date when the special price expires
`java.math.BigDecimal`	`getSpecialPriceExTax()`
`java.math.BigDecimal`	`getSpecialPriceIncTax()`
`java.util.Calendar`	`getSpecialStartDate()` The date when the special price starts
`byte`	`getSpecialStatus()` Set to '1' if the special price is active.
`byte`	`getStatus()` Set to '1' if the product is active.
`int`	`getStockReorderLevel()` Product needs to be reordered when the stock hits this level.
`java.lang.String`	`getStoreCustom1()` Custom field with unique value for a store when in multi-store shared products mode
`java.lang.String`	`getStoreCustom2()` Custom field with unique value for a store when in multi-store shared products mode
`java.lang.String`	`getStoreCustom3()` Custom field with unique value for a store when in multi-store shared products mode
`java.lang.String`	`getStoreDescription()` The store description.
`java.lang.String`	`getStoreId()` Attribute is only applicable when KonaKart is configured in multi-store single db mode.
`java.lang.String`	`getStoreName()` The name of the store.
`SuggestionIf[]`	`getSuggestions()` Product Recommendation Suggestions
`TagIf[]`	`getTags()`
`int`	`getTaxClassId()`
`java.lang.String`	`getTaxCode()` tax code used when looking up tax from an external service
`int`	`getTemplateId()` Deprecated.
`TierPriceIf[]`	`getTierPrices()` An array of tier price objects for this product
`int`	`getType()` product type.
`java.lang.String`	`getUrl()` The url of the product, for example from the manufacturer's web site.
`java.lang.String`	`getUuid()` Get the UUID of the product
`VariantPriceIf[]`	`getVariantPrices()` The variant prices related to the product.
`int`	`getViewedCount()` The number of times the product has been viewed.
`java.math.BigDecimal`	`getWeight()`
`java.lang.String`	`getWeightUOM()` Weight Unit of Measure
`int`	`getWidth()`
`boolean`	`isIgnoreProductQuantityStock()` When set to true, even if the product has many different SKUs, KonaKart maintains the stock level using the quantity attribute of the product and not the quantity attributes of the array of ProductQuantity objects.
`boolean`	`isIndexAttachment()` If the product is a digital download and the SOLR search engine is enabled, then the attachment is indexed within the search engine when this boolean is set.
`boolean`	`isLocked()`
`void`	`setAddresses(AddressIf[] addresses)` An array containing all of the addresses defined for this product.
`void`	`setBookableProd(BookableProductIf bookableProd)` An object containing attributes relevant to a bookable product
`void`	`setBundledProdQuantity(int bundledProdQuantity)` When products are returned from the API call getRelatedProducts() and the relationship is a bundle relationship, they will have this attribute instantiated to show the number of times that this product appears in the bundle
`void`	`setBundledProducts(ProductIf[] bundledProducts)` Used to store an array of products bundled by this product.
`void`	`setCanOrderWhenNotInStock(java.lang.Boolean canOrderWhenNotInStock)` If null then we use the global value set by the config variable STOCK_ALLOW_CHECKOUT.
`void`	`setCategoryId(int categoryId)`
`void`	`setComparison(java.lang.String comparison)` The content of this attribute should be structured data such as xml so that it can be easily used to compare product features with other products.
`void`	`setContentType(java.lang.String contentType)` Valid for digital products.
`void`	`setCustom1(java.lang.String custom1)`
`void`	`setCustom10(java.lang.String custom10)`
`void`	`setCustom11(java.lang.String custom11)`
`void`	`setCustom1Dec(java.math.BigDecimal custom1Dec)`
`void`	`setCustom1Int(int custom1Int)`
`void`	`setCustom2(java.lang.String custom2)`
`void`	`setCustom2Dec(java.math.BigDecimal custom2Dec)`
`void`	`setCustom2Int(int custom2Int)`
`void`	`setCustom3(java.lang.String custom3)`
`void`	`setCustom4(java.lang.String custom4)`
`void`	`setCustom5(java.lang.String custom5)`
`void`	`setCustom6(java.lang.String custom6)`
`void`	`setCustom7(java.lang.String custom7)`
`void`	`setCustom8(java.lang.String custom8)`
`void`	`setCustom9(java.lang.String custom9)`
`void`	`setCustomAttrArray(ProdCustAttrIf[] customAttrArray)` An array of ProdCustAttr objects
`void`	`setCustomAttrs(java.lang.String customAttrs)` Contains the custom attributes in XML format
`void`	`setCustomd1(java.lang.String customd1)`
`void`	`setCustomd2(java.lang.String customd2)`
`void`	`setCustomd3(java.lang.String customd3)`
`void`	`setCustomd4(java.lang.String customd4)`
`void`	`setCustomd5(java.lang.String customd5)`
`void`	`setCustomd6(java.lang.String customd6)`
`void`	`setCustomObj(java.lang.Object customObj)` Set the transient Custom Object.
`void`	`setDateAdded(java.util.Calendar dateAdded)`
`void`	`setDateAvailable(java.util.Calendar dateAvailable)`
`void`	`setDefaultQuantityInOrder(int defaultQuantityInOrder)`
`void`	`setDepth(int depth)`
`void`	`setDescription(java.lang.String description)`
`void`	`setEncodedOptionValues(java.lang.String encodedOptionValues)` When products are returned from the API call getRelatedProducts() and the relationship is a bundle relationship, they will have this attribute instantiated if the product in the bundle is configured with one or more options.
`void`	`setExpiryDate(java.util.Calendar expiryDate)` The date that the product expires
`void`	`setExtDateAvailable(java.util.Calendar extDateAvailable)`
`void`	`setExtPrice0(java.math.BigDecimal extPrice0)`
`void`	`setExtPrice1(java.math.BigDecimal extPrice1)`
`void`	`setExtPrice2(java.math.BigDecimal extPrice2)`
`void`	`setExtPrice3(java.math.BigDecimal extPrice3)`
`void`	`setExtQuantity(java.lang.Integer extQuantity)`
`void`	`setFilePath(java.lang.String filePath)` Valid for digital products.
`void`	`setFormattedPrice(java.lang.String formattedPrice)`
`void`	`setId(int id)`
`void`	`setIgnoreProductQuantityStock(boolean ignoreProductQuantityStock)` When set to true, even if the product has many different SKUs, KonaKart maintains the stock level using the quantity attribute of the product and not the quantity attributes of the array of ProductQuantity objects.
`void`	`setImage(java.lang.String image)`
`void`	`setImage2(java.lang.String image2)`
`void`	`setImage3(java.lang.String image3)`
`void`	`setImage4(java.lang.String image4)`
`void`	`setImageCrc(java.lang.String imageCrc)` The imageCrc is used to store meta data that describes the cached images for a product
`void`	`setImageDir(java.lang.String imageDir)` Set the name of the directory where the product image is located
`void`	`setImages(ProductImagesIf images)` All the product image names for this product.
`void`	`setIndexAttachment(boolean indexAttachment)` If the product is a digital download and the SOLR search engine is enabled, then the attachment is indexed within the search engine when this boolean is set.
`void`	`setInvisible(byte invisible)` When set to '1' the product is invisible and will not be returned from normal API calls.
`void`	`setLength(int length)`
`void`	`setLocked(boolean locked)`
`void`	`setManufacturer(ManufacturerIf manufacturer)`
`void`	`setManufacturerId(int manufacturerId)`
`void`	`setManufacturerName(java.lang.String manufacturerName)`
`void`	`setMaxDownloadDays(int maxDownloadDays)` Maximum number of days a product can be downloaded in the case of digital downloads.
`void`	`setMaxNumDownloads(int maxNumDownloads)` Maximum number of downloads allowed in the case of digital download products.
`void`	`setMaxQuantityInOrder(int maxQuantityInOrder)`
`void`	`setMinQuantityInOrder(int minQuantityInOrder)`
`void`	`setMiscItems(MiscItemIf[] miscItems)` Miscellaneous Items associated with this product.
`void`	`setMiscPrices(MiscPriceIf[] miscPrices)` Miscellaneous Prices associated with this product
`void`	`setModel(java.lang.String model)`
`void`	`setName(java.lang.String name)`
`void`	`setNetWeightOrVolume(java.math.BigDecimal netWeightOrVolume)` The weight or volume of the raw product
`void`	`setNetWeightOrVolumeUOM(java.lang.String netWeightOrVolumeUOM)` The unit of measure for the net weight or volume (e.g.
`void`	`setNumberReviews(int numberReviews)`
`void`	`setOpts(OptionIf[] opts)` An array of Option objects.
`void`	`setOrdered(int ordered)` The number of times that the product has been ordered.
`void`	`setPaymentSchedule(PaymentScheduleIf paymentSchedule)` A product may be associated to a PaymentSchedule object when it is paid for using recurring billing.
`void`	`setPaymentScheduleId(int paymentScheduleId)` Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.
`void`	`setPrice0(java.math.BigDecimal price0)`
`void`	`setPrice1(java.math.BigDecimal price1)`
`void`	`setPrice2(java.math.BigDecimal price2)`
`void`	`setPrice3(java.math.BigDecimal price3)`
`void`	`setPriceExTax(java.math.BigDecimal priceExTax)`
`void`	`setPriceId(int priceId)`
`void`	`setPriceIncTax(java.math.BigDecimal priceIncTax)`
`void`	`setProdRelationTypeArray(int[] prodRelationTypeArray)` When products are returned from the API call getRelatedProducts() they will have this array initialised.
`void`	`setProductQuantities(ProductQuantityIf[] productQuantities)` An array of productQuantity objects that define quantity in stock and availability date for different SKUs.
`void`	`setPromotionResults(PromotionResultIf[] promotionResults)` Active promotions for this product
`void`	`setQuantity(int quantity)`
`void`	`setQuantityReserved(int quantityReserved)` This attribute defines the total number of products that are currently reserved.
`void`	`setRating(java.math.BigDecimal rating)` Average product rating
`void`	`setSearchScore(java.math.BigDecimal searchScore)` The score returned by Solr.
`void`	`setSizeUOM(java.lang.String sizeUOM)` Size Unit of Measure
`void`	`setSku(java.lang.String sku)` The SKU is the stock keeping unit.
`void`	`setSnippets(java.lang.String[] snippets)` Array of strings containing snippets which are text fragments surrounding the search keywords.
`void`	`setSpecialExpiryDate(java.util.Calendar specialExpiryDate)` The date when the special price expires
`void`	`setSpecialPriceExTax(java.math.BigDecimal specialPriceExTax)`
`void`	`setSpecialPriceIncTax(java.math.BigDecimal specialPriceIncTax)`
`void`	`setSpecialStartDate(java.util.Calendar specialStartDate)` The date when the special price starts
`void`	`setSpecialStatus(byte specialStatus)` Set to '1' if the special price is active.
`void`	`setStatus(byte status)` Set to '1' if the product is active.
`void`	`setStockReorderLevel(int stockReorderLevel)` Product needs to be reordered when the stock hits this level.
`void`	`setStoreCustom1(java.lang.String storeCustom1)` Custom field with unique value for a store when in multi-store shared products mode
`void`	`setStoreCustom2(java.lang.String storeCustom2)` Custom field with unique value for a store when in multi-store shared products mode
`void`	`setStoreCustom3(java.lang.String storeCustom3)` Custom field with unique value for a store when in multi-store shared products mode
`void`	`setStoreDescription(java.lang.String storeDescription)` The store description.
`void`	`setStoreId(java.lang.String storeId)` Attribute is only applicable when KonaKart is configured in multi-store single db mode.
`void`	`setStoreName(java.lang.String storeName)` The name of the store.
`void`	`setSuggestions(SuggestionIf[] suggestions)`
`void`	`setTags(TagIf[] tags)`
`void`	`setTaxClassId(int taxClassId)`
`void`	`setTaxCode(java.lang.String taxCode)` tax code used when looking up tax from an external service
`void`	`setTemplateId(int templateId)` Deprecated.
`void`	`setTierPrices(TierPriceIf[] tierPrices)` An array of tier price objects for this product
`void`	`setType(int type)` product type.
`void`	`setUrl(java.lang.String url)` The url of the product, for example from the manufacturer's web site.
`void`	`setUuid(java.lang.String uuid)` set the UUID of the product
`void`	`setVariantPrices(VariantPriceIf[] variantPrices)` The variant prices related to the product.
`void`	`setViewedCount(int viewedCount)` The number of times the product has been viewed.
`void`	`setWeight(java.math.BigDecimal weight)`
`void`	`setWeightUOM(java.lang.String weightUOM)` Weight Unit of Measure
`void`	`setWidth(int width)`

- Method Detail
  - getCustomObj
```
java.lang.Object getCustomObj()
```
    Returns the transient Custom Object. Does not take part in the KonaKart APIs.
    
    Returns:
    
    Returns the customObj object. Note that this is a transient object. It does not get serialised or written to the database and is not read or returned by the KonaKart APIs.
  - setCustomObj
```
void setCustomObj(java.lang.Object customObj)
```
    Set the transient Custom Object. Does not take part in the KonaKart APIs.
    
    Parameters:
    
    customObj - Sets the customObj object. This is a transient object. It does not get serialised or written to the database and is not read or returned by the KonaKart APIs.
  - getTaxClassId
```
int getTaxClassId()
```
    Returns:
    
    Returns the taxClassId.
  - setTaxClassId
```
void setTaxClassId(int taxClassId)
```
    Parameters:
    
    taxClassId - The taxClassId to set.
  - getManufacturerName
```
java.lang.String getManufacturerName()
```
    Returns:
    
    Returns the manufacturerName.
  - setManufacturerName
```
void setManufacturerName(java.lang.String manufacturerName)
```
    Parameters:
    
    manufacturerName - The manufacturerName to set.
  - getDescription
```
java.lang.String getDescription()
```
    Returns:
    
    Returns the description.
  - setDescription
```
void setDescription(java.lang.String description)
```
    Parameters:
    
    description - The description to set.
  - getCustomd1
```
java.lang.String getCustomd1()
```
    Returns:
    
    Returns the customd1.
  - setCustomd1
```
void setCustomd1(java.lang.String customd1)
```
    Parameters:
    
    customd1 - The customd1 to set.
  - getCustomd2
```
java.lang.String getCustomd2()
```
    Returns:
    
    Returns the customd2.
  - setCustomd2
```
void setCustomd2(java.lang.String customd2)
```
    Parameters:
    
    customd2 - The customd2 to set.
  - getCustomd3
```
java.lang.String getCustomd3()
```
    Returns:
    
    Returns the customd3.
  - setCustomd3
```
void setCustomd3(java.lang.String customd3)
```
    Parameters:
    
    customd3 - The customd3 to set.
  - getCustomd4
```
java.lang.String getCustomd4()
```
    Returns:
    
    Returns the customd4.
  - setCustomd4
```
void setCustomd4(java.lang.String customd4)
```
    Parameters:
    
    customd4 - The customd4 to set.
  - getCustomd5
```
java.lang.String getCustomd5()
```
    Returns:
    
    Returns the customd5.
  - setCustomd5
```
void setCustomd5(java.lang.String customd5)
```
    Parameters:
    
    customd5 - The customd5 to set.
  - getCustomd6
```
java.lang.String getCustomd6()
```
    Returns:
    
    Returns the customd6.
  - setCustomd6
```
void setCustomd6(java.lang.String customd6)
```
    Parameters:
    
    customd6 - The customd6 to set.
  - getId
```
int getId()
```
    Returns:
    
    Returns the id.
  - setId
```
void setId(int id)
```
    Parameters:
    
    id - The id to set.
  - getImage
```
java.lang.String getImage()
```
    Returns:
    
    Returns the image.
  - setImage
```
void setImage(java.lang.String image)
```
    Parameters:
    
    image - The image to set.
  - getModel
```
java.lang.String getModel()
```
    Returns:
    
    Returns the model.
  - setModel
```
void setModel(java.lang.String model)
```
    Parameters:
    
    model - The model to set.
  - getName
```
java.lang.String getName()
```
    Returns:
    
    Returns the name.
  - setName
```
void setName(java.lang.String name)
```
    Parameters:
    
    name - The name to set.
  - getOpts
```
OptionIf[] getOpts()
```
    An array of Option objects. An option is used to configure a product and may change its price. i.e. The amount of memory or CPU specification for a personal computer.
    
    Returns:
    
    Returns the opts.
  - setOpts
```
void setOpts(OptionIf[] opts)
```
    An array of Option objects. An option is used to configure a product and may change its price. i.e. The amount of memory or CPU specification for a personal computer.
    
    Parameters:
    
    opts - The opts to set.
  - getQuantity
```
int getQuantity()
```
    Returns:
    
    Returns the quantity.
  - setQuantity
```
void setQuantity(int quantity)
```
    Parameters:
    
    quantity - The quantity to set.
  - getStatus
```
byte getStatus()
```
    Set to '1' if the product is active. Otherwise set to '0'.
    
    Returns:
    
    Returns the status.
  - setStatus
```
void setStatus(byte status)
```
    Set to '1' if the product is active. Otherwise set to '0'.
    
    Parameters:
    
    status - The status to set.
  - getUrl
```
java.lang.String getUrl()
```
    The url of the product, for example from the manufacturer's web site.
    
    Returns:
    
    Returns the url.
  - setUrl
```
void setUrl(java.lang.String url)
```
    The url of the product, for example from the manufacturer's web site.
    
    Parameters:
    
    url - The url to set.
  - getViewedCount
```
int getViewedCount()
```
    The number of times the product has been viewed.
    
    Returns:
    
    Returns the viewedCount.
  - setViewedCount
```
void setViewedCount(int viewedCount)
```
    The number of times the product has been viewed.
    
    Parameters:
    
    viewedCount - The viewedCount to set.
  - getWeight
```
java.math.BigDecimal getWeight()
```
    Returns:
    
    Returns the weight.
  - setWeight
```
void setWeight(java.math.BigDecimal weight)
```
    Parameters:
    
    weight - The weight to set.
  - getNumberReviews
```
int getNumberReviews()
```
    Returns:
    
    Returns the numberReviews.
  - setNumberReviews
```
void setNumberReviews(int numberReviews)
```
    Parameters:
    
    numberReviews - The numberReviews to set.
  - getDateAdded
```
java.util.Calendar getDateAdded()
```
    Returns:
    
    Returns the dateAdded.
  - setDateAdded
```
void setDateAdded(java.util.Calendar dateAdded)
```
    Parameters:
    
    dateAdded - The dateAdded to set.
  - getDateAvailable
```
java.util.Calendar getDateAvailable()
```
    Returns:
    
    Returns the dateAvailable.
  - setDateAvailable
```
void setDateAvailable(java.util.Calendar dateAvailable)
```
    Parameters:
    
    dateAvailable - The dateAvailable to set.
  - getManufacturer
```
ManufacturerIf getManufacturer()
```
    Returns:
    
    Returns the manufacturer.
  - setManufacturer
```
void setManufacturer(ManufacturerIf manufacturer)
```
    Parameters:
    
    manufacturer - The manufacturer to set.
  - getManufacturerId
```
int getManufacturerId()
```
    Returns:
    
    Returns the manufacturerId.
  - setManufacturerId
```
void setManufacturerId(int manufacturerId)
```
    Parameters:
    
    manufacturerId - The manufacturerId to set.
  - getCategoryId
```
int getCategoryId()
```
    Returns:
    
    Returns the categoryId.
  - setCategoryId
```
void setCategoryId(int categoryId)
```
    Parameters:
    
    categoryId - The categoryId to set.
  - getOrdered
```
int getOrdered()
```
    The number of times that the product has been ordered.
    
    Returns:
    
    Returns the ordered.
  - setOrdered
```
void setOrdered(int ordered)
```
    The number of times that the product has been ordered.
    
    Parameters:
    
    ordered - The ordered to set.
  - getPriceExTax
```
java.math.BigDecimal getPriceExTax()
```
    Returns:
    
    Returns the priceExTax.
  - setPriceExTax
```
void setPriceExTax(java.math.BigDecimal priceExTax)
```
    Parameters:
    
    priceExTax - The priceExTax to set.
  - getSpecialPriceExTax
```
java.math.BigDecimal getSpecialPriceExTax()
```
    Returns:
    
    Returns the specialPriceExTax.
  - setSpecialPriceExTax
```
void setSpecialPriceExTax(java.math.BigDecimal specialPriceExTax)
```
    Parameters:
    
    specialPriceExTax - The specialPriceExTax to set.
  - getSpecialPriceIncTax
```
java.math.BigDecimal getSpecialPriceIncTax()
```
    Returns:
    
    Returns the specialPriceIncTax.
  - setSpecialPriceIncTax
```
void setSpecialPriceIncTax(java.math.BigDecimal specialPriceIncTax)
```
    Parameters:
    
    specialPriceIncTax - The specialPriceIncTax to set.
  - getPriceIncTax
```
java.math.BigDecimal getPriceIncTax()
```
    Returns:
    
    Returns the priceIncTax.
  - setPriceIncTax
```
void setPriceIncTax(java.math.BigDecimal priceIncTax)
```
    Parameters:
    
    priceIncTax - The priceIncTax to set.
  - getCustom1
```
java.lang.String getCustom1()
```
    Returns:
    
    Returns the custom1.
  - setCustom1
```
void setCustom1(java.lang.String custom1)
```
    Parameters:
    
    custom1 - The custom1 to set.
  - getCustom2
```
java.lang.String getCustom2()
```
    Returns:
    
    Returns the custom2.
  - setCustom2
```
void setCustom2(java.lang.String custom2)
```
    Parameters:
    
    custom2 - The custom2 to set.
  - getCustom3
```
java.lang.String getCustom3()
```
    Returns:
    
    Returns the custom3.
  - setCustom3
```
void setCustom3(java.lang.String custom3)
```
    Parameters:
    
    custom3 - The custom3 to set.
  - getCustom4
```
java.lang.String getCustom4()
```
    Returns:
    
    Returns the custom4.
  - setCustom4
```
void setCustom4(java.lang.String custom4)
```
    Parameters:
    
    custom4 - The custom4 to set.
  - getCustom5
```
java.lang.String getCustom5()
```
    Returns:
    
    Returns the custom5.
  - setCustom5
```
void setCustom5(java.lang.String custom5)
```
    Parameters:
    
    custom5 - The custom5 to set.
  - getCustom6
```
java.lang.String getCustom6()
```
    Returns:
    
    the custom6
  - setCustom6
```
void setCustom6(java.lang.String custom6)
```
    Parameters:
    
    custom6 - the custom6 to set
  - getCustom7
```
java.lang.String getCustom7()
```
    Returns:
    
    the custom7
  - setCustom7
```
void setCustom7(java.lang.String custom7)
```
    Parameters:
    
    custom7 - the custom7 to set
  - getCustom8
```
java.lang.String getCustom8()
```
    Returns:
    
    the custom8
  - setCustom8
```
void setCustom8(java.lang.String custom8)
```
    Parameters:
    
    custom8 - the custom8 to set
  - getCustom9
```
java.lang.String getCustom9()
```
    Returns:
    
    the custom9
  - setCustom9
```
void setCustom9(java.lang.String custom9)
```
    Parameters:
    
    custom9 - the custom9 to set
  - getCustom10
```
java.lang.String getCustom10()
```
    Returns:
    
    the custom10
  - setCustom10
```
void setCustom10(java.lang.String custom10)
```
    Parameters:
    
    custom10 - the custom10 to set
  - getCustom11
```
java.lang.String getCustom11()
```
    Returns:
    
    the custom11
  - setCustom11
```
void setCustom11(java.lang.String custom11)
```
    Parameters:
    
    custom11 - the custom11 to set
  - getCustom1Int
```
int getCustom1Int()
```
    Returns:
    
    the custom1Int
  - setCustom1Int
```
void setCustom1Int(int custom1Int)
```
    Parameters:
    
    custom1Int - the custom1Int to set
  - getCustom2Int
```
int getCustom2Int()
```
    Returns:
    
    the custom2Int
  - setCustom2Int
```
void setCustom2Int(int custom2Int)
```
    Parameters:
    
    custom2Int - the custom2Int to set
  - getCustom1Dec
```
java.math.BigDecimal getCustom1Dec()
```
    Returns:
    
    the custom1Dec
  - setCustom1Dec
```
void setCustom1Dec(java.math.BigDecimal custom1Dec)
```
    Parameters:
    
    custom1Dec - the custom1Dec to set
  - getCustom2Dec
```
java.math.BigDecimal getCustom2Dec()
```
    Returns:
    
    the custom2Dec
  - setCustom2Dec
```
void setCustom2Dec(java.math.BigDecimal custom2Dec)
```
    Parameters:
    
    custom2Dec - the custom2Dec to set
  - getProdRelationTypeArray
```
int[] getProdRelationTypeArray()
```
    When products are returned from the API call getRelatedProducts() they will have this array initialised. It is an array of integers where each integer defines a relation type. The valid relation types are:
    - com.konakart.bl.ProductMgr.UP_SELL - Up Sell
    - com.konakart.bl.ProductMgr.CROSS_SELL - Cross Sell
    - com.konakart.bl.ProductMgr.ACCESSORY - Accessory
    - com.konakart.bl.ProductMgr.DEPENDENT_ITEM - Dependent item
    - com.konakart.bl.ProductMgr.BUNDLED_PRODUCT_RELATIONSHIP - Bundled product
    - com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_1 - Custom Relationship
    - com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_2 - Custom Relationship
    - com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_3 - Custom Relationship
    - com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_4 - Custom Relationship
    - com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_5 - Custom Relationship
    An array is necessary because a product may be related to another product in more than one way.
    Returns:
    
    Returns the prodRelationTypeArray.
  - setProdRelationTypeArray
```
void setProdRelationTypeArray(int[] prodRelationTypeArray)
```
    When products are returned from the API call getRelatedProducts() they will have this array initialised. It is an array of integers where each integer defines a relation type. The valid relation types are:
    - com.konakart.bl.ProductMgr.UP_SELL - Up Sell
    - com.konakart.bl.ProductMgr.CROSS_SELL - Cross Sell
    - com.konakart.bl.ProductMgr.ACCESSORY - Accessory
    - com.konakart.bl.ProductMgr.DEPENDENT_ITEM - Dependent item
    - com.konakart.bl.ProductMgr.BUNDLED_PRODUCT_RELATIONSHIP - Bundled product
    - com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_1 - Custom Relationship
    - com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_2 - Custom Relationship
    - com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_3 - Custom Relationship
    - com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_4 - Custom Relationship
    - com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_5 - Custom Relationship
    An array is necessary because a product may be related to another product in more than one way.
    Parameters:
    
    prodRelationTypeArray - The prodRelationTypeArray to set.
  - getInvisible
```
byte getInvisible()
```
    When set to '1' the product is invisible and will not be returned from normal API calls.
    
    Returns:
    
    Returns the invisible.
  - setInvisible
```
void setInvisible(byte invisible)
```
    When set to '1' the product is invisible and will not be returned from normal API calls.
    
    Parameters:
    
    invisible - The invisible to set.
  - getSku
```
java.lang.String getSku()
```
    The SKU is the stock keeping unit.
    
    Returns:
    
    Returns the sku.
  - setSku
```
void setSku(java.lang.String sku)
```
    The SKU is the stock keeping unit.
    
    Parameters:
    
    sku - The sku to set.
  - getContentType
```
java.lang.String getContentType()
```
    Valid for digital products. The Content Type describes the content of the file. Examples are "image/jpeg" or "application/pdf".
    
    Returns:
    
    Returns the contentType.
  - setContentType
```
void setContentType(java.lang.String contentType)
```
    Valid for digital products. The Content Type describes the content of the file. Examples are "image/jpeg" or "application/pdf".
    
    Parameters:
    
    contentType - The contentType to set.
  - getFilePath
```
java.lang.String getFilePath()
```
    Valid for digital products. The File Path is the path of a file containing the digital product. This path will be appended to the Base Path defined by a configuration variable.
    
    Returns:
    
    Returns the filePath.
  - setFilePath
```
void setFilePath(java.lang.String filePath)
```
    Valid for digital products. The File Path is the path of a file containing the digital product. This path will be appended to the Base Path defined by a configuration variable.
    
    Parameters:
    
    filePath - The filePath to set.
  - getType
```
int getType()
```
    product type.
    - com.konakart.bl.ProductMgr.PHYSICAL_PRODUCT = physical product
    - com.konakart.bl.ProductMgr.DIGITAL_DOWNLOAD = digital download product
    - com.konakart.bl.ProductMgr.FREE_SHIPPING = physical product with free shipping
    - com.konakart.bl.ProductMgr.BUNDLE_PRODUCT_TYPE = a product that bundles other product
    - com.konakart.bl.ProductMgr.FREE_SHIPPING_BUNDLE_PRODUCT_TYPE = a product that bundles other product with free shipping
    - com.konakart.bl.ProductMgr.GIFT_CERTIFICATE_PRODUCT_TYPE = a gift certificate product
    - com.konakart.bl.ProductMgr.BOOKABLE_PRODUCT_TYPE = a product that has a schedule and can have bookings (i.e. a training course)
    - com.konakart.bl.ProductMgr.VIRTUAL_PRODUCT_TYPE = a virtual product such as a service, warranty or donation
    Returns:
    
    Returns the type.
  - setType
```
void setType(int type)
```
    product type.
    - com.konakart.bl.ProductMgr.PHYSICAL_PRODUCT = physical product
    - com.konakart.bl.ProductMgr.DIGITAL_DOWNLOAD = digital download product
    - com.konakart.bl.ProductMgr.FREE_SHIPPING = physical product with free shipping
    - com.konakart.bl.ProductMgr.BUNDLE_PRODUCT_TYPE = a product that bundles other product
    - com.konakart.bl.ProductMgr.FREE_SHIPPING_BUNDLE_PRODUCT_TYPE = a product that bundles other product with free shipping
    - com.konakart.bl.ProductMgr.GIFT_CERTIFICATE_PRODUCT_TYPE = a gift certificate product
    - com.konakart.bl.ProductMgr.BOOKABLE_PRODUCT_TYPE = a product that has a schedule and can have bookings (i.e. a training course)
    - com.konakart.bl.ProductMgr.VIRTUAL_PRODUCT_TYPE = a virtual product such as a service, warranty or donation
    Parameters:
    
    type - The type to set.
  - getImage2
```
java.lang.String getImage2()
```
    Returns:
    
    Returns the image2.
  - setImage2
```
void setImage2(java.lang.String image2)
```
    Parameters:
    
    image2 - The image2 to set.
  - getImage3
```
java.lang.String getImage3()
```
    Returns:
    
    Returns the image3.
  - setImage3
```
void setImage3(java.lang.String image3)
```
    Parameters:
    
    image3 - The image3 to set.
  - getImage4
```
java.lang.String getImage4()
```
    Returns:
    
    Returns the image4.
  - setImage4
```
void setImage4(java.lang.String image4)
```
    Parameters:
    
    image4 - The image4 to set.
  - getImages
```
ProductImagesIf getImages()
```
    All the product image names for this product. Only instantiated when fetching objects if getImages is set to true in the FetchProductOptions object.
    
    Returns:
    
    the images
  - setImages
```
void setImages(ProductImagesIf images)
```
    All the product image names for this product. Only instantiated when fetching objects if getImages is set to true in the FetchProductOptions object.
    
    Parameters:
    
    images - the images to set
  - getImageDir
```
java.lang.String getImageDir()
```
    Get the name of the directory where the product image is located
    
    Returns:
    
    Returns the imageDir.
  - setImageDir
```
void setImageDir(java.lang.String imageDir)
```
    Set the name of the directory where the product image is located
    
    Parameters:
    
    imageDir - The imageDir to set.
  - getImageCrc
```
java.lang.String getImageCrc()
```
    The imageCrc is used to store meta data that describes the cached images for a product
    
    Returns:
    
    the imageCrc
  - setImageCrc
```
void setImageCrc(java.lang.String imageCrc)
```
    The imageCrc is used to store meta data that describes the cached images for a product
    
    Parameters:
    
    imageCrc - the imageCrc to set
  - getComparison
```
java.lang.String getComparison()
```
    The content of this attribute should be structured data such as xml so that it can be easily used to compare product features with other products. e.g. The tag names could be the features.
    
    Returns:
    
    Returns the comparison.
  - setComparison
```
void setComparison(java.lang.String comparison)
```
    The content of this attribute should be structured data such as xml so that it can be easily used to compare product features with other products. e.g. The tag names could be the features.
    
    Parameters:
    
    comparison - The comparison to set.
  - getPrice0
```
java.math.BigDecimal getPrice0()
```
    Returns:
    
    Returns the price0.
  - setPrice0
```
void setPrice0(java.math.BigDecimal price0)
```
    Parameters:
    
    price0 - The price0 to set.
  - getPrice1
```
java.math.BigDecimal getPrice1()
```
    Returns:
    
    Returns the price1.
  - setPrice1
```
void setPrice1(java.math.BigDecimal price1)
```
    Parameters:
    
    price1 - The price1 to set.
  - getPrice2
```
java.math.BigDecimal getPrice2()
```
    Returns:
    
    Returns the price2.
  - setPrice2
```
void setPrice2(java.math.BigDecimal price2)
```
    Parameters:
    
    price2 - The price2 to set.
  - getPrice3
```
java.math.BigDecimal getPrice3()
```
    Returns:
    
    Returns the price3.
  - setPrice3
```
void setPrice3(java.math.BigDecimal price3)
```
    Parameters:
    
    price3 - The price3 to set.
  - getFormattedPrice
```
java.lang.String getFormattedPrice()
```
    Returns:
    
    the formattedPrice
  - setFormattedPrice
```
void setFormattedPrice(java.lang.String formattedPrice)
```
    Parameters:
    
    formattedPrice - the formattedPrice to set
  - getBundledProdQuantity
```
int getBundledProdQuantity()
```
    When products are returned from the API call getRelatedProducts() and the relationship is a bundle relationship, they will have this attribute instantiated to show the number of times that this product appears in the bundle
    
    Returns:
    
    Returns the bundledProdQuantity.
  - setBundledProdQuantity
```
void setBundledProdQuantity(int bundledProdQuantity)
```
    When products are returned from the API call getRelatedProducts() and the relationship is a bundle relationship, they will have this attribute instantiated to show the number of times that this product appears in the bundle
    
    Parameters:
    
    bundledProdQuantity - The bundledProdQuantity to set.
  - getEncodedOptionValues
```
java.lang.String getEncodedOptionValues()
```
    When products are returned from the API call getRelatedProducts() and the relationship is a bundle relationship, they will have this attribute instantiated if the product in the bundle is configured with one or more options.
    encodedOptionValues 3{5}4{1} means product_options of id==3 and product_options_values of id==5 followed by product_options of id==4 and product_options_values of id==1.
    
    Returns:
    
    Returns the encodedOptionValues.
  - setEncodedOptionValues
```
void setEncodedOptionValues(java.lang.String encodedOptionValues)
```
    When products are returned from the API call getRelatedProducts() and the relationship is a bundle relationship, they will have this attribute instantiated if the product in the bundle is configured with one or more options.
    encodedOptionValues 3{5}4{1} means product_options of id==3 and product_options_values of id==5 followed by product_options of id==4 and product_options_values of id==1.
    
    Parameters:
    
    encodedOptionValues - The encodedOptionValues to set.
  - getTags
```
TagIf[] getTags()
```
    Returns:
    
    Returns the tags.
  - setTags
```
void setTags(TagIf[] tags)
```
    Parameters:
    
    tags - The tags to set.
  - getStoreId
```
java.lang.String getStoreId()
```
    Attribute is only applicable when KonaKart is configured in multi-store single db mode. It is used when doing a search within multiple stores so that you can identify which store a returned product belongs to.
    
    Returns:
    
    Returns the store id
  - setStoreId
```
void setStoreId(java.lang.String storeId)
```
    Attribute is only applicable when KonaKart is configured in multi-store single db mode. It is used when doing a search within multiple stores so that you can identify which store a returned product belongs to.
    
    Parameters:
    
    storeId - the storeId
  - getMaxNumDownloads
```
int getMaxNumDownloads()
```
    Maximum number of downloads allowed in the case of digital download products. If negative, then the configuration variable value (DD_MAX_DOWNLOADS) will be used.
    
    Returns:
    
    the maxNumDownloads
  - setMaxNumDownloads
```
void setMaxNumDownloads(int maxNumDownloads)
```
    Maximum number of downloads allowed in the case of digital download products. If negative, then the configuration variable value (DD_MAX_DOWNLOADS) will be used.
    
    Parameters:
    
    maxNumDownloads - the maxNumDownloads to set
  - getMaxDownloadDays
```
int getMaxDownloadDays()
```
    Maximum number of days a product can be downloaded in the case of digital downloads. If negative, then the configuration variable value (DD_MAX_DOWNLOAD_DAYS) will be used.
    
    Returns:
    
    the maxDownloadDays
  - setMaxDownloadDays
```
void setMaxDownloadDays(int maxDownloadDays)
```
    Maximum number of days a product can be downloaded in the case of digital downloads. If negative, then the configuration variable value (DD_MAX_DOWNLOAD_DAYS) will be used.
    
    Parameters:
    
    maxDownloadDays - the maxDownloadDays to set
  - getStockReorderLevel
```
int getStockReorderLevel()
```
    Product needs to be reordered when the stock hits this level. If negative, then the configuration variable value (STOCK_REORDER_LEVEL) will be used.
    
    Returns:
    
    the stockReorderLevel
  - setStockReorderLevel
```
void setStockReorderLevel(int stockReorderLevel)
```
    Product needs to be reordered when the stock hits this level. If negative, then the configuration variable value (STOCK_REORDER_LEVEL) will be used.
    
    Parameters:
    
    stockReorderLevel - the stockReorderLevel to set
  - getCanOrderWhenNotInStock
```
java.lang.Boolean getCanOrderWhenNotInStock()
```
    If null then we use the global value set by the config variable STOCK_ALLOW_CHECKOUT. If the value isn't null, then it overrides the global value.
    
    Returns:
    
    the canOrderWhenNotInStock
  - setCanOrderWhenNotInStock
```
void setCanOrderWhenNotInStock(java.lang.Boolean canOrderWhenNotInStock)
```
    If null then we use the global value set by the config variable STOCK_ALLOW_CHECKOUT. If the value isn't null, then it overrides the global value.
    
    Parameters:
    
    canOrderWhenNotInStock - the canOrderWhenNotInStock to set
  - isIndexAttachment
```
boolean isIndexAttachment()
```
    If the product is a digital download and the SOLR search engine is enabled, then the attachment is indexed within the search engine when this boolean is set. Currently it functions for txt and pdf attachments.
    
    Returns:
    
    the indexAttachment
  - setIndexAttachment
```
void setIndexAttachment(boolean indexAttachment)
```
    If the product is a digital download and the SOLR search engine is enabled, then the attachment is indexed within the search engine when this boolean is set. Currently it functions for txt and pdf attachments.
    
    Parameters:
    
    indexAttachment - the indexAttachment to set
  - getSnippets
```
java.lang.String[] getSnippets()
```
    Array of strings containing snippets which are text fragments surrounding the search keywords.
    
    Returns:
    
    the snippets
  - setSnippets
```
void setSnippets(java.lang.String[] snippets)
```
    Array of strings containing snippets which are text fragments surrounding the search keywords.
    
    Parameters:
    
    snippets - the snippets to set
  - getRating
```
java.math.BigDecimal getRating()
```
    Average product rating
    
    Returns:
    
    the rating
  - setRating
```
void setRating(java.math.BigDecimal rating)
```
    Average product rating
    
    Parameters:
    
    rating - the rating to set
  - getExpiryDate
```
java.util.Calendar getExpiryDate()
```
    The date that the product expires
    
    Returns:
    
    the expiryDate
  - setExpiryDate
```
void setExpiryDate(java.util.Calendar expiryDate)
```
    The date that the product expires
    
    Parameters:
    
    expiryDate - the expiryDate to set
  - getPaymentScheduleId
```
int getPaymentScheduleId()
```
    Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.
    
    Returns:
    
    the paymentScheduleId
  - setPaymentScheduleId
```
void setPaymentScheduleId(int paymentScheduleId)
```
    Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.
    
    Parameters:
    
    paymentScheduleId - the paymentScheduleId to set
  - getPaymentSchedule
```
PaymentScheduleIf getPaymentSchedule()
```
    A product may be associated to a PaymentSchedule object when it is paid for using recurring billing.
    
    Returns:
    
    the paymentSchedule
  - setPaymentSchedule
```
void setPaymentSchedule(PaymentScheduleIf paymentSchedule)
```
    A product may be associated to a PaymentSchedule object when it is paid for using recurring billing.
    
    Parameters:
    
    paymentSchedule - the paymentSchedule to set
  - getTierPrices
```
TierPriceIf[] getTierPrices()
```
    An array of tier price objects for this product
    
    Returns:
    
    the tierPrices
  - setTierPrices
```
void setTierPrices(TierPriceIf[] tierPrices)
```
    An array of tier price objects for this product
    
    Parameters:
    
    tierPrices - the tierPrices to set
  - getSpecialExpiryDate
```
java.util.Calendar getSpecialExpiryDate()
```
    The date when the special price expires
    
    Returns:
    
    the specialExpiryDate
  - setSpecialExpiryDate
```
void setSpecialExpiryDate(java.util.Calendar specialExpiryDate)
```
    The date when the special price expires
    
    Parameters:
    
    specialExpiryDate - the specialExpiryDate to set
  - getSpecialStartDate
```
java.util.Calendar getSpecialStartDate()
```
    The date when the special price starts
    
    Returns:
    
    the specialStartDate
  - setSpecialStartDate
```
void setSpecialStartDate(java.util.Calendar specialStartDate)
```
    The date when the special price starts
    
    Parameters:
    
    specialStartDate - the specialStartDate to set
  - getSpecialStatus
```
byte getSpecialStatus()
```
    Set to '1' if the special price is active. Otherwise set to '0'.
    
    Returns:
    
    the specialStatus
  - setSpecialStatus
```
void setSpecialStatus(byte specialStatus)
```
    Set to '1' if the special price is active. Otherwise set to '0'.
    
    Parameters:
    
    specialStatus - the specialStatus to set
  - getProductQuantities
```
ProductQuantityIf[] getProductQuantities()
```
    An array of productQuantity objects that define quantity in stock and availability date for different SKUs. This array will only exist when the product can be configured by selecting from a list of options. Each valid combination of options may have a unique SKU and quantity in stock. i.e. For the case of an article of clothing, the options may be size and color, each combination of which consists of a product with a unique SKU.
    
    Returns:
    
    the productQuantities
  - setProductQuantities
```
void setProductQuantities(ProductQuantityIf[] productQuantities)
```
    An array of productQuantity objects that define quantity in stock and availability date for different SKUs. This array will only exist when the product can be configured by selecting from a list of options. Each valid combination of options may have a unique SKU and quantity in stock. i.e. For the case of an article of clothing, the options may be size and color, each combination of which consists of a product with a unique SKU.
    
    Parameters:
    
    productQuantities - the productQuantities to set
  - getAddresses
```
AddressIf[] getAddresses()
```
    An array containing all of the addresses defined for this product.
    
    Returns:
    
    Returns the addresses.
  - setAddresses
```
void setAddresses(AddressIf[] addresses)
```
    An array containing all of the addresses defined for this product.
    
    Parameters:
    
    addresses - The addresses to set.
  - getCustomAttrs
```
java.lang.String getCustomAttrs()
```
    Contains the custom attributes in XML format
    
    Returns:
    
    the customAttrs
  - setCustomAttrs
```
void setCustomAttrs(java.lang.String customAttrs)
```
    Contains the custom attributes in XML format
    
    Parameters:
    
    customAttrs - the customAttrs to set
  - getCustomAttrArray
```
ProdCustAttrIf[] getCustomAttrArray()
```
    An array of ProdCustAttr objects
    
    Returns:
    
    the customAttrArray
  - setCustomAttrArray
```
void setCustomAttrArray(ProdCustAttrIf[] customAttrArray)
```
    An array of ProdCustAttr objects
    
    Parameters:
    
    customAttrArray - the customAttrArray to set
  - getTaxCode
```
java.lang.String getTaxCode()
```
    tax code used when looking up tax from an external service
    
    Returns:
    
    the taxCode
  - setTaxCode
```
void setTaxCode(java.lang.String taxCode)
```
    tax code used when looking up tax from an external service
    
    Parameters:
    
    taxCode - the taxCode to set
  - getStoreCustom1
```
java.lang.String getStoreCustom1()
```
    Custom field with unique value for a store when in multi-store shared products mode
    
    Returns:
    
    the storeCustom1
  - setStoreCustom1
```
void setStoreCustom1(java.lang.String storeCustom1)
```
    Custom field with unique value for a store when in multi-store shared products mode
    
    Parameters:
    
    storeCustom1 - the storeCustom1 to set
  - getStoreCustom2
```
java.lang.String getStoreCustom2()
```
    Custom field with unique value for a store when in multi-store shared products mode
    
    Returns:
    
    the storeCustom2
  - setStoreCustom2
```
void setStoreCustom2(java.lang.String storeCustom2)
```
    Custom field with unique value for a store when in multi-store shared products mode
    
    Parameters:
    
    storeCustom2 - the storeCustom2 to set
  - getStoreCustom3
```
java.lang.String getStoreCustom3()
```
    Custom field with unique value for a store when in multi-store shared products mode
    
    Returns:
    
    the storeCustom3
  - setStoreCustom3
```
void setStoreCustom3(java.lang.String storeCustom3)
```
    Custom field with unique value for a store when in multi-store shared products mode
    
    Parameters:
    
    storeCustom3 - the storeCustom3 to set
  - getBookableProd
```
BookableProductIf getBookableProd()
```
    An object containing attributes relevant to a bookable product
    
    Returns:
    
    the bookableProd
  - setBookableProd
```
void setBookableProd(BookableProductIf bookableProd)
```
    An object containing attributes relevant to a bookable product
    
    Parameters:
    
    bookableProd - the bookableProd to set
  - getMiscItems
```
MiscItemIf[] getMiscItems()
```
    Miscellaneous Items associated with this product. The miscellaneous items are ordered by the name of the item type.
    
    Returns:
    
    the miscItems associated with this product.
  - setMiscItems
```
void setMiscItems(MiscItemIf[] miscItems)
```
    Miscellaneous Items associated with this product. The miscellaneous items are ordered by the name of the item type.
    
    Parameters:
    
    miscItems - the miscItems to set
  - getMiscPrices
```
MiscPriceIf[] getMiscPrices()
```
    Miscellaneous Prices associated with this product
    
    Returns:
    
    the miscPrices associated with this product.
  - setMiscPrices
```
void setMiscPrices(MiscPriceIf[] miscPrices)
```
    Miscellaneous Prices associated with this product
    
    Parameters:
    
    miscPrices - the miscPrices to set
  - getPromotionResults
```
PromotionResultIf[] getPromotionResults()
```
    Active promotions for this product
    
    Returns:
    
    the promotionResults
  - setPromotionResults
```
void setPromotionResults(PromotionResultIf[] promotionResults)
```
    Active promotions for this product
    
    Parameters:
    
    promotionResults - the promotionResults to set
  - getTemplateId
```
@Deprecated
int getTemplateId()
```
    Deprecated.
    
    Id of the custom attribute template
    
    Returns:
    
    the templateId
  - setTemplateId
```
@Deprecated
void setTemplateId(int templateId)
```
    Deprecated.
    
    Id of the custom attribute template
    
    Parameters:
    
    templateId - the templateId to set
  - getUuid
```
java.lang.String getUuid()
```
    Get the UUID of the product
    
    Returns:
    
    the uuid
  - setUuid
```
void setUuid(java.lang.String uuid)
```
    set the UUID of the product
    
    Parameters:
    
    uuid - the uuid to set
  - getLength
```
int getLength()
```
    Returns:
    
    the length
  - setLength
```
void setLength(int length)
```
    Parameters:
    
    length - the length to set
  - getWidth
```
int getWidth()
```
    Returns:
    
    the width
  - setWidth
```
void setWidth(int width)
```
    Parameters:
    
    width - the width to set
  - getDepth
```
int getDepth()
```
    Returns:
    
    the depth
  - setDepth
```
void setDepth(int depth)
```
    Parameters:
    
    depth - the depth to set
  - getPriceId
```
int getPriceId()
```
    Returns:
    
    the priceId
  - setPriceId
```
void setPriceId(int priceId)
```
    Parameters:
    
    priceId - the priceId to set
  - getBundledProducts
```
ProductIf[] getBundledProducts()
```
    Used to store an array of products bundled by this product. The getBundlesThatProductBelongsTo() API call is the only API call that automatically populates this attribute.
    
    Returns:
    
    the bundledProducts
  - setBundledProducts
```
void setBundledProducts(ProductIf[] bundledProducts)
```
    Used to store an array of products bundled by this product. The getBundlesThatProductBelongsTo() API call is the only API call that automatically populates this attribute.
    
    Parameters:
    
    bundledProducts - the bundledProducts to set
  - getSearchScore
```
java.math.BigDecimal getSearchScore()
```
    The score returned by Solr. Only available when returnSolrScore is set to true in the FetchProductOptions object passed to the API call.
    
    Returns:
    
    the searchScore
  - setSearchScore
```
void setSearchScore(java.math.BigDecimal searchScore)
```
    The score returned by Solr. Only available when returnSolrScore is set to true in the FetchProductOptions object passed to the API call.
    
    Parameters:
    
    searchScore - the searchScore to set
  - isIgnoreProductQuantityStock
```
boolean isIgnoreProductQuantityStock()
```
    When set to true, even if the product has many different SKUs, KonaKart maintains the stock level using the quantity attribute of the product and not the quantity attributes of the array of ProductQuantity objects.
    
    Returns:
    
    the ignoreProductQuantityStock
  - setIgnoreProductQuantityStock
```
void setIgnoreProductQuantityStock(boolean ignoreProductQuantityStock)
```
    When set to true, even if the product has many different SKUs, KonaKart maintains the stock level using the quantity attribute of the product and not the quantity attributes of the array of ProductQuantity objects.
    
    Parameters:
    
    ignoreProductQuantityStock - the ignoreProductQuantityStock to set
  - getQuantityReserved
```
int getQuantityReserved()
```
    This attribute defines the total number of products that are currently reserved.
    
    Returns:
    
    the quantityReserved
  - setQuantityReserved
```
void setQuantityReserved(int quantityReserved)
```
    This attribute defines the total number of products that are currently reserved.
    
    Parameters:
    
    quantityReserved - the quantityReserved to set
  - getStoreName
```
java.lang.String getStoreName()
```
    The name of the store. Populated when in multi-vendor mode.
    
    Returns:
    
    the storeName
  - setStoreName
```
void setStoreName(java.lang.String storeName)
```
    The name of the store. Populated when in multi-vendor mode.
    
    Parameters:
    
    storeName - the storeName to set
  - getStoreDescription
```
java.lang.String getStoreDescription()
```
    The store description. Populated when in multi-vendor mode.
    
    Returns:
    
    the storeDescription
  - setStoreDescription
```
void setStoreDescription(java.lang.String storeDescription)
```
    The store description. Populated when in multi-vendor mode.
    
    Parameters:
    
    storeDescription - the storeDescription to set
  - getSuggestions
```
SuggestionIf[] getSuggestions()
```
    Product Recommendation Suggestions
    
    Returns:
    
    the Product Recommendation Suggestions
  - setSuggestions
```
void setSuggestions(SuggestionIf[] suggestions)
```
    Parameters:
    
    suggestions - the Product Recommendation Suggestions to set
  - getExtDateAvailable
```
java.util.Calendar getExtDateAvailable()
```
    Returns:
    
    the extDateAvailable
  - setExtDateAvailable
```
void setExtDateAvailable(java.util.Calendar extDateAvailable)
```
    Parameters:
    
    extDateAvailable - the extDateAvailable to set
  - getExtQuantity
```
java.lang.Integer getExtQuantity()
```
    Returns:
    
    the extQuantity
  - setExtQuantity
```
void setExtQuantity(java.lang.Integer extQuantity)
```
    Parameters:
    
    extQuantity - the extQuantity to set
  - getExtPrice0
```
java.math.BigDecimal getExtPrice0()
```
    Returns:
    
    the extPrice0
  - setExtPrice0
```
void setExtPrice0(java.math.BigDecimal extPrice0)
```
    Parameters:
    
    extPrice0 - the extPrice0 to set
  - getExtPrice1
```
java.math.BigDecimal getExtPrice1()
```
    Returns:
    
    the extPrice1
  - setExtPrice1
```
void setExtPrice1(java.math.BigDecimal extPrice1)
```
    Parameters:
    
    extPrice1 - the extPrice1 to set
  - getExtPrice2
```
java.math.BigDecimal getExtPrice2()
```
    Returns:
    
    the extPrice2
  - setExtPrice2
```
void setExtPrice2(java.math.BigDecimal extPrice2)
```
    Parameters:
    
    extPrice2 - the extPrice2 to set
  - getExtPrice3
```
java.math.BigDecimal getExtPrice3()
```
    Returns:
    
    the extPrice3
  - setExtPrice3
```
void setExtPrice3(java.math.BigDecimal extPrice3)
```
    Parameters:
    
    extPrice3 - the extPrice3 to set
  - getWeightUOM
```
java.lang.String getWeightUOM()
```
    Weight Unit of Measure
    
    Returns:
    
    the weightUOM
  - setWeightUOM
```
void setWeightUOM(java.lang.String weightUOM)
```
    Weight Unit of Measure
    
    Parameters:
    
    weightUOM - the weightUOM to set
  - getSizeUOM
```
java.lang.String getSizeUOM()
```
    Size Unit of Measure
    
    Returns:
    
    the sizeUOM
  - setSizeUOM
```
void setSizeUOM(java.lang.String sizeUOM)
```
    Size Unit of Measure
    
    Parameters:
    
    sizeUOM - the sizeUOM to set
  - getNetWeightOrVolume
```
java.math.BigDecimal getNetWeightOrVolume()
```
    The weight or volume of the raw product
    
    Returns:
    
    the netWeightOrVolume
  - setNetWeightOrVolume
```
void setNetWeightOrVolume(java.math.BigDecimal netWeightOrVolume)
```
    The weight or volume of the raw product
    
    Parameters:
    
    netWeightOrVolume - the netWeightOrVolume to set
  - getNetWeightOrVolumeUOM
```
java.lang.String getNetWeightOrVolumeUOM()
```
    The unit of measure for the net weight or volume (e.g. kg, litre, lb )
    
    Returns:
    
    the netWeightOrVolumeUOM
  - setNetWeightOrVolumeUOM
```
void setNetWeightOrVolumeUOM(java.lang.String netWeightOrVolumeUOM)
```
    The unit of measure for the net weight or volume (e.g. kg, litre, lb )
    
    Parameters:
    
    netWeightOrVolumeUOM - the netWeightOrVolumeUOM to set
  - getVariantPrices
```
VariantPriceIf[] getVariantPrices()
```
    The variant prices related to the product.
    
    Returns:
    
    the variant prices
  - setVariantPrices
```
void setVariantPrices(VariantPriceIf[] variantPrices)
```
    The variant prices related to the product.
    
    Parameters:
    
    variantPrices - the variantPrices to set
  - getMinQuantityInOrder
```
int getMinQuantityInOrder()
```
    Returns:
    
    the MinQuantityInOrder
  - setMinQuantityInOrder
```
void setMinQuantityInOrder(int minQuantityInOrder)
```
    Parameters:
    
    minQuantityInOrder - the minQuantityInOrder to set
  - getMaxQuantityInOrder
```
int getMaxQuantityInOrder()
```
    Returns:
    
    the MaxQuantityInOrder
  - setMaxQuantityInOrder
```
void setMaxQuantityInOrder(int maxQuantityInOrder)
```
    Parameters:
    
    maxQuantityInOrder - the maxQuantityInOrder to set
  - getDefaultQuantityInOrder
```
int getDefaultQuantityInOrder()
```
    Returns:
    
    the DefaultQuantityInOrder
  - setDefaultQuantityInOrder
```
void setDefaultQuantityInOrder(int defaultQuantityInOrder)
```
    Parameters:
    
    defaultQuantityInOrder - the defaultQuantityInOrder to set
  - isLocked
```
boolean isLocked()
```
    Returns:
    
    whether the product is Locked
  - setLocked
```
void setLocked(boolean locked)
```
    Parameters:
    
    locked - true if product is locked

Interface ProductIf

Method Summary

Method Detail

getCustomObj

setCustomObj

getTaxClassId

setTaxClassId

getManufacturerName

setManufacturerName

getDescription

setDescription

getCustomd1

setCustomd1

getCustomd2

setCustomd2

getCustomd3

setCustomd3

getCustomd4

setCustomd4

getCustomd5

setCustomd5

getCustomd6

setCustomd6

getId

setId

getImage

setImage

getModel

setModel

getName

setName

getOpts

setOpts

getQuantity

setQuantity

getStatus

setStatus

getUrl

setUrl

getViewedCount

setViewedCount

getWeight

setWeight

getNumberReviews

setNumberReviews

getDateAdded

setDateAdded

getDateAvailable

setDateAvailable

getManufacturer

setManufacturer

getManufacturerId

setManufacturerId

getCategoryId

setCategoryId

getOrdered

setOrdered

getPriceExTax

setPriceExTax

getSpecialPriceExTax

setSpecialPriceExTax

getSpecialPriceIncTax

setSpecialPriceIncTax

getPriceIncTax

setPriceIncTax

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustom4

setCustom4

getCustom5

setCustom5

getCustom6

setCustom6

getCustom7

setCustom7

getCustom8