Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.konakart.json.app
Class J_Product

java.lang.Object
  extended by com.konakart.json.app.J_Product
All Implemented Interfaces:
java.io.Serializable
public class J_Product
extends java.lang.Object
implements java.io.Serializable

Describes a product object for use within KonaKart.

See Also:
Serialized Form

Constructor Summary
J_Product()
           
 
Method Summary
 J_Address[] getAddresses()
          An array containing all of the addresses defined for this product.
 J_BookableProduct 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
 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.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()
           
 J_ProdCustAttr[] getCustomAttrArray()
          An array of ProdCustAttr objects
 java.lang.String getCustomAttrs()
          Contains the custom attributes in XML format
 java.util.Calendar getDateAdded()
           
 java.util.Calendar getDateAvailable()
           
 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.
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.
 java.util.Calendar getExpiryDate()
          The date that the product expires
 java.lang.String getFilePath()
          Valid for digital products.
 int getId()
           
 java.lang.String getImage()
           
 java.lang.String getImage2()
           
 java.lang.String getImage3()
           
 java.lang.String getImage4()
           
 byte getInvisible()
          When set to '1' the product is invisible and will not be returned from normal API calls.
 J_Manufacturer 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.
 J_MiscItem[] getMiscItems()
          Miscellaneous Items associated with this product.
 java.lang.String getModel()
           
 java.lang.String getName()
           
 int getNumberReviews()
           
 J_Option[] getOpts()
          An array of Option objects.
 int getOrdered()
          The number of times that the product has been ordered.
 J_PaymentSchedule 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()
           
 java.math.BigDecimal getPriceIncTax()
           
 int[] getProdRelationTypeArray()
          When products are returned from the API call getRelatedProducts() they will have this array initialised.
 J_ProductQuantity[] getProductQuantities()
          An array of productQuantity objects that define quantity in stock and availability date for different SKUs.
 J_PromotionResult[] getPromotionResults()
          Active promotions for this product
 int getQuantity()
           
 java.math.BigDecimal getRating()
          Average product rating
 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 getStoreId()
          Attribute is only applicable when KonaKart is configured in multi-store single db mode.
 J_Tag[] getTags()
           
 int getTaxClassId()
           
 java.lang.String getTaxCode()
          tax code used when looking up tax from an external service
 J_TierPrice[] 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.
 int getViewedCount()
          The number of times the product has been viewed.
 java.math.BigDecimal getWeight()
           
 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.
 void setAddresses(J_Address[] _addresses)
          An array containing all of the addresses defined for this product.
 void setBookableProd(J_BookableProduct _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 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 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(J_ProdCustAttr[] _customAttrArray)
          An array of ProdCustAttr objects
 void setCustomAttrs(java.lang.String _customAttrs)
          Contains the custom attributes in XML format
 void setDateAdded(java.util.Calendar _dateAdded)
           
 void setDateAvailable(java.util.Calendar _dateAvailable)
           
 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.
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.
 void setExpiryDate(java.util.Calendar _expiryDate)
          The date that the product expires
 void setFilePath(java.lang.String _filePath)
          Valid for digital products.
 void setId(int _id)
           
 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 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 setManufacturer(J_Manufacturer _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 setMiscItems(J_MiscItem[] _miscItems)
          Miscellaneous Items associated with this product
 void setModel(java.lang.String _model)
           
 void setName(java.lang.String _name)
           
 void setNumberReviews(int _numberReviews)
           
 void setOpts(J_Option[] _opts)
          An array of Option objects.
 void setOrdered(int _ordered)
          The number of times that the product has been ordered.
 void setPaymentSchedule(J_PaymentSchedule _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 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(J_ProductQuantity[] _productQuantities)
          An array of productQuantity objects that define quantity in stock and availability date for different SKUs.
 void setPromotionResults(J_PromotionResult[] _promotionResults)
          Active promotions for this product
 void setQuantity(int _quantity)
           
 void setRating(java.math.BigDecimal _rating)
          Average product rating
 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 setStoreId(java.lang.String _storeId)
          Attribute is only applicable when KonaKart is configured in multi-store single db mode.
 void setTags(J_Tag[] _tags)
           
 void setTaxClassId(int _taxClassId)
           
 void setTaxCode(java.lang.String _taxCode)
          tax code used when looking up tax from an external service
 void setTierPrices(J_TierPrice[] _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 setViewedCount(int _viewedCount)
          The number of times the product has been viewed.
 void setWeight(java.math.BigDecimal _weight)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

J_Product

public J_Product()
Method Detail

getTaxClassId

public int getTaxClassId()
Returns:
Returns the taxClassId.

setTaxClassId

public void setTaxClassId(int _taxClassId)
Parameters:
_taxClassId - The taxClassId to set.

getManufacturerName

public java.lang.String getManufacturerName()
Returns:
Returns the manufacturerName.

setManufacturerName

public void setManufacturerName(java.lang.String _manufacturerName)
Parameters:
_manufacturerName - The manufacturerName to set.

getDescription

public java.lang.String getDescription()
Returns:
Returns the description.

setDescription

public void setDescription(java.lang.String _description)
Parameters:
_description - The description to set.

getId

public int getId()
Returns:
Returns the id.

setId

public void setId(int _id)
Parameters:
_id - The id to set.

getImage

public java.lang.String getImage()
Returns:
Returns the image.

setImage

public void setImage(java.lang.String _image)
Parameters:
_image - The image to set.

getModel

public java.lang.String getModel()
Returns:
Returns the model.

setModel

public void setModel(java.lang.String _model)
Parameters:
_model - The model to set.

getName

public java.lang.String getName()
Returns:
Returns the name.

setName

public void setName(java.lang.String _name)
Parameters:
_name - The name to set.

getOpts

public J_Option[] getOpts()
An array of Option objects. An option is used to configure a product and may change its price. i.e. The amount of memory or CPU specification for a personal computer.

Returns:
Returns the opts.

setOpts

public void setOpts(J_Option[] _opts)
An array of Option objects. An option is used to configure a product and may change its price. i.e. The amount of memory or CPU specification for a personal computer.

Parameters:
_opts - The opts to set.

getQuantity

public int getQuantity()
Returns:
Returns the quantity.

setQuantity

public void setQuantity(int _quantity)
Parameters:
_quantity - The quantity to set.

getStatus

public byte getStatus()
Set to '1' if the product is active. Otherwise set to '0'.

Returns:
Returns the status.

setStatus

public void setStatus(byte _status)
Set to '1' if the product is active. Otherwise set to '0'.

Parameters:
_status - The status to set.

getUrl

public java.lang.String getUrl()
The url of the product, for example from the manufacturer's web site.

Returns:
Returns the url.

setUrl

public void setUrl(java.lang.String _url)
The url of the product, for example from the manufacturer's web site.

Parameters:
_url - The url to set.

getViewedCount

public int getViewedCount()
The number of times the product has been viewed.

Returns:
Returns the viewedCount.

setViewedCount

public void setViewedCount(int _viewedCount)
The number of times the product has been viewed.

Parameters:
_viewedCount - The viewedCount to set.

getWeight

public java.math.BigDecimal getWeight()
Returns:
Returns the weight.

setWeight

public void setWeight(java.math.BigDecimal _weight)
Parameters:
_weight - The weight to set.

getNumberReviews

public int getNumberReviews()
Returns:
Returns the numberReviews.

setNumberReviews

public void setNumberReviews(int _numberReviews)
Parameters:
_numberReviews - The numberReviews to set.

getDateAdded

public java.util.Calendar getDateAdded()
Returns:
Returns the dateAdded.

setDateAdded

public void setDateAdded(java.util.Calendar _dateAdded)
Parameters:
_dateAdded - The dateAdded to set.

getDateAvailable

public java.util.Calendar getDateAvailable()
Returns:
Returns the dateAvailable.

setDateAvailable

public void setDateAvailable(java.util.Calendar _dateAvailable)
Parameters:
_dateAvailable - The dateAvailable to set.

getManufacturer

public J_Manufacturer getManufacturer()
Returns:
Returns the manufacturer.

setManufacturer

public void setManufacturer(J_Manufacturer _manufacturer)
Parameters:
_manufacturer - The manufacturer to set.

getManufacturerId

public int getManufacturerId()
Returns:
Returns the manufacturerId.

setManufacturerId

public void setManufacturerId(int _manufacturerId)
Parameters:
_manufacturerId - The manufacturerId to set.

getCategoryId

public int getCategoryId()
Returns:
Returns the categoryId.

setCategoryId

public void setCategoryId(int _categoryId)
Parameters:
_categoryId - The categoryId to set.

getOrdered

public int getOrdered()
The number of times that the product has been ordered.

Returns:
Returns the ordered.

setOrdered

public void setOrdered(int _ordered)
The number of times that the product has been ordered.

Parameters:
_ordered - The ordered to set.

getPriceExTax

public java.math.BigDecimal getPriceExTax()
Returns:
Returns the priceExTax.

setPriceExTax

public void setPriceExTax(java.math.BigDecimal _priceExTax)
Parameters:
_priceExTax - The priceExTax to set.

getSpecialPriceExTax

public java.math.BigDecimal getSpecialPriceExTax()
Returns:
Returns the specialPriceExTax.

setSpecialPriceExTax

public void setSpecialPriceExTax(java.math.BigDecimal _specialPriceExTax)
Parameters:
_specialPriceExTax - The specialPriceExTax to set.

getSpecialPriceIncTax

public java.math.BigDecimal getSpecialPriceIncTax()
Returns:
Returns the specialPriceIncTax.

setSpecialPriceIncTax

public void setSpecialPriceIncTax(java.math.BigDecimal _specialPriceIncTax)
Parameters:
_specialPriceIncTax - The specialPriceIncTax to set.

getPriceIncTax

public java.math.BigDecimal getPriceIncTax()
Returns:
Returns the priceIncTax.

setPriceIncTax

public void setPriceIncTax(java.math.BigDecimal _priceIncTax)
Parameters:
_priceIncTax - The priceIncTax to set.

getCustom1

public java.lang.String getCustom1()
Returns:
Returns the custom1.

setCustom1

public void setCustom1(java.lang.String _custom1)
Parameters:
_custom1 - The custom1 to set.

getCustom2

public java.lang.String getCustom2()
Returns:
Returns the custom2.

setCustom2

public void setCustom2(java.lang.String _custom2)
Parameters:
_custom2 - The custom2 to set.

getCustom3

public java.lang.String getCustom3()
Returns:
Returns the custom3.

setCustom3

public void setCustom3(java.lang.String _custom3)
Parameters:
_custom3 - The custom3 to set.

getCustom4

public java.lang.String getCustom4()
Returns:
Returns the custom4.

setCustom4

public void setCustom4(java.lang.String _custom4)
Parameters:
_custom4 - The custom4 to set.

getCustom5

public java.lang.String getCustom5()
Returns:
Returns the custom5.

setCustom5

public void setCustom5(java.lang.String _custom5)
Parameters:
_custom5 - The custom5 to set.

getCustom6

public java.lang.String getCustom6()
Returns:
the custom6

setCustom6

public void setCustom6(java.lang.String _custom6)
Parameters:
_custom6 - the custom6 to set

getCustom7

public java.lang.String getCustom7()
Returns:
the custom7

setCustom7

public void setCustom7(java.lang.String _custom7)
Parameters:
_custom7 - the custom7 to set

getCustom8

public java.lang.String getCustom8()
Returns:
the custom8

setCustom8

public void setCustom8(java.lang.String _custom8)
Parameters:
_custom8 - the custom8 to set

getCustom9

public java.lang.String getCustom9()
Returns:
the custom9

setCustom9

public void setCustom9(java.lang.String _custom9)
Parameters:
_custom9 - the custom9 to set

getCustom10

public java.lang.String getCustom10()
Returns:
the custom10

setCustom10

public void setCustom10(java.lang.String _custom10)
Parameters:
_custom10 - the custom10 to set

getCustom1Int

public int getCustom1Int()
Returns:
the custom1Int

setCustom1Int

public void setCustom1Int(int _custom1Int)
Parameters:
_custom1Int - the custom1Int to set

getCustom2Int

public int getCustom2Int()
Returns:
the custom2Int

setCustom2Int

public void setCustom2Int(int _custom2Int)
Parameters:
_custom2Int - the custom2Int to set

getCustom1Dec

public java.math.BigDecimal getCustom1Dec()
Returns:
the custom1Dec

setCustom1Dec

public void setCustom1Dec(java.math.BigDecimal _custom1Dec)
Parameters:
_custom1Dec - the custom1Dec to set

getCustom2Dec

public java.math.BigDecimal getCustom2Dec()
Returns:
the custom2Dec

setCustom2Dec

public void setCustom2Dec(java.math.BigDecimal _custom2Dec)
Parameters:
_custom2Dec - the custom2Dec to set

getProdRelationTypeArray

public int[] getProdRelationTypeArray()
When products are returned from the API call getRelatedProducts() they will have this array initialised. It is an array of integers where each integer defines a relation type. The valid relation types are: An array is necessary because a product may be related to another product in more than one way.

Returns:
Returns the prodRelationTypeArray.

setProdRelationTypeArray

public void setProdRelationTypeArray(int[] _prodRelationTypeArray)
When products are returned from the API call getRelatedProducts() they will have this array initialised. It is an array of integers where each integer defines a relation type. The valid relation types are: An array is necessary because a product may be related to another product in more than one way.

Parameters:
_prodRelationTypeArray - The prodRelationTypeArray to set.

getInvisible

public byte getInvisible()
When set to '1' the product is invisible and will not be returned from normal API calls.

Returns:
Returns the invisible.

setInvisible

public void setInvisible(byte _invisible)
When set to '1' the product is invisible and will not be returned from normal API calls.

Parameters:
_invisible - The invisible to set.

getSku

public java.lang.String getSku()
The SKU is the stock keeping unit.

Returns:
Returns the sku.

setSku

public void setSku(java.lang.String _sku)
The SKU is the stock keeping unit.

Parameters:
_sku - The sku to set.

getContentType

public java.lang.String getContentType()
Valid for digital products. The Content Type describes the content of the file. Examples are "image/jpeg" or "application/pdf".

Returns:
Returns the contentType.

setContentType

public void setContentType(java.lang.String _contentType)
Valid for digital products. The Content Type describes the content of the file. Examples are "image/jpeg" or "application/pdf".

Parameters:
_contentType - The contentType to set.

getFilePath

public java.lang.String getFilePath()
Valid for digital products. The File Path is the path of a file containing the digital product. This path will be appended to the Base Path defined by a configuration variable.

Returns:
Returns the filePath.

setFilePath

public void setFilePath(java.lang.String _filePath)
Valid for digital products. The File Path is the path of a file containing the digital product. This path will be appended to the Base Path defined by a configuration variable.

Parameters:
_filePath - The filePath to set.

getType

public int getType()
product type.

Returns:
Returns the type.

setType

public void setType(int _type)
product type.

Parameters:
_type - The type to set.

getImage2

public java.lang.String getImage2()
Returns:
Returns the image2.

setImage2

public void setImage2(java.lang.String _image2)
Parameters:
_image2 - The image2 to set.

getImage3

public java.lang.String getImage3()
Returns:
Returns the image3.

setImage3

public void setImage3(java.lang.String _image3)
Parameters:
_image3 - The image3 to set.

getImage4

public java.lang.String getImage4()
Returns:
Returns the image4.

setImage4

public void setImage4(java.lang.String _image4)
Parameters:
_image4 - The image4 to set.

getComparison

public java.lang.String getComparison()
The content of this attribute should be structured data such as xml so that it can be easily used to compare product features with other products. e.g. The tag names could be the features.

Returns:
Returns the comparison.

setComparison

public void setComparison(java.lang.String _comparison)
The content of this attribute should be structured data such as xml so that it can be easily used to compare product features with other products. e.g. The tag names could be the features.

Parameters:
_comparison - The comparison to set.

getPrice0

public java.math.BigDecimal getPrice0()
Returns:
Returns the price0.

setPrice0

public void setPrice0(java.math.BigDecimal _price0)
Parameters:
_price0 - The price0 to set.

getPrice1

public java.math.BigDecimal getPrice1()
Returns:
Returns the price1.

setPrice1

public void setPrice1(java.math.BigDecimal _price1)
Parameters:
_price1 - The price1 to set.

getPrice2

public java.math.BigDecimal getPrice2()
Returns:
Returns the price2.

setPrice2

public void setPrice2(java.math.BigDecimal _price2)
Parameters:
_price2 - The price2 to set.

getPrice3

public java.math.BigDecimal getPrice3()
Returns:
Returns the price3.

setPrice3

public void setPrice3(java.math.BigDecimal _price3)
Parameters:
_price3 - The price3 to set.

getBundledProdQuantity

public int getBundledProdQuantity()
When products are returned from the API call getRelatedProducts() and the relationship is a bundle relationship, they will have this attribute instantiated to show the number of times that this product appears in the bundle

Returns:
Returns the bundledProdQuantity.

setBundledProdQuantity

public void setBundledProdQuantity(int _bundledProdQuantity)
When products are returned from the API call getRelatedProducts() and the relationship is a bundle relationship, they will have this attribute instantiated to show the number of times that this product appears in the bundle

Parameters:
_bundledProdQuantity - The bundledProdQuantity to set.

getEncodedOptionValues

public java.lang.String getEncodedOptionValues()
When products are returned from the API call getRelatedProducts() and the relationship is a bundle relationship, they will have this attribute instantiated if the product in the bundle is configured with one or more options.
encodedOptionValues 3{5}4{1} means product_options of id==3 and product_options_values of id==5 followed by product_options of id==4 and product_options_values of id==1.

Returns:
Returns the encodedOptionValues.

setEncodedOptionValues

public void setEncodedOptionValues(java.lang.String _encodedOptionValues)
When products are returned from the API call getRelatedProducts() and the relationship is a bundle relationship, they will have this attribute instantiated if the product in the bundle is configured with one or more options.
encodedOptionValues 3{5}4{1} means product_options of id==3 and product_options_values of id==5 followed by product_options of id==4 and product_options_values of id==1.

Parameters:
_encodedOptionValues - The encodedOptionValues to set.

getTags

public J_Tag[] getTags()
Returns:
Returns the tags.

setTags

public void setTags(J_Tag[] _tags)
Parameters:
_tags - The tags to set.

getStoreId

public java.lang.String getStoreId()
Attribute is only applicable when KonaKart is configured in multi-store single db mode. It is used when doing a search within multiple stores so that you can identify which store a returned product belongs to.

Returns:
Returns the store id

setStoreId

public void setStoreId(java.lang.String _storeId)
Attribute is only applicable when KonaKart is configured in multi-store single db mode. It is used when doing a search within multiple stores so that you can identify which store a returned product belongs to.

Parameters:
_storeId -

getMaxNumDownloads

public int getMaxNumDownloads()
Maximum number of downloads allowed in the case of digital download products. If negative, then the configuration variable value (DD_MAX_DOWNLOADS) will be used.

Returns:
the maxNumDownloads

setMaxNumDownloads

public void setMaxNumDownloads(int _maxNumDownloads)
Maximum number of downloads allowed in the case of digital download products. If negative, then the configuration variable value (DD_MAX_DOWNLOADS) will be used.

Parameters:
_maxNumDownloads - the maxNumDownloads to set

getMaxDownloadDays

public int getMaxDownloadDays()
Maximum number of days a product can be downloaded in the case of digital downloads. If negative, then the configuration variable value (DD_MAX_DOWNLOAD_DAYS) will be used.

Returns:
the maxDownloadDays

setMaxDownloadDays

public void setMaxDownloadDays(int _maxDownloadDays)
Maximum number of days a product can be downloaded in the case of digital downloads. If negative, then the configuration variable value (DD_MAX_DOWNLOAD_DAYS) will be used.

Parameters:
_maxDownloadDays - the maxDownloadDays to set

getStockReorderLevel

public int getStockReorderLevel()
Product needs to be reordered when the stock hits this level. If negative, then the configuration variable value (STOCK_REORDER_LEVEL) will be used.

Returns:
the stockReorderLevel

setStockReorderLevel

public void setStockReorderLevel(int _stockReorderLevel)
Product needs to be reordered when the stock hits this level. If negative, then the configuration variable value (STOCK_REORDER_LEVEL) will be used.

Parameters:
_stockReorderLevel - the stockReorderLevel to set

getCanOrderWhenNotInStock

public java.lang.Boolean getCanOrderWhenNotInStock()
If null then we use the global value set by the config variable STOCK_ALLOW_CHECKOUT. If the value isn't null, then it overrides the global value.

Returns:
the canOrderWhenNotInStock

setCanOrderWhenNotInStock

public void setCanOrderWhenNotInStock(java.lang.Boolean _canOrderWhenNotInStock)
If null then we use the global value set by the config variable STOCK_ALLOW_CHECKOUT. If the value isn't null, then it overrides the global value.

Parameters:
_canOrderWhenNotInStock - the canOrderWhenNotInStock to set

isIndexAttachment

public boolean isIndexAttachment()
If the product is a digital download and the SOLR search engine is enabled, then the attachment is indexed within the search engine when this boolean is set. Currently it functions for txt and pdf attachments.

Returns:
the indexAttachment

setIndexAttachment

public void setIndexAttachment(boolean _indexAttachment)
If the product is a digital download and the SOLR search engine is enabled, then the attachment is indexed within the search engine when this boolean is set. Currently it functions for txt and pdf attachments.

Parameters:
_indexAttachment - the indexAttachment to set

getSnippets

public java.lang.String[] getSnippets()
Array of strings containing snippets which are text fragments surrounding the search keywords.

Returns:
the snippets

setSnippets

public void setSnippets(java.lang.String[] _snippets)
Array of strings containing snippets which are text fragments surrounding the search keywords.

Parameters:
_snippets - the snippets to set

getRating

public java.math.BigDecimal getRating()
Average product rating

Returns:
the rating

setRating

public void setRating(java.math.BigDecimal _rating)
Average product rating

Parameters:
_rating - the rating to set

getExpiryDate

public java.util.Calendar getExpiryDate()
The date that the product expires

Returns:
the expiryDate

setExpiryDate

public void setExpiryDate(java.util.Calendar _expiryDate)
The date that the product expires

Parameters:
_expiryDate - the expiryDate to set

getPaymentScheduleId

public int getPaymentScheduleId()
Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.

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.

Parameters:
_paymentScheduleId - the paymentScheduleId to set

getPaymentSchedule

public J_PaymentSchedule getPaymentSchedule()
A product may be associated to a PaymentSchedule object when it is paid for using recurring billing.

Returns:
the paymentSchedule

setPaymentSchedule

public void setPaymentSchedule(J_PaymentSchedule _paymentSchedule)
A product may be associated to a PaymentSchedule object when it is paid for using recurring billing.

Parameters:
_paymentSchedule - the paymentSchedule to set

getTierPrices

public J_TierPrice[] getTierPrices()
An array of tier price objects for this product

Returns:
the tierPrices

setTierPrices

public void setTierPrices(J_TierPrice[] _tierPrices)
An array of tier price objects for this product

Parameters:
_tierPrices - the tierPrices to set

getSpecialExpiryDate

public java.util.Calendar getSpecialExpiryDate()
The date when the special price expires

Returns:
the specialExpiryDate

setSpecialExpiryDate

public void setSpecialExpiryDate(java.util.Calendar _specialExpiryDate)
The date when the special price expires

Parameters:
_specialExpiryDate - the specialExpiryDate to set

getSpecialStartDate

public java.util.Calendar getSpecialStartDate()
The date when the special price starts

Returns:
the specialStartDate

setSpecialStartDate

public void setSpecialStartDate(java.util.Calendar _specialStartDate)
The date when the special price starts

Parameters:
_specialStartDate - the specialStartDate to set

getSpecialStatus

public byte getSpecialStatus()
Set to '1' if the special price is active. Otherwise set to '0'.

Returns:
the specialStatus

setSpecialStatus

public void setSpecialStatus(byte _specialStatus)
Set to '1' if the special price is active. Otherwise set to '0'.

Parameters:
_specialStatus - the specialStatus to set

getProductQuantities

public J_ProductQuantity[] getProductQuantities()
An array of productQuantity objects that define quantity in stock and availability date for different SKUs. This array will only exist when the product can be configured by selecting from a list of options. Each valid combination of options may have a unique SKU and quantity in stock. i.e. For the case of an article of clothing, the options may be size and color, each combination of which consists of a product with a unique SKU.

Returns:
the productQuantities

setProductQuantities

public void setProductQuantities(J_ProductQuantity[] _productQuantities)
An array of productQuantity objects that define quantity in stock and availability date for different SKUs. This array will only exist when the product can be configured by selecting from a list of options. Each valid combination of options may have a unique SKU and quantity in stock. i.e. For the case of an article of clothing, the options may be size and color, each combination of which consists of a product with a unique SKU.

Parameters:
_productQuantities - the productQuantities to set

getAddresses

public J_Address[] getAddresses()
An array containing all of the addresses defined for this product.

Returns:
Returns the addresses.

setAddresses

public void setAddresses(J_Address[] _addresses)
An array containing all of the addresses defined for this product.

Parameters:
_addresses - The addresses to set.

getCustomAttrs

public java.lang.String getCustomAttrs()
Contains the custom attributes in XML format

Returns:
the customAttrs

setCustomAttrs

public void setCustomAttrs(java.lang.String _customAttrs)
Contains the custom attributes in XML format

Parameters:
_customAttrs - the customAttrs to set

getCustomAttrArray

public J_ProdCustAttr[] getCustomAttrArray()
An array of ProdCustAttr objects

Returns:
the customAttrArray

setCustomAttrArray

public void setCustomAttrArray(J_ProdCustAttr[] _customAttrArray)
An array of ProdCustAttr objects

Parameters:
_customAttrArray - the customAttrArray to set

getTaxCode

public java.lang.String getTaxCode()
tax code used when looking up tax from an external service

Returns:
the taxCode

setTaxCode

public void setTaxCode(java.lang.String _taxCode)
tax code used when looking up tax from an external service

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

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

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

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

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

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

Parameters:
_storeCustom3 - the storeCustom3 to set

getBookableProd

public J_BookableProduct getBookableProd()
An object containing attributes relevant to a bookable product

Returns:
the bookableProd

setBookableProd

public void setBookableProd(J_BookableProduct _bookableProd)
An object containing attributes relevant to a bookable product

Parameters:
_bookableProd - the bookableProd to set

getMiscItems

public J_MiscItem[] getMiscItems()
Miscellaneous Items associated with this product.

Returns:
the miscItems associated with this product.

setMiscItems

public void setMiscItems(J_MiscItem[] _miscItems)
Miscellaneous Items associated with this product

Parameters:
_miscItems - the miscItems to set

getPromotionResults

public J_PromotionResult[] getPromotionResults()
Active promotions for this product

Returns:
the promotionResults

setPromotionResults

public void setPromotionResults(J_PromotionResult[] _promotionResults)
Active promotions for this product

Parameters:
_promotionResults - the promotionResults to set
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
Copyright © 2011 DS Data Systems UK Ltd.