com.konakart.appif

Interface ProductsIf

All Known Implementing Classes:

Products

public interface ProductsIf

This is normally the object returned for API calls returning an array of Products. It contains an array of products and the total number of products matching the request, so that they can be paged. It may also contain the category and manufacturer facets for the search, when Solr is used.

Method Summary

Modifier and Type	Method and Description
CategoryIf[]	getCategoryFacets() The result of a product search using Solr may contain the category facets including the number of products per category.
KKFacetIf[]	getCustomFacets() The result of a product search using Solr may contain facet information for custom fields.
ManufacturerIf[]	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.
KKPriceFacetIf[]	getPriceFacets() Price facets returned after a Solr search
ProductIf[]	getProductArray()
ProductRelationshipIf[]	getRelationData() Only populated by the API call getRelatedProductsWithOptions.
java.math.BigDecimal	getTaxMultiplier() taxMultiplier used to add tax to price facet information
int	getTotalNumProducts()
ProductIf[]	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().

Method Detail

getProductArray

ProductIf[] getProductArray()

Returns:

Returns the productArray.

setProductArray

void setProductArray(ProductIf[] productArray)

Parameters:

productArray - The productArray to set.

getTotalNumProducts

int getTotalNumProducts()

Returns:

Returns the totalNumProducts.

setTotalNumProducts

void setTotalNumProducts(int totalNumProducts)

Parameters:

totalNumProducts - The totalNumProducts to set.

getManufacturerFacets

ManufacturerIf[] getManufacturerFacets()

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

Returns:

the manufacturerFacets

setManufacturerFacets

void setManufacturerFacets(ManufacturerIf[] manufacturerFacets)

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

Parameters:

manufacturerFacets - the manufacturerFacets to set

getCategoryFacets

CategoryIf[] getCategoryFacets()

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

Returns:

the categoryFacets

setCategoryFacets

void setCategoryFacets(CategoryIf[] categoryFacets)

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

Parameters:

categoryFacets - the categoryFacets to set

getCustomFacets

KKFacetIf[] getCustomFacets()

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

Returns:

the customFacets

setCustomFacets

void setCustomFacets(KKFacetIf[] customFacets)

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

Parameters:

customFacets - the customFacets to set

getMaxPrice

java.math.BigDecimal getMaxPrice()

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

Returns:

the maxPrice

setMaxPrice

void setMaxPrice(java.math.BigDecimal maxPrice)

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

Parameters:

maxPrice - the maxPrice to set

getMinPrice

java.math.BigDecimal getMinPrice()

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

Returns:

the minPrice

setMinPrice

void setMinPrice(java.math.BigDecimal minPrice)

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

Parameters:

minPrice - the minPrice to set

getPriceFacets

KKPriceFacetIf[] getPriceFacets()

Price facets returned after a Solr search

Returns:

the priceFacets

setPriceFacets

void setPriceFacets(KKPriceFacetIf[] priceFacets)

Price facets returned after a Solr search

Parameters:

priceFacets - the priceFacets to set

getTaxMultiplier

java.math.BigDecimal getTaxMultiplier()

taxMultiplier used to add tax to price facet information

Returns:

the taxMultiplier

setTaxMultiplier

void setTaxMultiplier(java.math.BigDecimal taxMultiplier)

taxMultiplier used to add tax to price facet information

Parameters:

taxMultiplier - the taxMultiplier to set

getUniqueProductArray

ProductIf[] 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.

Returns:

the uniqueProductArray

setUniqueProductArray

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.

Parameters:

uniqueProductArray - the uniqueProductArray to set

getRelationData

ProductRelationshipIf[] 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.

Returns:

the relationData

setRelationData

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.

Parameters:

relationData - the relationData to set