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.Object
public java.lang.String getCatalogId()
FetchProductOptionsIf
getCatalogId
in interface FetchProductOptionsIf
public void setCatalogId(java.lang.String catalogId)
FetchProductOptionsIf
setCatalogId
in interface FetchProductOptionsIf
catalogId
- the catalogId to setpublic java.util.Calendar getPriceDate()
FetchProductOptionsIf
getPriceDate
in interface FetchProductOptionsIf
public void setPriceDate(java.util.Calendar priceDate)
FetchProductOptionsIf
setPriceDate
in interface FetchProductOptionsIf
priceDate
- the priceDate to setpublic boolean isUseExternalPrice()
FetchProductOptionsIf
isUseExternalPrice
in interface FetchProductOptionsIf
public void setUseExternalPrice(boolean useExternalPrice)
FetchProductOptionsIf
setUseExternalPrice
in interface FetchProductOptionsIf
useExternalPrice
- the useExternalPrice to setpublic boolean isGetTierPrices()
FetchProductOptionsIf
isGetTierPrices
in interface FetchProductOptionsIf
public void setGetTierPrices(boolean getTierPrices)
FetchProductOptionsIf
setGetTierPrices
in interface FetchProductOptionsIf
getTierPrices
- the getTierPrices to setpublic boolean isUseExternalQuantity()
FetchProductOptionsIf
isUseExternalQuantity
in interface FetchProductOptionsIf
public void setUseExternalQuantity(boolean useExternalQuantity)
FetchProductOptionsIf
setUseExternalQuantity
in interface FetchProductOptionsIf
useExternalQuantity
- the useExternalQuantity to setpublic boolean isInvertRelatedProductDirection()
FetchProductOptionsIf
isInvertRelatedProductDirection
in interface FetchProductOptionsIf
public void setInvertRelatedProductDirection(boolean invertRelatedProductDirection)
FetchProductOptionsIf
setInvertRelatedProductDirection
in interface FetchProductOptionsIf
invertRelatedProductDirection
- the invertRelatedProductDirection to setpublic boolean isCalcQuantityForBundles()
FetchProductOptionsIf
isCalcQuantityForBundles
in interface FetchProductOptionsIf
public void setCalcQuantityForBundles(boolean calcQuantityForBundles)
FetchProductOptionsIf
setCalcQuantityForBundles
in interface FetchProductOptionsIf
calcQuantityForBundles
- the calcQuantityForBundles to setpublic boolean isGetTags()
FetchProductOptionsIf
isGetTags
in interface FetchProductOptionsIf
public void setGetTags(boolean getTags)
FetchProductOptionsIf
setGetTags
in interface FetchProductOptionsIf
getTags
- 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 FetchProductOptionsIf
public 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 FetchProductOptionsIf
createListOfUniqueProducts
- 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 FetchProductOptionsIf
public 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 FetchProductOptionsIf
getRelationshipData
- the getRelationshipData to setpublic java.lang.String getCustom1()
FetchProductOptionsIf
getCustom1
in interface FetchProductOptionsIf
public void setCustom1(java.lang.String custom1)
FetchProductOptionsIf
setCustom1
in interface FetchProductOptionsIf
custom1
- the custom1 to setpublic java.lang.String getCustom2()
FetchProductOptionsIf
getCustom2
in interface FetchProductOptionsIf
public void setCustom2(java.lang.String custom2)
FetchProductOptionsIf
setCustom2
in interface FetchProductOptionsIf
custom2
- the custom2 to setpublic java.lang.String getCustom3()
FetchProductOptionsIf
getCustom3
in interface FetchProductOptionsIf
public void setCustom3(java.lang.String custom3)
FetchProductOptionsIf
setCustom3
in interface FetchProductOptionsIf
custom3
- the custom3 to setpublic java.lang.String getCustom4()
FetchProductOptionsIf
getCustom4
in interface FetchProductOptionsIf
public void setCustom4(java.lang.String custom4)
setCustom4
in interface FetchProductOptionsIf
custom4
- the custom4 to setpublic java.lang.String getCustom5()
FetchProductOptionsIf
getCustom5
in interface FetchProductOptionsIf
public void setCustom5(java.lang.String custom5)
FetchProductOptionsIf
setCustom5
in interface FetchProductOptionsIf
custom5
- the custom5 to setpublic boolean isGetImages()
isGetImages
in interface FetchProductOptionsIf
public void setGetImages(boolean getImages)
setGetImages
in interface FetchProductOptionsIf
getImages
- the getImages to setpublic boolean isGetStockReservationInfo()
isGetStockReservationInfo
in interface FetchProductOptionsIf
public void setGetStockReservationInfo(boolean getStockReservationInfo)
setGetStockReservationInfo
in interface FetchProductOptionsIf
getStockReservationInfo
- the getStockReservationInfo to setpublic int[] getInventoryUpdateExcludeProdTypes()
getInventoryUpdateExcludeProdTypes
in interface FetchProductOptionsIf
public void setInventoryUpdateExcludeProdTypes(int[] inventoryUpdateExcludeProdTypes)
setInventoryUpdateExcludeProdTypes
in interface FetchProductOptionsIf
inventoryUpdateExcludeProdTypes
- 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 FetchProductOptionsIf
public 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 FetchProductOptionsIf
forceUseSolr
- the forceUseSolr to setpublic boolean isGetStoreName()
isGetStoreName
in interface FetchProductOptionsIf
public void setGetStoreName(boolean getStoreName)
setGetStoreName
in interface FetchProductOptionsIf
getStoreName
- the getStoreName to setpublic boolean isGetStoreDescription()
isGetStoreDescription
in interface FetchProductOptionsIf
public void setGetStoreDescription(boolean getStoreDescription)
setGetStoreDescription
in interface FetchProductOptionsIf
getStoreDescription
- the getStoreDescription to setpublic boolean isGetProductSuggestions()
isGetProductSuggestions
in interface FetchProductOptionsIf
public void setGetProductSuggestions(boolean getProductSuggestions)
setGetProductSuggestions
in interface FetchProductOptionsIf
getProductSuggestions
- the product suggestions settingpublic boolean isGetVariantPrices()
FetchProductOptionsIf
isGetVariantPrices
in interface FetchProductOptionsIf
public void setGetVariantPrices(boolean getVariantPrices)
FetchProductOptionsIf
setGetVariantPrices
in interface FetchProductOptionsIf
getVariantPrices
- the getVariantPrices to setCopyright © 2018 DS Data Systems UK Ltd.