com.konakart.appif
Interface ProductIf

All Known Implementing Classes:

Product

public interface ProductIf

Describes a product object for use within KonaKart.

Method Summary

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
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()
ProdCustAttrIf[]	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.
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.
MiscItemIf[]	getMiscItems() Miscellaneous Items associated with this product.
java.lang.String	getModel()
java.lang.String	getName()
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()
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()
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.
TagIf[]	getTags()
int	getTaxClassId()
java.lang.String	getTaxCode() tax code used when looking up tax from an external service
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.
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(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	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(ProdCustAttrIf[] 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(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	setMiscItems(MiscItemIf[] 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(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	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	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(TagIf[] tags)
void	setTaxClassId(int taxClassId)
void	setTaxCode(java.lang.String taxCode) tax code used when looking up tax from an external service
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	setViewedCount(int viewedCount) The number of times the product has been viewed.
void	setWeight(java.math.BigDecimal weight)

Method Detail

getTaxClassId

int getTaxClassId()

Returns:

Returns the taxClassId.

setTaxClassId

void setTaxClassId(int taxClassId)

Parameters:

taxClassId - The taxClassId to set.

getManufacturerName

java.lang.String getManufacturerName()

Returns:

Returns the manufacturerName.

setManufacturerName

void setManufacturerName(java.lang.String manufacturerName)

Parameters:

manufacturerName - The manufacturerName to set.

getDescription

java.lang.String getDescription()

Returns:

Returns the description.

setDescription

void setDescription(java.lang.String description)

Parameters:

description - The description to set.

getId

int getId()

Returns:

Returns the id.

setId

void setId(int id)

Parameters:

id - The id to set.

getImage

java.lang.String getImage()

Returns:

Returns the image.

setImage

void setImage(java.lang.String image)

Parameters:

image - The image to set.

getModel

java.lang.String getModel()

Returns:

Returns the model.

setModel

void setModel(java.lang.String model)

Parameters:

model - The model to set.

getName

java.lang.String getName()

Returns:

Returns the name.

setName

void setName(java.lang.String name)

Parameters:

name - The name to set.

getOpts

OptionIf[] getOpts()

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

Returns:

Returns the opts.

setOpts

void setOpts(OptionIf[] opts)

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

Parameters:

opts - The opts to set.

getQuantity

int getQuantity()

Returns:

Returns the quantity.

setQuantity

void setQuantity(int quantity)

Parameters:

quantity - The quantity to set.

getStatus

byte getStatus()

Set to '1' if the product is active. Otherwise set to '0'.

Returns:

Returns the status.

setStatus

void setStatus(byte status)

Set to '1' if the product is active. Otherwise set to '0'.

Parameters:

status - The status to set.

getUrl

java.lang.String getUrl()

The url of the product, for example from the manufacturer's web site.

Returns:

Returns the url.

setUrl

void setUrl(java.lang.String url)

The url of the product, for example from the manufacturer's web site.

Parameters:

url - The url to set.

getViewedCount

int getViewedCount()

The number of times the product has been viewed.

Returns:

Returns the viewedCount.

setViewedCount

void setViewedCount(int viewedCount)

The number of times the product has been viewed.

Parameters:

viewedCount - The viewedCount to set.

getWeight

java.math.BigDecimal getWeight()

Returns:

Returns the weight.

setWeight

void setWeight(java.math.BigDecimal weight)

Parameters:

weight - The weight to set.

getNumberReviews

int getNumberReviews()

Returns:

Returns the numberReviews.

setNumberReviews

void setNumberReviews(int numberReviews)

Parameters:

numberReviews - The numberReviews to set.

getDateAdded

java.util.Calendar getDateAdded()

Returns:

Returns the dateAdded.

setDateAdded

void setDateAdded(java.util.Calendar dateAdded)

Parameters:

dateAdded - The dateAdded to set.

getDateAvailable

java.util.Calendar getDateAvailable()

Returns:

Returns the dateAvailable.

setDateAvailable

void setDateAvailable(java.util.Calendar dateAvailable)

Parameters:

dateAvailable - The dateAvailable to set.

getManufacturer

ManufacturerIf getManufacturer()

Returns:

Returns the manufacturer.

setManufacturer

void setManufacturer(ManufacturerIf manufacturer)

Parameters:

manufacturer - The manufacturer to set.

getManufacturerId

int getManufacturerId()

Returns:

Returns the manufacturerId.

setManufacturerId

void setManufacturerId(int manufacturerId)

Parameters:

manufacturerId - The manufacturerId to set.

getCategoryId

int getCategoryId()

Returns:

Returns the categoryId.

setCategoryId

void setCategoryId(int categoryId)

Parameters:

categoryId - The categoryId to set.

getOrdered

int getOrdered()

The number of times that the product has been ordered.

Returns:

Returns the ordered.

setOrdered

void setOrdered(int ordered)

The number of times that the product has been ordered.

Parameters:

ordered - The ordered to set.

getPriceExTax

java.math.BigDecimal getPriceExTax()

Returns:

Returns the priceExTax.

setPriceExTax

void setPriceExTax(java.math.BigDecimal priceExTax)

Parameters:

priceExTax - The priceExTax to set.

getSpecialPriceExTax

java.math.BigDecimal getSpecialPriceExTax()

Returns:

Returns the specialPriceExTax.

setSpecialPriceExTax

void setSpecialPriceExTax(java.math.BigDecimal specialPriceExTax)

Parameters:

specialPriceExTax - The specialPriceExTax to set.

getSpecialPriceIncTax

java.math.BigDecimal getSpecialPriceIncTax()

Returns:

Returns the specialPriceIncTax.

setSpecialPriceIncTax

void setSpecialPriceIncTax(java.math.BigDecimal specialPriceIncTax)

Parameters:

specialPriceIncTax - The specialPriceIncTax to set.

getPriceIncTax

java.math.BigDecimal getPriceIncTax()

Returns:

Returns the priceIncTax.

setPriceIncTax

void setPriceIncTax(java.math.BigDecimal priceIncTax)

Parameters:

priceIncTax - The priceIncTax to set.

getCustom1

java.lang.String getCustom1()

Returns:

Returns the custom1.

setCustom1

void setCustom1(java.lang.String custom1)

Parameters:

custom1 - The custom1 to set.

getCustom2

java.lang.String getCustom2()

Returns:

Returns the custom2.

setCustom2

void setCustom2(java.lang.String custom2)

Parameters:

custom2 - The custom2 to set.

getCustom3

java.lang.String getCustom3()

Returns:

Returns the custom3.

setCustom3

void setCustom3(java.lang.String custom3)

Parameters:

custom3 - The custom3 to set.

getCustom4

java.lang.String getCustom4()

Returns:

Returns the custom4.

setCustom4

void setCustom4(java.lang.String custom4)

Parameters:

custom4 - The custom4 to set.

getCustom5

java.lang.String getCustom5()

Returns:

Returns the custom5.

setCustom5

void setCustom5(java.lang.String custom5)

Parameters:

custom5 - The custom5 to set.

getCustom6

java.lang.String getCustom6()

Returns:

the custom6

setCustom6

void setCustom6(java.lang.String custom6)

Parameters:

custom6 - the custom6 to set

getCustom7

java.lang.String getCustom7()

Returns:

the custom7

setCustom7

void setCustom7(java.lang.String custom7)

Parameters:

custom7 - the custom7 to set

getCustom8

java.lang.String getCustom8()

Returns:

the custom8

setCustom8

void setCustom8(java.lang.String custom8)

Parameters:

custom8 - the custom8 to set

getCustom9

java.lang.String getCustom9()

Returns:

the custom9

setCustom9

void setCustom9(java.lang.String custom9)

Parameters:

custom9 - the custom9 to set

getCustom10

java.lang.String getCustom10()

Returns:

the custom10

setCustom10

void setCustom10(java.lang.String custom10)

Parameters:

custom10 - the custom10 to set

getCustom1Int

int getCustom1Int()

Returns:

the custom1Int

setCustom1Int

void setCustom1Int(int custom1Int)

Parameters:

custom1Int - the custom1Int to set

getCustom2Int

int getCustom2Int()

Returns:

the custom2Int

setCustom2Int

void setCustom2Int(int custom2Int)

Parameters:

custom2Int - the custom2Int to set

getCustom1Dec

java.math.BigDecimal getCustom1Dec()

Returns:

the custom1Dec

setCustom1Dec

void setCustom1Dec(java.math.BigDecimal custom1Dec)

Parameters:

custom1Dec - the custom1Dec to set

getCustom2Dec

java.math.BigDecimal getCustom2Dec()

Returns:

the custom2Dec

setCustom2Dec

void setCustom2Dec(java.math.BigDecimal custom2Dec)

Parameters:

custom2Dec - the custom2Dec to set

getProdRelationTypeArray

int[] getProdRelationTypeArray()

When products are returned from the API call getRelatedProducts() they will have this array initialised. It is an array of integers where each integer defines a relation type. The valid relation types are:

• com.konakart.bl.ProductMgr.UP_SELL - Up Sell
• com.konakart.bl.ProductMgr.CROSS_SELL - Cross Sell
• com.konakart.bl.ProductMgr.ACCESSORY - Accessory
• com.konakart.bl.ProductMgr.DEPENDENT_ITEM - Dependent item
• com.konakart.bl.ProductMgr.BUNDLED_PRODUCT_RELATIONSHIP - Bundled product
• com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_1 - Custom Relationship
• com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_2 - Custom Relationship
• com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_3 - Custom Relationship

An array is necessary because a product may be related to another product in more than one way.

Returns:

Returns the prodRelationTypeArray.

setProdRelationTypeArray

void setProdRelationTypeArray(int[] prodRelationTypeArray)

When products are returned from the API call getRelatedProducts() they will have this array initialised. It is an array of integers where each integer defines a relation type. The valid relation types are:

• com.konakart.bl.ProductMgr.UP_SELL - Up Sell
• com.konakart.bl.ProductMgr.CROSS_SELL - Cross Sell
• com.konakart.bl.ProductMgr.ACCESSORY - Accessory
• com.konakart.bl.ProductMgr.DEPENDENT_ITEM - Dependent item
• com.konakart.bl.ProductMgr.BUNDLED_PRODUCT_RELATIONSHIP - Bundled product
• com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_1 - Custom Relationship
• com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_2 - Custom Relationship
• com.konakart.bl.ProductMgr.CUSTOM_RELATIONSHIP_3 - Custom Relationship

An array is necessary because a product may be related to another product in more than one way.

Parameters:

prodRelationTypeArray - The prodRelationTypeArray to set.

getInvisible

byte getInvisible()

When set to '1' the product is invisible and will not be returned from normal API calls.

Returns:

Returns the invisible.

setInvisible

void setInvisible(byte invisible)

When set to '1' the product is invisible and will not be returned from normal API calls.

Parameters:

invisible - The invisible to set.

getSku

java.lang.String getSku()

The SKU is the stock keeping unit.

Returns:

Returns the sku.

setSku

void setSku(java.lang.String sku)

The SKU is the stock keeping unit.

Parameters:

sku - The sku to set.

getContentType

java.lang.String getContentType()

Valid for digital products. The Content Type describes the content of the file. Examples are "image/jpeg" or "application/pdf".

Returns:

Returns the contentType.

setContentType

void setContentType(java.lang.String contentType)

Valid for digital products. The Content Type describes the content of the file. Examples are "image/jpeg" or "application/pdf".

Parameters:

contentType - The contentType to set.

getFilePath

java.lang.String getFilePath()

Valid for digital products. The File Path is the path of a file containing the digital product. This path will be appended to the Base Path defined by a configuration variable.

Returns:

Returns the filePath.

setFilePath

void setFilePath(java.lang.String filePath)

Valid for digital products. The File Path is the path of a file containing the digital product. This path will be appended to the Base Path defined by a configuration variable.

Parameters:

filePath - The filePath to set.

getType

int getType()

product type.

• com.konakart.bl.ProductMgr.PHYSICAL_PRODUCT = physical product
• com.konakart.bl.ProductMgr.DIGITAL_DOWNLOAD = digital download product
• com.konakart.bl.ProductMgr.FREE_SHIPPING = physical product with free shipping
• com.konakart.bl.ProductMgr.BUNDLE_PRODUCT_TYPE = a product that bundles other product
• com.konakart.bl.ProductMgr.FREE_SHIPPING_BUNDLE_PRODUCT_TYPE = a product that bundles other product with free shipping

Returns:

Returns the type.

setType

void setType(int type)

product type.

• com.konakart.bl.ProductMgr.PHYSICAL_PRODUCT = physical product
• com.konakart.bl.ProductMgr.DIGITAL_DOWNLOAD = digital download product
• com.konakart.bl.ProductMgr.FREE_SHIPPING = physical product with free shipping
• com.konakart.bl.ProductMgr.BUNDLE_PRODUCT_TYPE = a product that bundles other product
• com.konakart.bl.ProductMgr.FREE_SHIPPING_BUNDLE_PRODUCT_TYPE = a product that bundles other product with free shipping

Parameters:

type - The type to set.

getImage2

java.lang.String getImage2()

Returns:

Returns the image2.

setImage2

void setImage2(java.lang.String image2)

Parameters:

image2 - The image2 to set.

getImage3

java.lang.String getImage3()

Returns:

Returns the image3.

setImage3

void setImage3(java.lang.String image3)

Parameters:

image3 - The image3 to set.

getImage4

java.lang.String getImage4()

Returns:

Returns the image4.

setImage4

void setImage4(java.lang.String image4)

Parameters:

image4 - The image4 to set.

getComparison

java.lang.String getComparison()

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

Returns:

Returns the comparison.

setComparison

void setComparison(java.lang.String comparison)

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

Parameters:

comparison - The comparison to set.

getPrice0

java.math.BigDecimal getPrice0()

Returns:

Returns the price0.

setPrice0

void setPrice0(java.math.BigDecimal price0)

Parameters:

price0 - The price0 to set.

getPrice1

java.math.BigDecimal getPrice1()

Returns:

Returns the price1.

setPrice1

void setPrice1(java.math.BigDecimal price1)

Parameters:

price1 - The price1 to set.

getPrice2

java.math.BigDecimal getPrice2()

Returns:

Returns the price2.

setPrice2

void setPrice2(java.math.BigDecimal price2)

Parameters:

price2 - The price2 to set.

getPrice3

java.math.BigDecimal getPrice3()

Returns:

Returns the price3.

setPrice3

void setPrice3(java.math.BigDecimal price3)

Parameters:

price3 - The price3 to set.

getBundledProdQuantity

int getBundledProdQuantity()

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

Returns:

Returns the bundledProdQuantity.

setBundledProdQuantity

void setBundledProdQuantity(int bundledProdQuantity)

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

Parameters:

bundledProdQuantity - The bundledProdQuantity to set.

getEncodedOptionValues

java.lang.String getEncodedOptionValues()

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

Returns:

Returns the encodedOptionValues.

setEncodedOptionValues

void setEncodedOptionValues(java.lang.String encodedOptionValues)

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

Parameters:

encodedOptionValues - The encodedOptionValues to set.

getTags

TagIf[] getTags()

Returns:

Returns the tags.

setTags

void setTags(TagIf[] tags)

Parameters:

tags - The tags to set.

getStoreId

java.lang.String getStoreId()

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

Returns:

Returns the store id

setStoreId

void setStoreId(java.lang.String storeId)

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

Parameters:

storeId -

getMaxNumDownloads

int getMaxNumDownloads()

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

Returns:

the maxNumDownloads

setMaxNumDownloads

void setMaxNumDownloads(int maxNumDownloads)

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

Parameters:

maxNumDownloads - the maxNumDownloads to set

getMaxDownloadDays

int getMaxDownloadDays()

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

Returns:

the maxDownloadDays

setMaxDownloadDays

void setMaxDownloadDays(int maxDownloadDays)

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

Parameters:

maxDownloadDays - the maxDownloadDays to set

getStockReorderLevel

int getStockReorderLevel()

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

Returns:

the stockReorderLevel

setStockReorderLevel

void setStockReorderLevel(int stockReorderLevel)

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

Parameters:

stockReorderLevel - the stockReorderLevel to set

getCanOrderWhenNotInStock

java.lang.Boolean getCanOrderWhenNotInStock()

If null then we use the global value set by the config variable STOCK_ALLOW_CHECKOUT. If the value isn't null, then it overrides the global value.

Returns:

the canOrderWhenNotInStock

setCanOrderWhenNotInStock

void setCanOrderWhenNotInStock(java.lang.Boolean canOrderWhenNotInStock)

If null then we use the global value set by the config variable STOCK_ALLOW_CHECKOUT. If the value isn't null, then it overrides the global value.

Parameters:

canOrderWhenNotInStock - the canOrderWhenNotInStock to set

isIndexAttachment

boolean isIndexAttachment()

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

Returns:

the indexAttachment

setIndexAttachment

void setIndexAttachment(boolean indexAttachment)

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

Parameters:

indexAttachment - the indexAttachment to set

getSnippets

java.lang.String[] getSnippets()

Array of strings containing snippets which are text fragments surrounding the search keywords.

Returns:

the snippets

setSnippets

void setSnippets(java.lang.String[] snippets)

Array of strings containing snippets which are text fragments surrounding the search keywords.

Parameters:

snippets - the snippets to set

getRating

java.math.BigDecimal getRating()

Average product rating

Returns:

the rating

setRating

void setRating(java.math.BigDecimal rating)

Average product rating

Parameters:

rating - the rating to set

getExpiryDate

java.util.Calendar getExpiryDate()

The date that the product expires

Returns:

the expiryDate

setExpiryDate

void setExpiryDate(java.util.Calendar expiryDate)

The date that the product expires

Parameters:

expiryDate - the expiryDate to set

getPaymentScheduleId

int getPaymentScheduleId()

Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.

Returns:

the paymentScheduleId

setPaymentScheduleId

void setPaymentScheduleId(int paymentScheduleId)

Determines whether the product requires recurring billing and if so, connects it to a Payment Schedule object.

Parameters:

paymentScheduleId - the paymentScheduleId to set

getPaymentSchedule

PaymentScheduleIf getPaymentSchedule()

A product may be associated to a PaymentSchedule object when it is paid for using recurring billing.

Returns:

the paymentSchedule

setPaymentSchedule

void setPaymentSchedule(PaymentScheduleIf paymentSchedule)

A product may be associated to a PaymentSchedule object when it is paid for using recurring billing.

Parameters:

paymentSchedule - the paymentSchedule to set

getTierPrices

TierPriceIf[] getTierPrices()

An array of tier price objects for this product

Returns:

the tierPrices

setTierPrices

void setTierPrices(TierPriceIf[] tierPrices)

An array of tier price objects for this product

Parameters:

tierPrices - the tierPrices to set

getSpecialExpiryDate

java.util.Calendar getSpecialExpiryDate()

The date when the special price expires

Returns:

the specialExpiryDate

setSpecialExpiryDate

void setSpecialExpiryDate(java.util.Calendar specialExpiryDate)

The date when the special price expires

Parameters:

specialExpiryDate - the specialExpiryDate to set

getSpecialStartDate

java.util.Calendar getSpecialStartDate()

The date when the special price starts

Returns:

the specialStartDate

setSpecialStartDate

void setSpecialStartDate(java.util.Calendar specialStartDate)

The date when the special price starts

Parameters:

specialStartDate - the specialStartDate to set

getSpecialStatus

byte getSpecialStatus()

Set to '1' if the special price is active. Otherwise set to '0'.

Returns:

the specialStatus

setSpecialStatus

void setSpecialStatus(byte specialStatus)

Set to '1' if the special price is active. Otherwise set to '0'.

Parameters:

specialStatus - the specialStatus to set

getProductQuantities

ProductQuantityIf[] getProductQuantities()

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

Returns:

the productQuantities

setProductQuantities

void setProductQuantities(ProductQuantityIf[] productQuantities)

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

Parameters:

productQuantities - the productQuantities to set

getAddresses

AddressIf[] getAddresses()

An array containing all of the addresses defined for this product.

Returns:

Returns the addresses.

setAddresses

void setAddresses(AddressIf[] addresses)

An array containing all of the addresses defined for this product.

Parameters:

addresses - The addresses to set.

getCustomAttrs

java.lang.String getCustomAttrs()

Contains the custom attributes in XML format

Returns:

the customAttrs

setCustomAttrs

void setCustomAttrs(java.lang.String customAttrs)

Contains the custom attributes in XML format

Parameters:

customAttrs - the customAttrs to set

getCustomAttrArray

ProdCustAttrIf[] getCustomAttrArray()

An array of ProdCustAttr objects

Returns:

the customAttrArray

setCustomAttrArray

void setCustomAttrArray(ProdCustAttrIf[] customAttrArray)

An array of ProdCustAttr objects

Parameters:

customAttrArray - the customAttrArray to set

getTaxCode

java.lang.String getTaxCode()

tax code used when looking up tax from an external service

Returns:

the taxCode

setTaxCode

void setTaxCode(java.lang.String taxCode)

tax code used when looking up tax from an external service

Parameters:

taxCode - the taxCode to set

getStoreCustom1

java.lang.String getStoreCustom1()

Custom field with unique value for a store when in multi-store shared products mode

Returns:

the storeCustom1

setStoreCustom1

void setStoreCustom1(java.lang.String storeCustom1)

Custom field with unique value for a store when in multi-store shared products mode

Parameters:

storeCustom1 - the storeCustom1 to set

getStoreCustom2

java.lang.String getStoreCustom2()

Custom field with unique value for a store when in multi-store shared products mode

Returns:

the storeCustom2

setStoreCustom2

void setStoreCustom2(java.lang.String storeCustom2)

Custom field with unique value for a store when in multi-store shared products mode

Parameters:

storeCustom2 - the storeCustom2 to set

getStoreCustom3

java.lang.String getStoreCustom3()

Custom field with unique value for a store when in multi-store shared products mode

Returns:

the storeCustom3

setStoreCustom3

void setStoreCustom3(java.lang.String storeCustom3)

Custom field with unique value for a store when in multi-store shared products mode

Parameters:

storeCustom3 - the storeCustom3 to set

getBookableProd

BookableProductIf getBookableProd()

An object containing attributes relevant to a bookable product

Returns:

the bookableProd

setBookableProd

void setBookableProd(BookableProductIf bookableProd)

An object containing attributes relevant to a bookable product

Parameters:

bookableProd - the bookableProd to set

getMiscItems

MiscItemIf[] getMiscItems()

Miscellaneous Items associated with this product.

Returns:

the miscItems associated with this product.

setMiscItems

void setMiscItems(MiscItemIf[] miscItems)

Miscellaneous Items associated with this product

Parameters:

miscItems - the miscItems to set

getPromotionResults

PromotionResultIf[] getPromotionResults()

Active promotions for this product

Returns:

the promotionResults

setPromotionResults

void setPromotionResults(PromotionResultIf[] promotionResults)

Active promotions for this product

Parameters:

promotionResults - the promotionResults to set