com.konakart.app

Class Products

java.lang.Object

com.konakart.app.Products

All Implemented Interfaces:

ProductsIf

public class Products
extends java.lang.Object
implements ProductsIf

Products object

Constructor Summary

Constructors

Constructor and Description
Products() Constructor

Method Summary

Modifier and Type	Method and Description
Category[]	getCategoryFacets() The result of a product search using Solr may contain the category facets including the number of products per category.
KKFacet[]	getCustomFacets() The result of a product search using Solr may contain facet information for custom fields.
Manufacturer[]	getManufacturerFacets() The result of a product search using Solr may contain the manufacturer facets including the number of products per manufacturer.
java.math.BigDecimal	getMaxPrice() The maximum price for all products.
java.math.BigDecimal	getMinPrice() The minimum price for all products.
KKPriceFacet[]	getPriceFacets() Price facets returned after a Solr search
Product[]	getProductArray()
ProductRelationship[]	getRelationData() Only populated by the API call getRelatedProductsWithOptions.
java.math.BigDecimal	getTaxMultiplier() taxMultiplier used to add tax to price facet information
int	getTotalNumProducts()
Product[]	getUniqueProductArray() This attribute is only populated by the API calls getBundlesThatProductBelongsTo() and getBundlesThatProductsBelongTo().
void	setCategoryFacets(CategoryIf[] categoryFacets) The result of a product search using Solr may contain the category facets including the number of products per category.
void	setCustomFacets(KKFacetIf[] customFacets) The result of a product search using Solr may contain facet information for custom fields.
void	setManufacturerFacets(ManufacturerIf[] manufacturerFacets) The result of a product search using Solr may contain the manufacturer facets including the number of products per manufacturer.
void	setMaxPrice(java.math.BigDecimal maxPrice) The maximum price for all products.
void	setMinPrice(java.math.BigDecimal minPrice) The minimum price for all products.
void	setPriceFacets(KKPriceFacetIf[] priceFacets) Price facets returned after a Solr search
void	setProductArray(ProductIf[] productArray)
void	setRelationData(ProductRelationshipIf[] relationData) Only populated by the API call getRelatedProductsWithOptions.
void	setTaxMultiplier(java.math.BigDecimal taxMultiplier) taxMultiplier used to add tax to price facet information
void	setTotalNumProducts(int totalNumProducts)
void	setUniqueProductArray(ProductIf[] uniqueProductArray) This attribute is only populated by the API calls getBundlesThatProductBelongsTo() and getBundlesThatProductsBelongTo().

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Products

public Products()

Constructor

Method Detail

getProductArray

public Product[] getProductArray()

Specified by:

getProductArray in interface ProductsIf

Returns:

Returns the productArray.

setProductArray

public void setProductArray(ProductIf[] productArray)

Specified by:

setProductArray in interface ProductsIf

Parameters:

productArray - The productArray to set.

getTotalNumProducts

public int getTotalNumProducts()

Specified by:

getTotalNumProducts in interface ProductsIf

Returns:

Returns the totalNumProducts.

setTotalNumProducts

public void setTotalNumProducts(int totalNumProducts)

Specified by:

setTotalNumProducts in interface ProductsIf

Parameters:

totalNumProducts - The totalNumProducts to set.

getManufacturerFacets

public Manufacturer[] getManufacturerFacets()

Description copied from interface: ProductsIf

The result of a product search using Solr may contain the manufacturer facets including the number of products per manufacturer.

Specified by:

getManufacturerFacets in interface ProductsIf

Returns:

the manufacturerFacets

setManufacturerFacets

public void setManufacturerFacets(ManufacturerIf[] manufacturerFacets)

Description copied from interface: ProductsIf

The result of a product search using Solr may contain the manufacturer facets including the number of products per manufacturer.

Specified by:

setManufacturerFacets in interface ProductsIf

Parameters:

manufacturerFacets - the manufacturerFacets to set

getCategoryFacets

public Category[] getCategoryFacets()

Description copied from interface: ProductsIf

The result of a product search using Solr may contain the category facets including the number of products per category.

Specified by:

getCategoryFacets in interface ProductsIf

Returns:

the categoryFacets

setCategoryFacets

public void setCategoryFacets(CategoryIf[] categoryFacets)

Description copied from interface: ProductsIf

The result of a product search using Solr may contain the category facets including the number of products per category.

Specified by:

setCategoryFacets in interface ProductsIf

Parameters:

categoryFacets - the categoryFacets to set

getCustomFacets

public KKFacet[] getCustomFacets()

Description copied from interface: ProductsIf

The result of a product search using Solr may contain facet information for custom fields.

Specified by:

getCustomFacets in interface ProductsIf

Returns:

the customFacets

setCustomFacets

public void setCustomFacets(KKFacetIf[] customFacets)

Description copied from interface: ProductsIf

The result of a product search using Solr may contain facet information for custom fields.

Specified by:

setCustomFacets in interface ProductsIf

Parameters:

customFacets - the customFacets to set

getMaxPrice

public java.math.BigDecimal getMaxPrice()

The maximum price for all products. Only set when using Solr.

Specified by:

getMaxPrice in interface ProductsIf

Returns:

the maxPrice

setMaxPrice

public void setMaxPrice(java.math.BigDecimal maxPrice)

The maximum price for all products. Only set when using Solr.

Specified by:

setMaxPrice in interface ProductsIf

Parameters:

maxPrice - the maxPrice to set

getMinPrice

public java.math.BigDecimal getMinPrice()

The minimum price for all products. Only set when using Solr.

Specified by:

getMinPrice in interface ProductsIf

Returns:

the minPrice

setMinPrice

public void setMinPrice(java.math.BigDecimal minPrice)

The minimum price for all products. Only set when using Solr.

Specified by:

setMinPrice in interface ProductsIf

Parameters:

minPrice - the minPrice to set

getPriceFacets

public KKPriceFacet[] getPriceFacets()

Price facets returned after a Solr search

Specified by:

getPriceFacets in interface ProductsIf

Returns:

the priceFacets

setPriceFacets

public void setPriceFacets(KKPriceFacetIf[] priceFacets)

Price facets returned after a Solr search

Specified by:

setPriceFacets in interface ProductsIf

Parameters:

priceFacets - the priceFacets to set

getTaxMultiplier

public java.math.BigDecimal getTaxMultiplier()

taxMultiplier used to add tax to price facet information

Specified by:

getTaxMultiplier in interface ProductsIf

Returns:

the taxMultiplier

setTaxMultiplier

public void setTaxMultiplier(java.math.BigDecimal taxMultiplier)

taxMultiplier used to add tax to price facet information

Specified by:

setTaxMultiplier in interface ProductsIf

Parameters:

taxMultiplier - the taxMultiplier to set

getUniqueProductArray

public Product[] getUniqueProductArray()

This attribute is only populated by the API calls getBundlesThatProductBelongsTo() and getBundlesThatProductsBelongTo(). These methods return an array of products, each of which has an array of bundled products. The same products may be repeated many times within the array of bundled products which can affect performance since the amount of data returned can be very large. When createListOfUniqueProducts is set to true in the FetchProductOptions object, the bundled products are only populated with the product id, the quantity and the encodedOptionValues to make them very much lighter. Also within this object the uniqueProductArray attribute is created and populated with a unique set of products that includes just one copy of all of the bundled products.

Specified by:

getUniqueProductArray in interface ProductsIf

Returns:

the uniqueProductArray

setUniqueProductArray

public void setUniqueProductArray(ProductIf[] uniqueProductArray)

This attribute is only populated by the API calls getBundlesThatProductBelongsTo() and getBundlesThatProductsBelongTo(). These methods return an array of products, each of which has an array of bundled products. The same products may be repeated many times within the array of bundled products which can affect performance since the amount of data returned can be very large. When createListOfUniqueProducts is set to true in the FetchProductOptions object, the bundled products are only populated with the product id, the quantity and the encodedOptionValues to make them very much lighter. Also within this object the uniqueProductArray attribute is created and populated with a unique set of products that includes just one copy of all of the bundled products.

Specified by:

setUniqueProductArray in interface ProductsIf

Parameters:

uniqueProductArray - the uniqueProductArray to set

getRelationData

public ProductRelationship[] getRelationData()

Only populated by the API call getRelatedProductsWithOptions. It consists of an array of objects, each of which contains data specific to a relationship between two products.

Specified by:

getRelationData in interface ProductsIf

Returns:

the relationData

setRelationData

public void setRelationData(ProductRelationshipIf[] relationData)

Only populated by the API call getRelatedProductsWithOptions. It consists of an array of objects, each of which contains data specific to a relationship between two products.

Specified by:

setRelationData in interface ProductsIf

Parameters:

relationData - the relationData to set