ProductQuantity (KonaKart Server Engine API Documentation)

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

All Implemented Interfaces:

ProductQuantityIf
```
public class ProductQuantity
extends java.lang.Object
implements ProductQuantityIf
```
Product Quantity object which contains the quantity of a product for different option value combinations

Constructor Summary

Constructors
Constructor and Description

ProductQuantity()
Constructor

ProductQuantity(com.workingdogs.village.Record vr, KKCriteria c)

Constructors
Constructor and Description
`ProductQuantity()` Constructor
`ProductQuantity(com.workingdogs.village.Record vr, KKCriteria c)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`getBundledProdQuantity()` The number of times that this product appears in the bundle.
`ProductQuantityIf[]`	`getBundlePQs()` Product quantities of bundled products
`java.lang.String`	`getCustom1()`
`java.lang.String`	`getCustom2()`
`java.util.Calendar`	`getDateAvailable()`
`java.lang.String`	`getEncodedOptionValues()` encodedOptionValues
`java.util.Calendar`	`getExtDateAvailable()`
`java.lang.Integer`	`getExtQuantity()`
`OptionIf[]`	`getOpts()` Array of options matching the encoded option values
`int`	`getProductId()`
`PromotionResultIf[]`	`getPromotionResults()` Active promotions for this product configuration
`int`	`getQuantity()`
`int`	`getQuantityAvailable()`
`int`	`getQuantityReserved()` This attribute defines the total number of products that are currently reserved.
`java.lang.String`	`getSku()` The SKU of the product
`java.lang.String`	`getVariantCode()`
`void`	`setBundledProdQuantity(int bundledProdQuantity)` The number of times that this product appears in the bundle.
`void`	`setBundlePQs(ProductQuantityIf[] bundlePQs)` Product quantities of bundled products
`void`	`setCustom1(java.lang.String custom1)`
`void`	`setCustom2(java.lang.String custom2)`
`void`	`setDateAvailable(java.util.Calendar dateAvailable)`
`void`	`setEncodedOptionValues(java.lang.String encodedOptionValues)` encodedOptionValues
`void`	`setExtDateAvailable(java.util.Calendar extDateAvailable)`
`void`	`setExtQuantity(java.lang.Integer extQuantity)`
`void`	`setOpts(OptionIf[] opts)` Array of options matching the encoded option values
`void`	`setProductId(int productId)`
`void`	`setPromotionResults(PromotionResultIf[] promotionResults)` Active promotions for this product configuration
`void`	`setQuantity(int quantity)`
`void`	`setQuantityReserved(int quantityReserved)` This attribute defines the total number of products that are currently reserved.
`void`	`setSku(java.lang.String sku)` The SKU of the product
`void`	`setVariantCode(java.lang.String variantCode)`
`java.lang.String`	`toString()`

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

- Constructor Detail
  - ProductQuantity
```
public ProductQuantity()
```
    Constructor
  - ProductQuantity
```
public ProductQuantity(com.workingdogs.village.Record vr,
                       KKCriteria c)
                throws com.workingdogs.village.DataSetException
```
    Parameters:
    
    vr - the vr
    
    c - the c
    
    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 Option object.
  - getEncodedOptionValues
```
public java.lang.String getEncodedOptionValues()
```
    Description copied from interface: ProductQuantityIf
    
    encodedOptionValues
    The format of the encoded key for the products_quantity table is 3{4}4{6} which means product_options of id==3 and product_options_values of id==4 followed by product_options of id==4 and product_options_values of id==6. The order is very important since the product option ids must be in ascending order.
    
    Specified by:
    
    getEncodedOptionValues in interface ProductQuantityIf
    
    Returns:
    
    Returns the encodedOptionValues.
  - setEncodedOptionValues
```
public void setEncodedOptionValues(java.lang.String encodedOptionValues)
```
    Description copied from interface: ProductQuantityIf
    
    encodedOptionValues
    The format of the encoded key for the products_quantity table is 3{4}4{6} which means product_options of id==3 and product_options_values of id==4 followed by product_options of id==4 and product_options_values of id==6. The order is very important since the product option ids must be in ascending order.
    
    Specified by:
    
    setEncodedOptionValues in interface ProductQuantityIf
    
    Parameters:
    
    encodedOptionValues - The encodedOptionValues to set.
  - getProductId
```
public int getProductId()
```
    Specified by:
    
    getProductId in interface ProductQuantityIf
    
    Returns:
    
    Returns the productId.
  - setProductId
```
public void setProductId(int productId)
```
    Specified by:
    
    setProductId in interface ProductQuantityIf
    
    Parameters:
    
    productId - The productId to set.
  - getQuantity
```
public int getQuantity()
```
    Specified by:
    
    getQuantity in interface ProductQuantityIf
    
    Returns:
    
    Returns the quantity.
  - setQuantity
```
public void setQuantity(int quantity)
```
    Specified by:
    
    setQuantity in interface ProductQuantityIf
    
    Parameters:
    
    quantity - The quantity to set.
  - getSku
```
public java.lang.String getSku()
```
    Description copied from interface: ProductQuantityIf
    
    The SKU of the product
    
    Specified by:
    
    getSku in interface ProductQuantityIf
    
    Returns:
    
    Returns the sku.
  - setSku
```
public void setSku(java.lang.String sku)
```
    Description copied from interface: ProductQuantityIf
    
    The SKU of the product
    
    Specified by:
    
    setSku in interface ProductQuantityIf
    
    Parameters:
    
    sku - The sku to set.
  - getDateAvailable
```
public java.util.Calendar getDateAvailable()
```
    Specified by:
    
    getDateAvailable in interface ProductQuantityIf
    
    Returns:
    
    the dateAvailable
  - setDateAvailable
```
public void setDateAvailable(java.util.Calendar dateAvailable)
```
    Specified by:
    
    setDateAvailable in interface ProductQuantityIf
    
    Parameters:
    
    dateAvailable - the dateAvailable to set
  - getOpts
```
public OptionIf[] getOpts()
```
    Array of options matching the encoded option values
    
    Specified by:
    
    getOpts in interface ProductQuantityIf
    
    Returns:
    
    the opts
  - setOpts
```
public void setOpts(OptionIf[] opts)
```
    Array of options matching the encoded option values
    
    Specified by:
    
    setOpts in interface ProductQuantityIf
    
    Parameters:
    
    opts - the opts to set
  - getPromotionResults
```
public PromotionResultIf[] getPromotionResults()
```
    Active promotions for this product configuration
    
    Specified by:
    
    getPromotionResults in interface ProductQuantityIf
    
    Returns:
    
    the promotionResults
  - setPromotionResults
```
public void setPromotionResults(PromotionResultIf[] promotionResults)
```
    Active promotions for this product configuration
    
    Specified by:
    
    setPromotionResults in interface ProductQuantityIf
    
    Parameters:
    
    promotionResults - the promotionResults to set
  - getQuantityReserved
```
public int getQuantityReserved()
```
    Description copied from interface: ProductQuantityIf
    
    This attribute defines the total number of products that are currently reserved.
    
    Specified by:
    
    getQuantityReserved in interface ProductQuantityIf
    
    Returns:
    
    the quantityReserved
  - setQuantityReserved
```
public void setQuantityReserved(int quantityReserved)
```
    Description copied from interface: ProductQuantityIf
    
    This attribute defines the total number of products that are currently reserved.
    
    Specified by:
    
    setQuantityReserved in interface ProductQuantityIf
    
    Parameters:
    
    quantityReserved - the quantityReserved to set
  - getQuantityAvailable
```
public int getQuantityAvailable()
```
    Returns:
    
    the quantityAvailable
  - getBundlePQs
```
public ProductQuantityIf[] getBundlePQs()
```
    Description copied from interface: ProductQuantityIf
    
    Product quantities of bundled products
    
    Specified by:
    
    getBundlePQs in interface ProductQuantityIf
    
    Returns:
    
    the bundlePQs
  - setBundlePQs
```
public void setBundlePQs(ProductQuantityIf[] bundlePQs)
```
    Description copied from interface: ProductQuantityIf
    
    Product quantities of bundled products
    
    Specified by:
    
    setBundlePQs in interface ProductQuantityIf
    
    Parameters:
    
    bundlePQs - the bundlePQs to set
  - getBundledProdQuantity
```
public int getBundledProdQuantity()
```
    Description copied from interface: ProductQuantityIf
    
    The number of times that this product appears in the bundle. Only given a valid value when the ProductQuantity object is in the bundlePQs array.
    
    Specified by:
    
    getBundledProdQuantity in interface ProductQuantityIf
    
    Returns:
    
    the bundledProdQuantity
  - setBundledProdQuantity
```
public void setBundledProdQuantity(int bundledProdQuantity)
```
    Description copied from interface: ProductQuantityIf
    
    The number of times that this product appears in the bundle. Only given a valid value when the ProductQuantity object is in the bundlePQs array.
    
    Specified by:
    
    setBundledProdQuantity in interface ProductQuantityIf
    
    Parameters:
    
    bundledProdQuantity - the bundledProdQuantity to set
  - getCustom1
```
public java.lang.String getCustom1()
```
    Specified by:
    
    getCustom1 in interface ProductQuantityIf
    
    Returns:
    
    the custom1
  - setCustom1
```
public void setCustom1(java.lang.String custom1)
```
    Specified by:
    
    setCustom1 in interface ProductQuantityIf
    
    Parameters:
    
    custom1 - the custom1 to set
  - getCustom2
```
public java.lang.String getCustom2()
```
    Specified by:
    
    getCustom2 in interface ProductQuantityIf
    
    Returns:
    
    the custom2
  - setCustom2
```
public void setCustom2(java.lang.String custom2)
```
    Specified by:
    
    setCustom2 in interface ProductQuantityIf
    
    Parameters:
    
    custom2 - the custom2 to set
  - getExtQuantity
```
public java.lang.Integer getExtQuantity()
```
    Specified by:
    
    getExtQuantity in interface ProductQuantityIf
    
    Returns:
    
    the extQuantity
  - setExtQuantity
```
public void setExtQuantity(java.lang.Integer extQuantity)
```
    Specified by:
    
    setExtQuantity in interface ProductQuantityIf
    
    Parameters:
    
    extQuantity - the extQuantity to set
  - getExtDateAvailable
```
public java.util.Calendar getExtDateAvailable()
```
    Specified by:
    
    getExtDateAvailable in interface ProductQuantityIf
    
    Returns:
    
    the extDateAvailable
  - setExtDateAvailable
```
public void setExtDateAvailable(java.util.Calendar extDateAvailable)
```
    Specified by:
    
    setExtDateAvailable in interface ProductQuantityIf
    
    Parameters:
    
    extDateAvailable - the extDateAvailable to set
  - getVariantCode
```
public java.lang.String getVariantCode()
```
    Specified by:
    
    getVariantCode in interface ProductQuantityIf
    
    Returns:
    
    the variantCode
  - setVariantCode
```
public void setVariantCode(java.lang.String variantCode)
```
    Specified by:
    
    setVariantCode in interface ProductQuantityIf
    
    Parameters:
    
    variantCode - the variant code to set

Class ProductQuantity

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ProductQuantity

ProductQuantity

Method Detail

toString

getEncodedOptionValues

setEncodedOptionValues

getProductId

setProductId

getQuantity

setQuantity

getSku

setSku

getDateAvailable

setDateAvailable

getOpts

setOpts

getPromotionResults

setPromotionResults

getQuantityReserved

setQuantityReserved

getQuantityAvailable

getBundlePQs

setBundlePQs

getBundledProdQuantity

setBundledProdQuantity

getCustom1

setCustom1

getCustom2

setCustom2

getExtQuantity

setExtQuantity

getExtDateAvailable

setExtDateAvailable

getVariantCode

setVariantCode