com.konakart.appif
Interface ProductIf

public interface ProductIf

Describes a product object for use within KonaKart.

Method Summary

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
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	getCustom2()
java.lang.String	getCustom3()
java.lang.String	getCustom4()
java.lang.String	getCustom5()
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.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()
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.
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.
int	getQuantity()
java.lang.String	getSku() The SKU is the stock keeping unit.
java.math.BigDecimal	getSpecialPriceExTax()
java.math.BigDecimal	getSpecialPriceIncTax()
byte	getStatus() Set to '1' if the product is in stock.
TagIf[]	getTags()
int	getTaxClassId()
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()
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	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	setCustom2(java.lang.String custom2)
void	setCustom3(java.lang.String custom3)
void	setCustom4(java.lang.String custom4)
void	setCustom5(java.lang.String custom5)
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	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	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	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	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	setQuantity(int quantity)
void	setSku(java.lang.String sku) The SKU is the stock keeping unit.
void	setSpecialPriceExTax(java.math.BigDecimal specialPriceExTax)
void	setSpecialPriceIncTax(java.math.BigDecimal specialPriceIncTax)
void	setStatus(byte status) Set to '1' if the product is in stock.
void	setTags(TagIf[] tags)
void	setTaxClassId(int taxClassId)
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 in stock. Otherwise set to '0'.

Returns:

Returns the status.

setStatus

void setStatus(byte status)

Set to '1' if the product is in stock. 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.

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

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

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.