public class FetchProductOptions extends java.lang.Object implements FetchProductOptionsIf
| Constructor and Description |
|---|
FetchProductOptions()
Constructor
|
| Modifier and Type | Method and Description |
|---|---|
java.lang.String |
getCatalogId()
The id of the catalog which contains dynamic product information such as the price and
quantity
|
java.lang.String |
getCustom1()
Can be used for passing data to customize the query.
|
java.lang.String |
getCustom2()
Can be used for passing data to customize the query.
|
java.lang.String |
getCustom3()
Can be used for passing data to customize the query.
|
java.lang.String |
getCustom4()
Can be used for passing data to customize the query.
|
java.lang.String |
getCustom5()
Can be used for passing data to customize the query.
|
int[] |
getInventoryUpdateExcludeProdTypes()
Used to define product types that are excluded from inventory updates.
|
java.util.Calendar |
getPriceDate()
The date for which a price is requested.
|
boolean |
isCalcQuantityForBundles()
When set to true the quantity available for a product is calculated by reading the quantities
of the products within the bundle.
|
boolean |
isCreateListOfUniqueProducts()
This attribute is only used by the API calls
getBundlesThatProductBelongsTo()
and getBundlesThatProductsBelongTo(). |
boolean |
isForceUseSolr()
This attribute also exists in the ProductSearch object.
|
boolean |
isGetImages()
If true we attach a ProductImages object to the product, which contains a list of image names
available for it.
|
boolean |
isGetProductSuggestions()
If set to true the Product Suggestions from the AI service are added to the product
|
boolean |
isGetRelationshipData()
Only used by the API call
getRelatedProductsWithOptions. |
boolean |
isGetStockReservationInfo()
If true, information about reserved stock is returned as well as normal stock when fetching
products from the database.
|
boolean |
isGetStoreDescription()
If true, when in multi-vendor mode the store description attribute of the product is
populated.
|
boolean |
isGetStoreName()
If true, when in multi-vendor mode the store name attribute of the product is populated.
|
boolean |
isGetTags()
If true we attach an array of Tag objects to the product.
|
boolean |
isGetTierPrices()
If true we attach an array of TierPrice objects to the product.
|
boolean |
isGetVariantPrices()
If true we attach an array of VariantPrice objects to the product.
|
boolean |
isInvertRelatedProductDirection()
If true we invert the direction of the related product link.
|
boolean |
isUseExternalPrice()
If true we attempt to fetch the prices from the external table
|
boolean |
isUseExternalQuantity()
If true we attempt to fetch the quantities from the external table
|
void |
setCalcQuantityForBundles(boolean calcQuantityForBundles)
When set to true the quantity available for a product is calculated by reading the quantities
of the products within the bundle.
|
void |
setCatalogId(java.lang.String catalogId)
The id of the catalog which contains dynamic product information such as the price and
quantity
|
void |
setCreateListOfUniqueProducts(boolean createListOfUniqueProducts)
This attribute is only used by the API calls
getBundlesThatProductBelongsTo()
and getBundlesThatProductsBelongTo(). |
void |
setCustom1(java.lang.String custom1)
Can be used for passing data to customize the query.
|
void |
setCustom2(java.lang.String custom2)
Can be used for passing data to customize the query.
|
void |
setCustom3(java.lang.String custom3)
Can be used for passing data to customize the query.
|
void |
setCustom4(java.lang.String custom4) |
void |
setCustom5(java.lang.String custom5)
Can be used for passing data to customize the query.
|
void |
setForceUseSolr(boolean forceUseSolr)
This attribute also exists in the ProductSearch object.
|
void |
setGetImages(boolean getImages)
If true we attach a ProductImages object to the product, which contains a list of image names
available for it.
|
void |
setGetProductSuggestions(boolean getProductSuggestions)
If set to true the Product Suggestions from the AI service are added to the product.
|
void |
setGetRelationshipData(boolean getRelationshipData)
Only used by the API call
getRelatedProductsWithOptions. |
void |
setGetStockReservationInfo(boolean getStockReservationInfo)
If true, information about reserved stock is returned as well as normal stock when fetching
products from the database.
|
void |
setGetStoreDescription(boolean getStoreDescription)
If true, when in multi-vendor mode the store description attribute of the product is
populated.
|
void |
setGetStoreName(boolean getStoreName)
If true, when in multi-vendor mode the store name attribute of the product is populated.
|
void |
setGetTags(boolean getTags)
If true we attach an array of Tag objects to the product.
|
void |
setGetTierPrices(boolean getTierPrices)
If true we attach an array of TierPrice objects to the product.
|
void |
setGetVariantPrices(boolean getVariantPrices)
If true we attach an array of VariantPrice objects to the product.
|
void |
setInventoryUpdateExcludeProdTypes(int[] inventoryUpdateExcludeProdTypes)
Used to define product types that are excluded from inventory updates.
|
void |
setInvertRelatedProductDirection(boolean invertRelatedProductDirection)
If true we invert the direction of the related product link.
|
void |
setPriceDate(java.util.Calendar priceDate)
The date for which a price is requested.
|
void |
setUseExternalPrice(boolean useExternalPrice)
If true we attempt to fetch the prices from the external table
|
void |
setUseExternalQuantity(boolean useExternalQuantity)
If true we attempt to fetch the quantities from the external table
|
java.lang.String |
toString() |
public java.lang.String toString()
toString in class java.lang.Objectpublic java.lang.String getCatalogId()
FetchProductOptionsIfgetCatalogId in interface FetchProductOptionsIfpublic void setCatalogId(java.lang.String catalogId)
FetchProductOptionsIfsetCatalogId in interface FetchProductOptionsIfcatalogId - the catalogId to setpublic java.util.Calendar getPriceDate()
FetchProductOptionsIfgetPriceDate in interface FetchProductOptionsIfpublic void setPriceDate(java.util.Calendar priceDate)
FetchProductOptionsIfsetPriceDate in interface FetchProductOptionsIfpriceDate - the priceDate to setpublic boolean isUseExternalPrice()
FetchProductOptionsIfisUseExternalPrice in interface FetchProductOptionsIfpublic void setUseExternalPrice(boolean useExternalPrice)
FetchProductOptionsIfsetUseExternalPrice in interface FetchProductOptionsIfuseExternalPrice - the useExternalPrice to setpublic boolean isGetTierPrices()
FetchProductOptionsIfisGetTierPrices in interface FetchProductOptionsIfpublic void setGetTierPrices(boolean getTierPrices)
FetchProductOptionsIfsetGetTierPrices in interface FetchProductOptionsIfgetTierPrices - the getTierPrices to setpublic boolean isUseExternalQuantity()
FetchProductOptionsIfisUseExternalQuantity in interface FetchProductOptionsIfpublic void setUseExternalQuantity(boolean useExternalQuantity)
FetchProductOptionsIfsetUseExternalQuantity in interface FetchProductOptionsIfuseExternalQuantity - the useExternalQuantity to setpublic boolean isInvertRelatedProductDirection()
FetchProductOptionsIfisInvertRelatedProductDirection in interface FetchProductOptionsIfpublic void setInvertRelatedProductDirection(boolean invertRelatedProductDirection)
FetchProductOptionsIfsetInvertRelatedProductDirection in interface FetchProductOptionsIfinvertRelatedProductDirection - the invertRelatedProductDirection to setpublic boolean isCalcQuantityForBundles()
FetchProductOptionsIfisCalcQuantityForBundles in interface FetchProductOptionsIfpublic void setCalcQuantityForBundles(boolean calcQuantityForBundles)
FetchProductOptionsIfsetCalcQuantityForBundles in interface FetchProductOptionsIfcalcQuantityForBundles - the calcQuantityForBundles to setpublic boolean isGetTags()
FetchProductOptionsIfisGetTags in interface FetchProductOptionsIfpublic void setGetTags(boolean getTags)
FetchProductOptionsIfsetGetTags in interface FetchProductOptionsIfgetTags - the getTags to setpublic boolean isCreateListOfUniqueProducts()
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, the
bundled products are only populated with the product id, the quantity and the
encodedOptionValues to make them very much lighter. Also within the Products return 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.isCreateListOfUniqueProducts in interface FetchProductOptionsIfpublic void setCreateListOfUniqueProducts(boolean createListOfUniqueProducts)
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, the
bundled products are only populated with the product id, the quantity and the
encodedOptionValues to make them very much lighter. Also within the Products return 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.setCreateListOfUniqueProducts in interface FetchProductOptionsIfcreateListOfUniqueProducts - the createListOfUniqueProducts to setpublic boolean isGetRelationshipData()
getRelatedProductsWithOptions. If set to true, the
return Products object contains an array of ProductRelationship
objects which contain data specific to each relationship.isGetRelationshipData in interface FetchProductOptionsIfpublic void setGetRelationshipData(boolean getRelationshipData)
getRelatedProductsWithOptions. If set to true, the
return Products object contains an array of ProductRelationship
objects which contain data specific to each relationship.setGetRelationshipData in interface FetchProductOptionsIfgetRelationshipData - the getRelationshipData to setpublic java.lang.String getCustom1()
FetchProductOptionsIfgetCustom1 in interface FetchProductOptionsIfpublic void setCustom1(java.lang.String custom1)
FetchProductOptionsIfsetCustom1 in interface FetchProductOptionsIfcustom1 - the custom1 to setpublic java.lang.String getCustom2()
FetchProductOptionsIfgetCustom2 in interface FetchProductOptionsIfpublic void setCustom2(java.lang.String custom2)
FetchProductOptionsIfsetCustom2 in interface FetchProductOptionsIfcustom2 - the custom2 to setpublic java.lang.String getCustom3()
FetchProductOptionsIfgetCustom3 in interface FetchProductOptionsIfpublic void setCustom3(java.lang.String custom3)
FetchProductOptionsIfsetCustom3 in interface FetchProductOptionsIfcustom3 - the custom3 to setpublic java.lang.String getCustom4()
FetchProductOptionsIfgetCustom4 in interface FetchProductOptionsIfpublic void setCustom4(java.lang.String custom4)
setCustom4 in interface FetchProductOptionsIfcustom4 - the custom4 to setpublic java.lang.String getCustom5()
FetchProductOptionsIfgetCustom5 in interface FetchProductOptionsIfpublic void setCustom5(java.lang.String custom5)
FetchProductOptionsIfsetCustom5 in interface FetchProductOptionsIfcustom5 - the custom5 to setpublic boolean isGetImages()
isGetImages in interface FetchProductOptionsIfpublic void setGetImages(boolean getImages)
setGetImages in interface FetchProductOptionsIfgetImages - the getImages to setpublic boolean isGetStockReservationInfo()
isGetStockReservationInfo in interface FetchProductOptionsIfpublic void setGetStockReservationInfo(boolean getStockReservationInfo)
setGetStockReservationInfo in interface FetchProductOptionsIfgetStockReservationInfo - the getStockReservationInfo to setpublic int[] getInventoryUpdateExcludeProdTypes()
getInventoryUpdateExcludeProdTypes in interface FetchProductOptionsIfpublic void setInventoryUpdateExcludeProdTypes(int[] inventoryUpdateExcludeProdTypes)
setInventoryUpdateExcludeProdTypes in interface FetchProductOptionsIfinventoryUpdateExcludeProdTypes - the inventoryUpdateExcludeProdTypes to setpublic boolean isForceUseSolr()
When set to true, Solr is used even though KonaKart may not have used Solr. By default, Solr is only used when doing text searches or when returning custom facets.
isForceUseSolr in interface FetchProductOptionsIfpublic void setForceUseSolr(boolean forceUseSolr)
When set to true, Solr is used even though KonaKart may not have used Solr. By default, Solr is only used when doing text searches or when returning custom facets.
setForceUseSolr in interface FetchProductOptionsIfforceUseSolr - the forceUseSolr to setpublic boolean isGetStoreName()
isGetStoreName in interface FetchProductOptionsIfpublic void setGetStoreName(boolean getStoreName)
setGetStoreName in interface FetchProductOptionsIfgetStoreName - the getStoreName to setpublic boolean isGetStoreDescription()
isGetStoreDescription in interface FetchProductOptionsIfpublic void setGetStoreDescription(boolean getStoreDescription)
setGetStoreDescription in interface FetchProductOptionsIfgetStoreDescription - the getStoreDescription to setpublic boolean isGetProductSuggestions()
isGetProductSuggestions in interface FetchProductOptionsIfpublic void setGetProductSuggestions(boolean getProductSuggestions)
setGetProductSuggestions in interface FetchProductOptionsIfgetProductSuggestions - the product suggestions settingpublic boolean isGetVariantPrices()
FetchProductOptionsIfisGetVariantPrices in interface FetchProductOptionsIfpublic void setGetVariantPrices(boolean getVariantPrices)
FetchProductOptionsIfsetGetVariantPrices in interface FetchProductOptionsIfgetVariantPrices - the getVariantPrices to setCopyright © 2018 DS Data Systems UK Ltd.