Product (KonaKart Server Engine API Documentation)

java.lang.Object
- com.konakart.app.Product

All Implemented Interfaces:: ProductIf

public class Product
extends java.lang.Object
implements ProductIf

Product class

Constructor Summary

Constructors
Constructor and Description
`Product()` Constructor
`Product(com.workingdogs.village.Record vr, KKCriteria c)` Instantiates the attributes of the Product object from a Record object

Method Summary

All Methods Instance Methods Concrete 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()`
`boolean`	`getDecimalQuantity()` Returns true if the quantity can have a decimal value
`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`	`getMeasureUnitId()`
`int`	`getMinQuantityInOrder()`
`MiscItemIf[]`	`getMiscItems()` Returns the array of Miscellaneous Items associated with this product.
`MiscPriceIf[]`	`getMiscPrices()` Returns the array of 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`	`getQuantityAvailable()`
`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)`
`java.lang.String`	`toString()`
`java.lang.String`	`toStringBrief()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Product
```
public Product()
```
    Constructor
  - Product
```
public Product(com.workingdogs.village.Record vr,
               KKCriteria c)
        throws com.workingdogs.village.DataSetException
```
    Instantiates the attributes of the Product object from a Record object
    
    Parameters:
    
    vr - Record containing data
    
    c - Criteria containing column names
    
    Throws:
    
    com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)
- Method Detail
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    Returns a string containing the attributes of the Product object and those of its Options.
  - toStringBrief
```
public java.lang.String toStringBrief()
```
    Returns:
    
    Returns a string containing selected attributes of the Product object
  - getTaxClassId
```
public int getTaxClassId()
```
    Specified by:
    
    getTaxClassId in interface ProductIf
    
    Returns:
    
    Returns the taxClassId.
  - setTaxClassId
```
public void setTaxClassId(int taxClassId)
```
    Specified by:
    
    setTaxClassId in interface ProductIf
    
    Parameters:
    
    taxClassId - The taxClassId to set.
  - getManufacturerName
```
public java.lang.String getManufacturerName()
```
    Specified by:
    
    getManufacturerName in interface ProductIf
    
    Returns:
    
    Returns the manufacturerName.
  - setManufacturerName
```
public void setManufacturerName(java.lang.String manufacturerName)
```
    Specified by:
    
    setManufacturerName in interface ProductIf
    
    Parameters:
    
    manufacturerName - The manufacturerName to set.
  - getDescription
```
public java.lang.String getDescription()
```
    Specified by:
    
    getDescription in interface ProductIf
    
    Returns:
    
    Returns the description.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Specified by:
    
    setDescription in interface ProductIf
    
    Parameters:
    
    description - The description to set.
  - getId
```
public int getId()
```
    Specified by:
    
    getId in interface ProductIf
    
    Returns:
    
    Returns the id.
  - setId
```
public void setId(int id)
```
    Specified by:
    
    setId in interface ProductIf
    
    Parameters:
    
    id - The id to set.
  - getImage
```
public java.lang.String getImage()
```
    Specified by:
    
    getImage in interface ProductIf
    
    Returns:
    
    Returns the image.
  - setImage
```
public void setImage(java.lang.String image)
```
    Specified by:
    
    setImage in interface ProductIf
    
    Parameters:
    
    image - The image to set.
  - getModel
```
public java.lang.String getModel()
```
    Specified by:
    
    getModel in interface ProductIf
    
    Returns:
    
    Returns the model.
  - setModel
```
public void setModel(java.lang.String model)
```
    Specified by:
    
    setModel in interface ProductIf
    
    Parameters:
    
    model - The model to set.
  - getName
```
public java.lang.String getName()
```
    Specified by:
    
    getName in interface ProductIf
    
    Returns:
    
    Returns the name.
  - setName
```
public void setName(java.lang.String name)
```
    Specified by:
    
    setName in interface ProductIf
    
    Parameters:
    
    name - The name to set.
  - getOpts
```
public OptionIf[] getOpts()
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    getOpts in interface ProductIf
    
    Returns:
    
    Returns the opts.
  - setOpts
```
public void setOpts(OptionIf[] opts)
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    setOpts in interface ProductIf
    
    Parameters:
    
    opts - The opts to set.
  - getQuantity
```
public int getQuantity()
```
    Specified by:
    
    getQuantity in interface ProductIf
    
    Returns:
    
    Returns the quantity.
  - setQuantity
```
public void setQuantity(int quantity)
```
    Specified by:
    
    setQuantity in interface ProductIf
    
    Parameters:
    
    quantity - The quantity to set.
  - getStatus
```
public byte getStatus()
```
    Description copied from interface: ProductIf
    
    Set to '1' if the product is active. Otherwise set to '0'.
    
    Specified by:
    
    getStatus in interface ProductIf
    
    Returns:
    
    Returns the status.
  - setStatus
```
public void setStatus(byte status)
```
    Description copied from interface: ProductIf
    
    Set to '1' if the product is active. Otherwise set to '0'.
    
    Specified by:
    
    setStatus in interface ProductIf
    
    Parameters:
    
    status - The status to set.
  - getUrl
```
public java.lang.String getUrl()
```
    Description copied from interface: ProductIf
    
    The url of the product, for example from the manufacturer's web site.
    
    Specified by:
    
    getUrl in interface ProductIf
    
    Returns:
    
    Returns the url.
  - setUrl
```
public void setUrl(java.lang.String url)
```
    Description copied from interface: ProductIf
    
    The url of the product, for example from the manufacturer's web site.
    
    Specified by:
    
    setUrl in interface ProductIf
    
    Parameters:
    
    url - The url to set.
  - getViewedCount
```
public int getViewedCount()
```
    Description copied from interface: ProductIf
    
    The number of times the product has been viewed.
    
    Specified by:
    
    getViewedCount in interface ProductIf
    
    Returns:
    
    Returns the viewedCount.
  - setViewedCount
```
public void setViewedCount(int viewedCount)
```
    Description copied from interface: ProductIf
    
    The number of times the product has been viewed.
    
    Specified by:
    
    setViewedCount in interface ProductIf
    
    Parameters:
    
    viewedCount - The viewedCount to set.
  - getWeight
```
public java.math.BigDecimal getWeight()
```
    Specified by:
    
    getWeight in interface ProductIf
    
    Returns:
    
    Returns the weight.
  - setWeight
```
public void setWeight(java.math.BigDecimal weight)
```
    Specified by:
    
    setWeight in interface ProductIf
    
    Parameters:
    
    weight - The weight to set.
  - getNumberReviews
```
public int getNumberReviews()
```
    Specified by:
    
    getNumberReviews in interface ProductIf
    
    Returns:
    
    Returns the numberReviews.
  - setNumberReviews
```
public void setNumberReviews(int numberReviews)
```
    Specified by:
    
    setNumberReviews in interface ProductIf
    
    Parameters:
    
    numberReviews - The numberReviews to set.
  - getDateAdded
```
public java.util.Calendar getDateAdded()
```
    Specified by:
    
    getDateAdded in interface ProductIf
    
    Returns:
    
    Returns the dateAdded.
  - setDateAdded
```
public void setDateAdded(java.util.Calendar dateAdded)
```
    Specified by:
    
    setDateAdded in interface ProductIf
    
    Parameters:
    
    dateAdded - The dateAdded to set.
  - getDateAvailable
```
public java.util.Calendar getDateAvailable()
```
    Specified by:
    
    getDateAvailable in interface ProductIf
    
    Returns:
    
    Returns the dateAvailable.
  - setDateAvailable
```
public void setDateAvailable(java.util.Calendar dateAvailable)
```
    Specified by:
    
    setDateAvailable in interface ProductIf
    
    Parameters:
    
    dateAvailable - The dateAvailable to set.
  - getManufacturer
```
public ManufacturerIf getManufacturer()
```
    Specified by:
    
    getManufacturer in interface ProductIf
    
    Returns:
    
    Returns the manufacturer.
  - setManufacturer
```
public void setManufacturer(ManufacturerIf manufacturer)
```
    Specified by:
    
    setManufacturer in interface ProductIf
    
    Parameters:
    
    manufacturer - The manufacturer to set.
  - getManufacturerId
```
public int getManufacturerId()
```
    Specified by:
    
    getManufacturerId in interface ProductIf
    
    Returns:
    
    Returns the manufacturerId.
  - setManufacturerId
```
public void setManufacturerId(int manufacturerId)
```
    Specified by:
    
    setManufacturerId in interface ProductIf
    
    Parameters:
    
    manufacturerId - The manufacturerId to set.
  - getCategoryId
```
public int getCategoryId()
```
    Specified by:
    
    getCategoryId in interface ProductIf
    
    Returns:
    
    Returns the categoryId.
  - setCategoryId
```
public void setCategoryId(int categoryId)
```
    Specified by:
    
    setCategoryId in interface ProductIf
    
    Parameters:
    
    categoryId - The categoryId to set.
  - getOrdered
```
public int getOrdered()
```
    Description copied from interface: ProductIf
    
    The number of times that the product has been ordered.
    
    Specified by:
    
    getOrdered in interface ProductIf
    
    Returns:
    
    Returns the ordered.
  - setOrdered
```
public void setOrdered(int ordered)
```
    Description copied from interface: ProductIf
    
    The number of times that the product has been ordered.
    
    Specified by:
    
    setOrdered in interface ProductIf
    
    Parameters:
    
    ordered - The ordered to set.
  - getPriceExTax
```
public java.math.BigDecimal getPriceExTax()
```
    Specified by:
    
    getPriceExTax in interface ProductIf
    
    Returns:
    
    Returns the priceExTax.
  - setPriceExTax
```
public void setPriceExTax(java.math.BigDecimal priceExTax)
```
    Specified by:
    
    setPriceExTax in interface ProductIf
    
    Parameters:
    
    priceExTax - The priceExTax to set.
  - getSpecialPriceExTax
```
public java.math.BigDecimal getSpecialPriceExTax()
```
    Specified by:
    
    getSpecialPriceExTax in interface ProductIf
    
    Returns:
    
    Returns the specialPriceExTax.
  - setSpecialPriceExTax
```
public void setSpecialPriceExTax(java.math.BigDecimal specialPriceExTax)
```
    Specified by:
    
    setSpecialPriceExTax in interface ProductIf
    
    Parameters:
    
    specialPriceExTax - The specialPriceExTax to set.
  - getSpecialPriceIncTax
```
public java.math.BigDecimal getSpecialPriceIncTax()
```
    Specified by:
    
    getSpecialPriceIncTax in interface ProductIf
    
    Returns:
    
    Returns the specialPriceIncTax.
  - setSpecialPriceIncTax
```
public void setSpecialPriceIncTax(java.math.BigDecimal specialPriceIncTax)
```
    Specified by:
    
    setSpecialPriceIncTax in interface ProductIf
    
    Parameters:
    
    specialPriceIncTax - The specialPriceIncTax to set.
  - getPriceIncTax
```
public java.math.BigDecimal getPriceIncTax()
```
    Specified by:
    
    getPriceIncTax in interface ProductIf
    
    Returns:
    
    Returns the priceIncTax.
  - setPriceIncTax
```
public void setPriceIncTax(java.math.BigDecimal priceIncTax)
```
    Specified by:
    
    setPriceIncTax in interface ProductIf
    
    Parameters:
    
    priceIncTax - The priceIncTax to set.
  - getCustom1
```
public java.lang.String getCustom1()
```
    Specified by:
    
    getCustom1 in interface ProductIf
    
    Returns:
    
    Returns the custom1.
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Specified by:
    
    setCustom1 in interface ProductIf
    
    Parameters:
    
    custom1 - The custom1 to set.
  - getCustom2
```
public java.lang.String getCustom2()
```
    Specified by:
    
    getCustom2 in interface ProductIf
    
    Returns:
    
    Returns the custom2.
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Specified by:
    
    setCustom2 in interface ProductIf
    
    Parameters:
    
    custom2 - The custom2 to set.
  - getCustom3
```
public java.lang.String getCustom3()
```
    Specified by:
    
    getCustom3 in interface ProductIf
    
    Returns:
    
    Returns the custom3.
  - setCustom3
```
public void setCustom3(java.lang.String custom3)
```
    Specified by:
    
    setCustom3 in interface ProductIf
    
    Parameters:
    
    custom3 - The custom3 to set.
  - getCustom4
```
public java.lang.String getCustom4()
```
    Specified by:
    
    getCustom4 in interface ProductIf
    
    Returns:
    
    Returns the custom4.
  - setCustom4
```
public void setCustom4(java.lang.String custom4)
```
    Specified by:
    
    setCustom4 in interface ProductIf
    
    Parameters:
    
    custom4 - The custom4 to set.
  - getCustom5
```
public java.lang.String getCustom5()
```
    Specified by:
    
    getCustom5 in interface ProductIf
    
    Returns:
    
    Returns the custom5.
  - setCustom5
```
public void setCustom5(java.lang.String custom5)
```
    Specified by:
    
    setCustom5 in interface ProductIf
    
    Parameters:
    
    custom5 - The custom5 to set.
  - getProdRelationTypeArray
```
public int[] getProdRelationTypeArray()
```
    Description copied from interface: ProductIf
    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.
    Specified by:
    
    getProdRelationTypeArray in interface ProductIf
    
    Returns:
    
    Returns the prodRelationTypeArray.
  - setProdRelationTypeArray
```
public void setProdRelationTypeArray(int[] prodRelationTypeArray)
```
    Description copied from interface: ProductIf
    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.
    Specified by:
    
    setProdRelationTypeArray in interface ProductIf
    
    Parameters:
    
    prodRelationTypeArray - The prodRelationTypeArray to set.
  - getInvisible
```
public byte getInvisible()
```
    Description copied from interface: ProductIf
    
    When set to '1' the product is invisible and will not be returned from normal API calls.
    
    Specified by:
    
    getInvisible in interface ProductIf
    
    Returns:
    
    Returns the invisible.
  - setInvisible
```
public void setInvisible(byte invisible)
```
    Description copied from interface: ProductIf
    
    When set to '1' the product is invisible and will not be returned from normal API calls.
    
    Specified by:
    
    setInvisible in interface ProductIf
    
    Parameters:
    
    invisible - The invisible to set.
  - getSku
```
public java.lang.String getSku()
```
    Description copied from interface: ProductIf
    
    The SKU is the stock keeping unit.
    
    Specified by:
    
    getSku in interface ProductIf
    
    Returns:
    
    Returns the sku.
  - setSku
```
public void setSku(java.lang.String sku)
```
    Description copied from interface: ProductIf
    
    The SKU is the stock keeping unit.
    
    Specified by:
    
    setSku in interface ProductIf
    
    Parameters:
    
    sku - The sku to set.
  - getContentType
```
public java.lang.String getContentType()
```
    Description copied from interface: ProductIf
    
    Valid for digital products. The Content Type describes the content of the file. Examples are "image/jpeg" or "application/pdf".
    
    Specified by:
    
    getContentType in interface ProductIf
    
    Returns:
    
    Returns the contentType.
  - setContentType
```
public void setContentType(java.lang.String contentType)
```
    Description copied from interface: ProductIf
    
    Valid for digital products. The Content Type describes the content of the file. Examples are "image/jpeg" or "application/pdf".
    
    Specified by:
    
    setContentType in interface ProductIf
    
    Parameters:
    
    contentType - The contentType to set.
  - getFilePath
```
public java.lang.String getFilePath()
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    getFilePath in interface ProductIf
    
    Returns:
    
    Returns the filePath.
  - setFilePath
```
public void setFilePath(java.lang.String filePath)
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    setFilePath in interface ProductIf
    
    Parameters:
    
    filePath - The filePath to set.
  - getType
```
public int getType()
```
    Description copied from interface: ProductIf
    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
    Specified by:
    
    getType in interface ProductIf
    
    Returns:
    
    Returns the type.
  - setType
```
public void setType(int type)
```
    Description copied from interface: ProductIf
    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
    Specified by:
    
    setType in interface ProductIf
    
    Parameters:
    
    type - The type to set.
  - getImage2
```
public java.lang.String getImage2()
```
    Specified by:
    
    getImage2 in interface ProductIf
    
    Returns:
    
    Returns the image2.
  - setImage2
```
public void setImage2(java.lang.String image2)
```
    Specified by:
    
    setImage2 in interface ProductIf
    
    Parameters:
    
    image2 - The image2 to set.
  - getImage3
```
public java.lang.String getImage3()
```
    Specified by:
    
    getImage3 in interface ProductIf
    
    Returns:
    
    Returns the image3.
  - setImage3
```
public void setImage3(java.lang.String image3)
```
    Specified by:
    
    setImage3 in interface ProductIf
    
    Parameters:
    
    image3 - The image3 to set.
  - getImage4
```
public java.lang.String getImage4()
```
    Specified by:
    
    getImage4 in interface ProductIf
    
    Returns:
    
    Returns the image4.
  - setImage4
```
public void setImage4(java.lang.String image4)
```
    Specified by:
    
    setImage4 in interface ProductIf
    
    Parameters:
    
    image4 - The image4 to set.
  - getImages
```
public 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.
    
    Specified by:
    
    getImages in interface ProductIf
    
    Returns:
    
    the images
  - setImages
```
public 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.
    
    Specified by:
    
    setImages in interface ProductIf
    
    Parameters:
    
    images - the images to set
  - getImageDir
```
public java.lang.String getImageDir()
```
    Get the name of the directory where the product image is located
    
    Specified by:
    
    getImageDir in interface ProductIf
    
    Returns:
    
    Returns the imageDir.
  - setImageDir
```
public void setImageDir(java.lang.String imageDir)
```
    Set the name of the directory where the product image is located
    
    Specified by:
    
    setImageDir in interface ProductIf
    
    Parameters:
    
    imageDir - The imageDir to set.
  - getComparison
```
public java.lang.String getComparison()
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    getComparison in interface ProductIf
    
    Returns:
    
    Returns the comparison.
  - setComparison
```
public void setComparison(java.lang.String comparison)
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    setComparison in interface ProductIf
    
    Parameters:
    
    comparison - The comparison to set.
  - getPrice0
```
public java.math.BigDecimal getPrice0()
```
    Specified by:
    
    getPrice0 in interface ProductIf
    
    Returns:
    
    Returns the price0.
  - setPrice0
```
public void setPrice0(java.math.BigDecimal price0)
```
    Specified by:
    
    setPrice0 in interface ProductIf
    
    Parameters:
    
    price0 - The price0 to set.
  - getPrice1
```
public java.math.BigDecimal getPrice1()
```
    Specified by:
    
    getPrice1 in interface ProductIf
    
    Returns:
    
    Returns the price1.
  - setPrice1
```
public void setPrice1(java.math.BigDecimal price1)
```
    Specified by:
    
    setPrice1 in interface ProductIf
    
    Parameters:
    
    price1 - The price1 to set.
  - getPrice2
```
public java.math.BigDecimal getPrice2()
```
    Specified by:
    
    getPrice2 in interface ProductIf
    
    Returns:
    
    Returns the price2.
  - setPrice2
```
public void setPrice2(java.math.BigDecimal price2)
```
    Specified by:
    
    setPrice2 in interface ProductIf
    
    Parameters:
    
    price2 - The price2 to set.
  - getPrice3
```
public java.math.BigDecimal getPrice3()
```
    Specified by:
    
    getPrice3 in interface ProductIf
    
    Returns:
    
    Returns the price3.
  - setPrice3
```
public void setPrice3(java.math.BigDecimal price3)
```
    Specified by:
    
    setPrice3 in interface ProductIf
    
    Parameters:
    
    price3 - The price3 to set.
  - getFormattedPrice
```
public java.lang.String getFormattedPrice()
```
    Specified by:
    
    getFormattedPrice in interface ProductIf
    
    Returns:
    
    the formattedPrice
  - setFormattedPrice
```
public void setFormattedPrice(java.lang.String formattedPrice)
```
    Specified by:
    
    setFormattedPrice in interface ProductIf
    
    Parameters:
    
    formattedPrice - the formattedPrice to set
  - getBundledProdQuantity
```
public int getBundledProdQuantity()
```
    Description copied from interface: ProductIf
    
    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
    
    Specified by:
    
    getBundledProdQuantity in interface ProductIf
    
    Returns:
    
    Returns the bundledProdQuantity.
  - setBundledProdQuantity
```
public void setBundledProdQuantity(int bundledProdQuantity)
```
    Description copied from interface: ProductIf
    
    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
    
    Specified by:
    
    setBundledProdQuantity in interface ProductIf
    
    Parameters:
    
    bundledProdQuantity - The bundledProdQuantity to set.
  - getEncodedOptionValues
```
public java.lang.String getEncodedOptionValues()
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    getEncodedOptionValues in interface ProductIf
    
    Returns:
    
    Returns the encodedOptionValues.
  - setEncodedOptionValues
```
public void setEncodedOptionValues(java.lang.String encodedOptionValues)
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    setEncodedOptionValues in interface ProductIf
    
    Parameters:
    
    encodedOptionValues - The encodedOptionValues to set.
  - getTags
```
public TagIf[] getTags()
```
    Specified by:
    
    getTags in interface ProductIf
    
    Returns:
    
    Returns the tags.
  - setTags
```
public void setTags(TagIf[] tags)
```
    Specified by:
    
    setTags in interface ProductIf
    
    Parameters:
    
    tags - The tags to set.
  - getStoreId
```
public java.lang.String getStoreId()
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    getStoreId in interface ProductIf
    
    Returns:
    
    the storeId
  - setStoreId
```
public void setStoreId(java.lang.String storeId)
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    setStoreId in interface ProductIf
    
    Parameters:
    
    storeId - the storeId to set
  - getMaxNumDownloads
```
public int getMaxNumDownloads()
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    getMaxNumDownloads in interface ProductIf
    
    Returns:
    
    the maxNumDownloads
  - setMaxNumDownloads
```
public void setMaxNumDownloads(int maxNumDownloads)
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    setMaxNumDownloads in interface ProductIf
    
    Parameters:
    
    maxNumDownloads - the maxNumDownloads to set
  - getMaxDownloadDays
```
public int getMaxDownloadDays()
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    getMaxDownloadDays in interface ProductIf
    
    Returns:
    
    the maxDownloadDays
  - setMaxDownloadDays
```
public void setMaxDownloadDays(int maxDownloadDays)
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    setMaxDownloadDays in interface ProductIf
    
    Parameters:
    
    maxDownloadDays - the maxDownloadDays to set
  - getStockReorderLevel
```
public int getStockReorderLevel()
```
    Description copied from interface: ProductIf
    
    Product needs to be reordered when the stock hits this level. If negative, then the configuration variable value (STOCK_REORDER_LEVEL) will be used.
    
    Specified by:
    
    getStockReorderLevel in interface ProductIf
    
    Returns:
    
    the stockReorderLevel
  - setStockReorderLevel
```
public void setStockReorderLevel(int stockReorderLevel)
```
    Description copied from interface: ProductIf
    
    Product needs to be reordered when the stock hits this level. If negative, then the configuration variable value (STOCK_REORDER_LEVEL) will be used.
    
    Specified by:
    
    setStockReorderLevel in interface ProductIf
    
    Parameters:
    
    stockReorderLevel - the stockReorderLevel to set
  - getCanOrderWhenNotInStock
```
public java.lang.Boolean getCanOrderWhenNotInStock()
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    getCanOrderWhenNotInStock in interface ProductIf
    
    Returns:
    
    the canOrderWhenNotInStock
  - setCanOrderWhenNotInStock
```
public void setCanOrderWhenNotInStock(java.lang.Boolean canOrderWhenNotInStock)
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    setCanOrderWhenNotInStock in interface ProductIf
    
    Parameters:
    
    canOrderWhenNotInStock - the canOrderWhenNotInStock to set
  - getPriceId
```
public int getPriceId()
```
    Specified by:
    
    getPriceId in interface ProductIf
    
    Returns:
    
    the priceId
  - setPriceId
```
public void setPriceId(int priceId)
```
    Specified by:
    
    setPriceId in interface ProductIf
    
    Parameters:
    
    priceId - the priceId to set
  - isIndexAttachment
```
public boolean isIndexAttachment()
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    isIndexAttachment in interface ProductIf
    
    Returns:
    
    the indexAttachment
  - setIndexAttachment
```
public void setIndexAttachment(boolean indexAttachment)
```
    Description copied from interface: ProductIf
    
    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.
    
    Specified by:
    
    setIndexAttachment in interface ProductIf
    
    Parameters:
    
    indexAttachment - the indexAttachment to set
  - getSnippets
```
public java.lang.String[] getSnippets()
```
    Array of strings containing snippets which are text fragments surrounding the search keywords.
    
    Specified by:
    
    getSnippets in interface ProductIf
    
    Returns:
    
    the snippets
  - setSnippets
```
public void setSnippets(java.lang.String[] snippets)
```
    Array of strings containing snippets which are text fragments surrounding the search keywords.
    
    Specified by:
    
    setSnippets in interface ProductIf
    
    Parameters:
    
    snippets - the snippets to set
  - getRating
```
public java.math.BigDecimal getRating()
```
    Description copied from interface: ProductIf
    
    Average product rating
    
    Specified by:
    
    getRating in interface ProductIf
    
    Returns:
    
    the rating
  - setRating
```
public void setRating(java.math.BigDecimal rating)
```
    Description copied from interface: ProductIf
    
    Average product rating
    
    Specified by:
    
    setRating in interface ProductIf
    
    Parameters:
    
    rating - the rating to set
  - getExpiryDate
```
public java.util.Calendar getExpiryDate()
```
    Description copied from interface: ProductIf
    
    The date that the product expires
    
    Specified by:
    
    getExpiryDate in interface ProductIf
    
    Returns:
    
    the expiryDate
  - setExpiryDate
```
public void setExpiryDate(java.util.Calendar expiryDate)
```
    Description copied from interface: ProductIf
    
    The date that the product expires
    
    Specified by:
    
    setExpiryDate in interface ProductIf
    
    Parameters:
    
    expiryDate - the expiryDate to set
  - getCustom6
```
public java.lang.String getCustom6()
```
    Specified by:
    
    getCustom6 in interface ProductIf
    
    Returns:
    
    the custom6
  - setCustom6
```
public void setCustom6(java.lang.String custom6)
```
    Specified by:
    
    setCustom6 in interface ProductIf
    
    Parameters:
    
    custom6 - the custom6 to set
  - getCustom7
```
public java.lang.String getCustom7()
```
    Specified by:
    
    getCustom7 in interface ProductIf
    
    Returns:
    
    the custom7
  - setCustom7
```
public void setCustom7(java.lang.String custom7)
```
    Specified by:
    
    setCustom7 in interface ProductIf
    
    Parameters:
    
    custom7 - the custom7 to set
  - getCustom8
```
public java.lang.String getCustom8()
```
    Specified by:
    
    getCustom8 in interface ProductIf
    
    Returns:
    
    the custom8
  - setCustom8
```
public void setCustom8(java.lang.String custom8)
```
    Specified by:
    
    setCustom8 in interface ProductIf
    
    Parameters:
    
    custom8 - the custom8 to set
  - getCustom9
```
public java.lang.String getCustom9()
```
    Specified by:
    
    getCustom9 in interface ProductIf
    
    Returns:
    
    the custom9
  - setCustom9
```
public void setCustom9(java.lang.String custom9)
```
    Specified by:
    
    setCustom9 in interface ProductIf
    
    Parameters:
    
    custom9 - the custom9 to set
  - getCustom10
```
public java.lang.String getCustom10()
```
    Specified by:
    
    getCustom10 in interface ProductIf
    
    Returns:
    
    the custom10
  - setCustom10
```
public void setCustom10(java.lang.String custom10)
```
    Specified by:
    
    setCustom10 in interface ProductIf
    
    Parameters:
    
    custom10 - the custom10 to set
  - getCustom11
```
public java.lang.String getCustom11()
```
    Specified by:
    
    getCustom11 in interface ProductIf
    
    Returns:
    
    the custom11
  - setCustom11
```
public void setCustom11(java.lang.String custom11)
```
    Specified by:
    
    setCustom11 in interface ProductIf
    
    Parameters:
    
    custom11 - the custom11 to set
  - getCustom1Int
```
public int getCustom1Int()
```
    Specified by:
    
    getCustom1Int in interface ProductIf
    
    Returns:
    
    the custom1Int
  - setCustom1Int
```
public void setCustom1Int(int custom1Int)
```
    Specified by:
    
    setCustom1Int in interface ProductIf
    
    Parameters:
    
    custom1Int - the custom1Int to set
  - getCustom2Int
```
public int getCustom2Int()
```
    Specified by:
    
    getCustom2Int in interface ProductIf
    
    Returns:
    
    the custom2Int
  - setCustom2Int
```
public void setCustom2Int(int custom2Int)
```
    Specified by:
    
    setCustom2Int in interface ProductIf
    
    Parameters:
    
    custom2Int - the custom2Int to set
  - getCustom1Dec
```
public java.math.BigDecimal getCustom1Dec()
```
    Specified by:
    
    getCustom1Dec in interface ProductIf
    
    Returns:
    
    the custom1Dec
  - setCustom1Dec
```
public void setCustom1Dec(java.math.BigDecimal custom1Dec)
```
    Specified by:
    
    setCustom1Dec in interface ProductIf
    
    Parameters:
    
    custom1Dec - the custom1Dec to set
  - getCustom2Dec
```
public java.math.BigDecimal getCustom2Dec()
```
    Specified by:
    
    getCustom2Dec in interface ProductIf
    
    Returns:
    
    the custom2Dec
  - setCustom2Dec
```
public void setCustom2Dec(java.math.BigDecimal custom2Dec)
```
    Specified by:
    
    setCustom2Dec in interface ProductIf
    
    Parameters:
    
    custom2Dec - the custom2Dec to set
  - getPaymentScheduleId
```
public int getPaymentScheduleId()
```
    Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.
    
    Specified by:
    
    getPaymentScheduleId in interface ProductIf
    
    Returns:
    
    the paymentScheduleId
  - setPaymentScheduleId
```
public void setPaymentScheduleId(int paymentScheduleId)
```
    Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.
    
    Specified by:
    
    setPaymentScheduleId in interface ProductIf
    
    Parameters:
    
    paymentScheduleId - the paymentScheduleId to set
  - getPaymentSchedule
```
public PaymentScheduleIf getPaymentSchedule()
```
    A product may be associated to a PaymentSchedule object when it is paid for using recurring billing.
    
    Specified by:
    
    getPaymentSchedule in interface ProductIf
    
    Returns:
    
    the paymentSchedule
  - setPaymentSchedule
```
public void setPaymentSchedule(PaymentScheduleIf paymentSchedule)
```
    A product may be associated to a PaymentSchedule object when it is paid for using recurring billing.
    
    Specified by:
    
    setPaymentSchedule in interface ProductIf
    
    Parameters:
    
    paymentSchedule - the paymentSchedule to set
  - getTierPrices
```
public TierPriceIf[] getTierPrices()
```
    Description copied from interface: ProductIf
    
    An array of tier price objects for this product
    
    Specified by:
    
    getTierPrices in interface ProductIf
    
    Returns:
    
    the tierPrices
  - setTierPrices
```
public void setTierPrices(TierPriceIf[] tierPrices)
```
    Description copied from interface: ProductIf
    
    An array of tier price objects for this product
    
    Specified by:
    
    setTierPrices in interface ProductIf
    
    Parameters:
    
    tierPrices - the tierPrices to set
  - getSpecialExpiryDate
```
public java.util.Calendar getSpecialExpiryDate()
```
    Description copied from interface: ProductIf
    
    The date when the special price expires
    
    Specified by:
    
    getSpecialExpiryDate in interface ProductIf
    
    Returns:
    
    the specialExpiryDate
  - setSpecialExpiryDate
```
public void setSpecialExpiryDate(java.util.Calendar specialExpiryDate)
```
    Description copied from interface: ProductIf
    
    The date when the special price expires
    
    Specified by:
    
    setSpecialExpiryDate in interface ProductIf
    
    Parameters:
    
    specialExpiryDate - the specialExpiryDate to set
  - getSpecialStartDate
```
public java.util.Calendar getSpecialStartDate()
```
    Description copied from interface: ProductIf
    
    The date when the special price starts
    
    Specified by:
    
    getSpecialStartDate in interface ProductIf
    
    Returns:
    
    the specialStartDate
  - setSpecialStartDate
```
public void setSpecialStartDate(java.util.Calendar specialStartDate)
```
    Description copied from interface: ProductIf
    
    The date when the special price starts
    
    Specified by:
    
    setSpecialStartDate in interface ProductIf
    
    Parameters:
    
    specialStartDate - the specialStartDate to set
  - getSpecialStatus
```
public byte getSpecialStatus()
```
    Description copied from interface: ProductIf
    
    Set to '1' if the special price is active. Otherwise set to '0'.
    
    Specified by:
    
    getSpecialStatus in interface ProductIf
    
    Returns:
    
    the specialStatus
  - setSpecialStatus
```
public void setSpecialStatus(byte specialStatus)
```
    Description copied from interface: ProductIf
    
    Set to '1' if the special price is active. Otherwise set to '0'.
    
    Specified by:
    
    setSpecialStatus in interface ProductIf
    
    Parameters:
    
    specialStatus - the specialStatus to set
  - getProductQuantities
```
public 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.
    
    Specified by:
    
    getProductQuantities in interface ProductIf
    
    Returns:
    
    the productQuantities
  - setProductQuantities
```
public 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.
    
    Specified by:
    
    setProductQuantities in interface ProductIf
    
    Parameters:
    
    productQuantities - the productQuantities to set
  - getAddresses
```
public AddressIf[] getAddresses()
```
    Description copied from interface: ProductIf
    
    An array containing all of the addresses defined for this product.
    
    Specified by:
    
    getAddresses in interface ProductIf
    
    Returns:
    
    the addresses
  - setAddresses
```
public void setAddresses(AddressIf[] addresses)
```
    Description copied from interface: ProductIf
    
    An array containing all of the addresses defined for this product.
    
    Specified by:
    
    setAddresses in interface ProductIf
    
    Parameters:
    
    addresses - the addresses to set
  - getCustomAttrs
```
public java.lang.String getCustomAttrs()
```
    Contains the custom attributes in XML format
    
    Specified by:
    
    getCustomAttrs in interface ProductIf
    
    Returns:
    
    the customAttrs
  - setCustomAttrs
```
public void setCustomAttrs(java.lang.String customAttrs)
```
    Contains the custom attributes in XML format
    
    Specified by:
    
    setCustomAttrs in interface ProductIf
    
    Parameters:
    
    customAttrs - the customAttrs to set
  - getCustomAttrArray
```
public ProdCustAttrIf[] getCustomAttrArray()
```
    An array of ProdCustAttr objects
    
    Specified by:
    
    getCustomAttrArray in interface ProductIf
    
    Returns:
    
    the customAttrArray
  - setCustomAttrArray
```
public void setCustomAttrArray(ProdCustAttrIf[] customAttrArray)
```
    An array of ProdCustAttr objects
    
    Specified by:
    
    setCustomAttrArray in interface ProductIf
    
    Parameters:
    
    customAttrArray - the customAttrArray to set
  - getTaxCode
```
public java.lang.String getTaxCode()
```
    Description copied from interface: ProductIf
    
    tax code used when looking up tax from an external service
    
    Specified by:
    
    getTaxCode in interface ProductIf
    
    Returns:
    
    the taxCode
  - setTaxCode
```
public void setTaxCode(java.lang.String taxCode)
```
    Description copied from interface: ProductIf
    
    tax code used when looking up tax from an external service
    
    Specified by:
    
    setTaxCode in interface ProductIf
    
    Parameters:
    
    taxCode - the taxCode to set
  - getStoreCustom1
```
public java.lang.String getStoreCustom1()
```
    Custom field with unique value for a store when in multi-store shared products mode
    
    Specified by:
    
    getStoreCustom1 in interface ProductIf
    
    Returns:
    
    the storeCustom1
  - setStoreCustom1
```
public void setStoreCustom1(java.lang.String storeCustom1)
```
    Custom field with unique value for a store when in multi-store shared products mode
    
    Specified by:
    
    setStoreCustom1 in interface ProductIf
    
    Parameters:
    
    storeCustom1 - the storeCustom1 to set
  - getStoreCustom2
```
public java.lang.String getStoreCustom2()
```
    Custom field with unique value for a store when in multi-store shared products mode
    
    Specified by:
    
    getStoreCustom2 in interface ProductIf
    
    Returns:
    
    the storeCustom2
  - setStoreCustom2
```
public void setStoreCustom2(java.lang.String storeCustom2)
```
    Custom field with unique value for a store when in multi-store shared products mode
    
    Specified by:
    
    setStoreCustom2 in interface ProductIf
    
    Parameters:
    
    storeCustom2 - the storeCustom2 to set
  - getStoreCustom3
```
public java.lang.String getStoreCustom3()
```
    Custom field with unique value for a store when in multi-store shared products mode
    
    Specified by:
    
    getStoreCustom3 in interface ProductIf
    
    Returns:
    
    the storeCustom3
  - setStoreCustom3
```
public void setStoreCustom3(java.lang.String storeCustom3)
```
    Custom field with unique value for a store when in multi-store shared products mode
    
    Specified by:
    
    setStoreCustom3 in interface ProductIf
    
    Parameters:
    
    storeCustom3 - the storeCustom3 to set
  - getBookableProd
```
public BookableProductIf getBookableProd()
```
    An object containing attributes relevant to a bookable product
    
    Specified by:
    
    getBookableProd in interface ProductIf
    
    Returns:
    
    the bookableProd
  - setBookableProd
```
public void setBookableProd(BookableProductIf bookableProd)
```
    An object containing attributes relevant to a bookable product
    
    Specified by:
    
    setBookableProd in interface ProductIf
    
    Parameters:
    
    bookableProd - the bookableProd to set
  - getMiscItems
```
public MiscItemIf[] getMiscItems()
```
    Returns the array of Miscellaneous Items associated with this product.
    
    Specified by:
    
    getMiscItems in interface ProductIf
    
    Returns:
    
    the miscItems associated with this product.
  - setMiscItems
```
public void setMiscItems(MiscItemIf[] miscItems)
```
    Description copied from interface: ProductIf
    
    Miscellaneous Items associated with this product. The miscellaneous items are ordered by the name of the item type.
    
    Specified by:
    
    setMiscItems in interface ProductIf
    
    Parameters:
    
    miscItems - the miscItems to set
  - getMiscPrices
```
public MiscPriceIf[] getMiscPrices()
```
    Returns the array of Miscellaneous Prices associated with this product.
    
    Specified by:
    
    getMiscPrices in interface ProductIf
    
    Returns:
    
    the miscPrices associated with this product.
  - setMiscPrices
```
public void setMiscPrices(MiscPriceIf[] miscPrices)
```
    Description copied from interface: ProductIf
    
    Miscellaneous Prices associated with this product
    
    Specified by:
    
    setMiscPrices in interface ProductIf
    
    Parameters:
    
    miscPrices - the miscPrices to set
  - getPromotionResults
```
public PromotionResultIf[] getPromotionResults()
```
    Active promotions for this product
    
    Specified by:
    
    getPromotionResults in interface ProductIf
    
    Returns:
    
    the promotionResults
  - setPromotionResults
```
public void setPromotionResults(PromotionResultIf[] promotionResults)
```
    Active promotions for this product
    
    Specified by:
    
    setPromotionResults in interface ProductIf
    
    Parameters:
    
    promotionResults - the promotionResults to set
  - getTemplateId
```
@Deprecated
public int getTemplateId()
```
    Deprecated.
    
    Description copied from interface: ProductIf
    
    Id of the custom attribute template
    
    Specified by:
    
    getTemplateId in interface ProductIf
    
    Returns:
    
    the templateId
  - setTemplateId
```
@Deprecated
public void setTemplateId(int templateId)
```
    Deprecated.
    
    Description copied from interface: ProductIf
    
    Id of the custom attribute template
    
    Specified by:
    
    setTemplateId in interface ProductIf
    
    Parameters:
    
    templateId - the templateId to set
  - getUuid
```
public java.lang.String getUuid()
```
    Description copied from interface: ProductIf
    
    Get the UUID of the product
    
    Specified by:
    
    getUuid in interface ProductIf
    
    Returns:
    
    the uuid
  - setUuid
```
public void setUuid(java.lang.String uuid)
```
    Description copied from interface: ProductIf
    
    set the UUID of the product
    
    Specified by:
    
    setUuid in interface ProductIf
    
    Parameters:
    
    uuid - the uuid to set
  - getLength
```
public int getLength()
```
    Specified by:
    
    getLength in interface ProductIf
    
    Returns:
    
    the length
  - setLength
```
public void setLength(int length)
```
    Specified by:
    
    setLength in interface ProductIf
    
    Parameters:
    
    length - the length to set
  - getWidth
```
public int getWidth()
```
    Specified by:
    
    getWidth in interface ProductIf
    
    Returns:
    
    the width
  - setWidth
```
public void setWidth(int width)
```
    Specified by:
    
    setWidth in interface ProductIf
    
    Parameters:
    
    width - the width to set
  - getDepth
```
public int getDepth()
```
    Specified by:
    
    getDepth in interface ProductIf
    
    Returns:
    
    the depth
  - setDepth
```
public void setDepth(int depth)
```
    Specified by:
    
    setDepth in interface ProductIf
    
    Parameters:
    
    depth - the depth to set
  - getCustomObj
```
public java.lang.Object getCustomObj()
```
    Description copied from interface: ProductIf
    
    Returns the transient Custom Object. Does not take part in the KonaKart APIs.
    
    Specified by:
    
    getCustomObj in interface ProductIf
    
    Returns:
    
    the customObj
  - setCustomObj
```
public void setCustomObj(java.lang.Object customObj)
```
    Description copied from interface: ProductIf
    
    Set the transient Custom Object. Does not take part in the KonaKart APIs.
    
    Specified by:
    
    setCustomObj in interface ProductIf
    
    Parameters:
    
    customObj - the customObj to set
  - getCustomd1
```
public java.lang.String getCustomd1()
```
    Specified by:
    
    getCustomd1 in interface ProductIf
    
    Returns:
    
    the customd1
  - setCustomd1
```
public void setCustomd1(java.lang.String customd1)
```
    Specified by:
    
    setCustomd1 in interface ProductIf
    
    Parameters:
    
    customd1 - the customd1 to set
  - getCustomd2
```
public java.lang.String getCustomd2()
```
    Specified by:
    
    getCustomd2 in interface ProductIf
    
    Returns:
    
    the customd2
  - setCustomd2
```
public void setCustomd2(java.lang.String customd2)
```
    Specified by:
    
    setCustomd2 in interface ProductIf
    
    Parameters:
    
    customd2 - the customd2 to set
  - getCustomd3
```
public java.lang.String getCustomd3()
```
    Specified by:
    
    getCustomd3 in interface ProductIf
    
    Returns:
    
    the customd3
  - setCustomd3
```
public void setCustomd3(java.lang.String customd3)
```
    Specified by:
    
    setCustomd3 in interface ProductIf
    
    Parameters:
    
    customd3 - the customd3 to set
  - getCustomd4
```
public java.lang.String getCustomd4()
```
    Specified by:
    
    getCustomd4 in interface ProductIf
    
    Returns:
    
    the customd4
  - setCustomd4
```
public void setCustomd4(java.lang.String customd4)
```
    Specified by:
    
    setCustomd4 in interface ProductIf
    
    Parameters:
    
    customd4 - the customd4 to set
  - getCustomd5
```
public java.lang.String getCustomd5()
```
    Specified by:
    
    getCustomd5 in interface ProductIf
    
    Returns:
    
    the customd5
  - setCustomd5
```
public void setCustomd5(java.lang.String customd5)
```
    Specified by:
    
    setCustomd5 in interface ProductIf
    
    Parameters:
    
    customd5 - the customd5 to set
  - getCustomd6
```
public java.lang.String getCustomd6()
```
    Specified by:
    
    getCustomd6 in interface ProductIf
    
    Returns:
    
    the customd6
  - setCustomd6
```
public void setCustomd6(java.lang.String customd6)
```
    Specified by:
    
    setCustomd6 in interface ProductIf
    
    Parameters:
    
    customd6 - the customd6 to set
  - getBundledProducts
```
public 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.
    
    Specified by:
    
    getBundledProducts in interface ProductIf
    
    Returns:
    
    the bundledProducts
  - setBundledProducts
```
public 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.
    
    Specified by:
    
    setBundledProducts in interface ProductIf
    
    Parameters:
    
    bundledProducts - the bundledProducts to set
  - getSearchScore
```
public 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.
    
    Specified by:
    
    getSearchScore in interface ProductIf
    
    Returns:
    
    the searchScore
  - setSearchScore
```
public 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.
    
    Specified by:
    
    setSearchScore in interface ProductIf
    
    Parameters:
    
    searchScore - the searchScore to set
  - isIgnoreProductQuantityStock
```
public 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.
    
    Specified by:
    
    isIgnoreProductQuantityStock in interface ProductIf
    
    Returns:
    
    the ignoreProductQuantityStock
  - setIgnoreProductQuantityStock
```
public 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.
    
    Specified by:
    
    setIgnoreProductQuantityStock in interface ProductIf
    
    Parameters:
    
    ignoreProductQuantityStock - the ignoreProductQuantityStock to set
  - getQuantityReserved
```
public int getQuantityReserved()
```
    Description copied from interface: ProductIf
    
    This attribute defines the total number of products that are currently reserved.
    
    Specified by:
    
    getQuantityReserved in interface ProductIf
    
    Returns:
    
    the quantityReserved
  - setQuantityReserved
```
public void setQuantityReserved(int quantityReserved)
```
    Description copied from interface: ProductIf
    
    This attribute defines the total number of products that are currently reserved.
    
    Specified by:
    
    setQuantityReserved in interface ProductIf
    
    Parameters:
    
    quantityReserved - the quantityReserved to set
  - getQuantityAvailable
```
public int getQuantityAvailable()
```
    Returns:
    
    the quantityAvailable
  - getStoreName
```
public java.lang.String getStoreName()
```
    The name of the store. Populated when in multi-vendor mode.
    
    Specified by:
    
    getStoreName in interface ProductIf
    
    Returns:
    
    the storeName
  - setStoreName
```
public void setStoreName(java.lang.String storeName)
```
    The name of the store. Populated when in multi-vendor mode.
    
    Specified by:
    
    setStoreName in interface ProductIf
    
    Parameters:
    
    storeName - the storeName to set
  - getStoreDescription
```
public java.lang.String getStoreDescription()
```
    The store description. Populated when in multi-vendor mode.
    
    Specified by:
    
    getStoreDescription in interface ProductIf
    
    Returns:
    
    the storeDescription
  - setStoreDescription
```
public void setStoreDescription(java.lang.String storeDescription)
```
    The store description. Populated when in multi-vendor mode.
    
    Specified by:
    
    setStoreDescription in interface ProductIf
    
    Parameters:
    
    storeDescription - the storeDescription to set
  - getSuggestions
```
public SuggestionIf[] getSuggestions()
```
    Product Recommendation Suggestions
    
    Specified by:
    
    getSuggestions in interface ProductIf
    
    Returns:
    
    the Product Recommendation Suggestions
  - setSuggestions
```
public void setSuggestions(SuggestionIf[] suggestions)
```
    Specified by:
    
    setSuggestions in interface ProductIf
    
    Parameters:
    
    suggestions - the Product Recommendation Suggestions to set
  - getImageCrc
```
public java.lang.String getImageCrc()
```
    Description copied from interface: ProductIf
    
    The imageCrc is used to store meta data that describes the cached images for a product
    
    Specified by:
    
    getImageCrc in interface ProductIf
    
    Returns:
    
    the imageCrc
  - setImageCrc
```
public void setImageCrc(java.lang.String imageCrc)
```
    Description copied from interface: ProductIf
    
    The imageCrc is used to store meta data that describes the cached images for a product
    
    Specified by:
    
    setImageCrc in interface ProductIf
    
    Parameters:
    
    imageCrc - the imageCrc to set
  - getExtDateAvailable
```
public java.util.Calendar getExtDateAvailable()
```
    Specified by:
    
    getExtDateAvailable in interface ProductIf
    
    Returns:
    
    the extDateAvailable
  - setExtDateAvailable
```
public void setExtDateAvailable(java.util.Calendar extDateAvailable)
```
    Specified by:
    
    setExtDateAvailable in interface ProductIf
    
    Parameters:
    
    extDateAvailable - the extDateAvailable to set
  - getExtQuantity
```
public java.lang.Integer getExtQuantity()
```
    Specified by:
    
    getExtQuantity in interface ProductIf
    
    Returns:
    
    the extQuantity
  - setExtQuantity
```
public void setExtQuantity(java.lang.Integer extQuantity)
```
    Specified by:
    
    setExtQuantity in interface ProductIf
    
    Parameters:
    
    extQuantity - the extQuantity to set
  - getExtPrice0
```
public java.math.BigDecimal getExtPrice0()
```
    Specified by:
    
    getExtPrice0 in interface ProductIf
    
    Returns:
    
    the extPrice0
  - setExtPrice0
```
public void setExtPrice0(java.math.BigDecimal extPrice0)
```
    Specified by:
    
    setExtPrice0 in interface ProductIf
    
    Parameters:
    
    extPrice0 - the extPrice0 to set
  - getExtPrice1
```
public java.math.BigDecimal getExtPrice1()
```
    Specified by:
    
    getExtPrice1 in interface ProductIf
    
    Returns:
    
    the extPrice1
  - setExtPrice1
```
public void setExtPrice1(java.math.BigDecimal extPrice1)
```
    Specified by:
    
    setExtPrice1 in interface ProductIf
    
    Parameters:
    
    extPrice1 - the extPrice1 to set
  - getExtPrice2
```
public java.math.BigDecimal getExtPrice2()
```
    Specified by:
    
    getExtPrice2 in interface ProductIf
    
    Returns:
    
    the extPrice2
  - setExtPrice2
```
public void setExtPrice2(java.math.BigDecimal extPrice2)
```
    Specified by:
    
    setExtPrice2 in interface ProductIf
    
    Parameters:
    
    extPrice2 - the extPrice2 to set
  - getExtPrice3
```
public java.math.BigDecimal getExtPrice3()
```
    Specified by:
    
    getExtPrice3 in interface ProductIf
    
    Returns:
    
    the extPrice3
  - setExtPrice3
```
public void setExtPrice3(java.math.BigDecimal extPrice3)
```
    Specified by:
    
    setExtPrice3 in interface ProductIf
    
    Parameters:
    
    extPrice3 - the extPrice3 to set
  - getWeightUOM
```
public java.lang.String getWeightUOM()
```
    Description copied from interface: ProductIf
    
    Weight Unit of Measure
    
    Specified by:
    
    getWeightUOM in interface ProductIf
    
    Returns:
    
    the weightUOM
  - setWeightUOM
```
public void setWeightUOM(java.lang.String weightUOM)
```
    Description copied from interface: ProductIf
    
    Weight Unit of Measure
    
    Specified by:
    
    setWeightUOM in interface ProductIf
    
    Parameters:
    
    weightUOM - the weightUOM to set
  - getSizeUOM
```
public java.lang.String getSizeUOM()
```
    Description copied from interface: ProductIf
    
    Size Unit of Measure
    
    Specified by:
    
    getSizeUOM in interface ProductIf
    
    Returns:
    
    the sizeUOM
  - setSizeUOM
```
public void setSizeUOM(java.lang.String sizeUOM)
```
    Description copied from interface: ProductIf
    
    Size Unit of Measure
    
    Specified by:
    
    setSizeUOM in interface ProductIf
    
    Parameters:
    
    sizeUOM - the sizeUOM to set
  - getNetWeightOrVolume
```
public java.math.BigDecimal getNetWeightOrVolume()
```
    Description copied from interface: ProductIf
    
    The weight or volume of the raw product
    
    Specified by:
    
    getNetWeightOrVolume in interface ProductIf
    
    Returns:
    
    the netWeightOrVolume
  - setNetWeightOrVolume
```
public void setNetWeightOrVolume(java.math.BigDecimal netWeightOrVolume)
```
    Description copied from interface: ProductIf
    
    The weight or volume of the raw product
    
    Specified by:
    
    setNetWeightOrVolume in interface ProductIf
    
    Parameters:
    
    netWeightOrVolume - the netWeightOrVolume to set
  - getNetWeightOrVolumeUOM
```
public java.lang.String getNetWeightOrVolumeUOM()
```
    Description copied from interface: ProductIf
    
    The unit of measure for the net weight or volume (e.g. kg, litre, lb )
    
    Specified by:
    
    getNetWeightOrVolumeUOM in interface ProductIf
    
    Returns:
    
    the netWeightOrVolumeUOM
  - setNetWeightOrVolumeUOM
```
public void setNetWeightOrVolumeUOM(java.lang.String netWeightOrVolumeUOM)
```
    Description copied from interface: ProductIf
    
    The unit of measure for the net weight or volume (e.g. kg, litre, lb )
    
    Specified by:
    
    setNetWeightOrVolumeUOM in interface ProductIf
    
    Parameters:
    
    netWeightOrVolumeUOM - the netWeightOrVolumeUOM to set
  - getVariantPrices
```
public VariantPriceIf[] getVariantPrices()
```
    Description copied from interface: ProductIf
    
    The variant prices related to the product.
    
    Specified by:
    
    getVariantPrices in interface ProductIf
    
    Returns:
    
    the variant prices
  - setVariantPrices
```
public void setVariantPrices(VariantPriceIf[] variantPrices)
```
    Description copied from interface: ProductIf
    
    The variant prices related to the product.
    
    Specified by:
    
    setVariantPrices in interface ProductIf
    
    Parameters:
    
    variantPrices - the variantPrices to set
  - getMeasureUnitId
```
public int getMeasureUnitId()
```
    Returns:
    
    the measureUnitId
  - getDecimalQuantity
```
public boolean getDecimalQuantity()
```
    Returns true if the quantity can have a decimal value
    
    Returns:
    
    Returns true if the quantity can have a decimal value
  - getMinQuantityInOrder
```
public int getMinQuantityInOrder()
```
    Specified by:
    
    getMinQuantityInOrder in interface ProductIf
    
    Returns:
    
    the MinQuantityInOrder
  - setMinQuantityInOrder
```
public void setMinQuantityInOrder(int minQuantityInOrder)
```
    Specified by:
    
    setMinQuantityInOrder in interface ProductIf
    
    Parameters:
    
    minQuantityInOrder - the minQuantityInOrder to set
  - getMaxQuantityInOrder
```
public int getMaxQuantityInOrder()
```
    Specified by:
    
    getMaxQuantityInOrder in interface ProductIf
    
    Returns:
    
    the MaxQuantityInOrder
  - setMaxQuantityInOrder
```
public void setMaxQuantityInOrder(int maxQuantityInOrder)
```
    Specified by:
    
    setMaxQuantityInOrder in interface ProductIf
    
    Parameters:
    
    maxQuantityInOrder - the maxQuantityInOrder to set
  - getDefaultQuantityInOrder
```
public int getDefaultQuantityInOrder()
```
    Specified by:
    
    getDefaultQuantityInOrder in interface ProductIf
    
    Returns:
    
    the DefaultQuantityInOrder
  - setDefaultQuantityInOrder
```
public void setDefaultQuantityInOrder(int defaultQuantityInOrder)
```
    Specified by:
    
    setDefaultQuantityInOrder in interface ProductIf
    
    Parameters:
    
    defaultQuantityInOrder - the defaultQuantityInOrder to set
  - isLocked
```
public boolean isLocked()
```
    Specified by:
    
    isLocked in interface ProductIf
    
    Returns:
    
    whether the product is Locked
  - setLocked
```
public void setLocked(boolean locked)
```
    Specified by:
    
    setLocked in interface ProductIf
    
    Parameters:
    
    locked - true if product is locked

Class Product

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Product

Product

Method Detail

toString

toStringBrief

getTaxClassId

setTaxClassId

getManufacturerName

setManufacturerName

getDescription

setDescription

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

getProdRelationTypeArray

setProdRelationTypeArray

getInvisible

setInvisible

getSku

setSku

getContentType

setContentType

getFilePath

setFilePath

getType

setType