FetchProductOptionsIf (KonaKart Server Engine API Documentation)

All Known Implementing Classes:

FetchProductOptions
```
public interface FetchProductOptionsIf
```
An object used to define options used when reading one or more products from the database

Method Summary

All Methods Instance Methods Abstract Methods
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

- Method Detail
  - getCatalogId
```
java.lang.String getCatalogId()
```
    The id of the catalog which contains dynamic product information such as the price and quantity
    
    Returns:
    
    the catalogId
  - setCatalogId
```
void setCatalogId(java.lang.String catalogId)
```
    The id of the catalog which contains dynamic product information such as the price and quantity
    
    Parameters:
    
    catalogId - the catalogId to set
  - getPriceDate
```
java.util.Calendar getPriceDate()
```
    The date for which a price is requested. It could be out in the future.
    
    Returns:
    
    the priceDate
  - setPriceDate
```
void setPriceDate(java.util.Calendar priceDate)
```
    The date for which a price is requested. It could be out in the future.
    
    Parameters:
    
    priceDate - the priceDate to set
  - isUseExternalPrice
```
boolean isUseExternalPrice()
```
    If true we attempt to fetch the prices from the external table
    
    Returns:
    
    the useExternalPrice
  - setUseExternalPrice
```
void setUseExternalPrice(boolean useExternalPrice)
```
    If true we attempt to fetch the prices from the external table
    
    Parameters:
    
    useExternalPrice - the useExternalPrice to set
  - isGetTierPrices
```
boolean isGetTierPrices()
```
    If true we attach an array of TierPrice objects to the product. Defaults to false for performance reasons since you may not require tier prices until you fetch the product details.
    
    Returns:
    
    the getTierPrices
  - setGetTierPrices
```
void setGetTierPrices(boolean getTierPrices)
```
    If true we attach an array of TierPrice objects to the product. Defaults to false for performance reasons since you may not require tier prices until you fetch the product details.
    
    Parameters:
    
    getTierPrices - the getTierPrices to set
  - isUseExternalQuantity
```
boolean isUseExternalQuantity()
```
    If true we attempt to fetch the quantities from the external table
    
    Returns:
    
    the useExternalQuantity
  - setUseExternalQuantity
```
void setUseExternalQuantity(boolean useExternalQuantity)
```
    If true we attempt to fetch the quantities from the external table
    
    Parameters:
    
    useExternalQuantity - the useExternalQuantity to set
  - isInvertRelatedProductDirection
```
boolean isInvertRelatedProductDirection()
```
    If true we invert the direction of the related product link. This is especially useful for bundled products, so rather than discovering the products within a bundle, you can determine which bundles a product belongs to by setting this attribute to true
    
    Returns:
    
    the invertRelatedProductDirection
  - setInvertRelatedProductDirection
```
void setInvertRelatedProductDirection(boolean invertRelatedProductDirection)
```
    If true we invert the direction of the related product link. This is especially useful for bundled products, so rather than discovering the products within a bundle, you can determine which bundles a product belongs to by setting this attribute to true
    
    Parameters:
    
    invertRelatedProductDirection - the invertRelatedProductDirection to set
  - isCalcQuantityForBundles
```
boolean isCalcQuantityForBundles()
```
    When set to true the quantity available for a product is calculated by reading the quantities of the products within the bundle.
    
    Returns:
    
    the calcQuantityForBundles
  - setCalcQuantityForBundles
```
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.
    
    Parameters:
    
    calcQuantityForBundles - the calcQuantityForBundles to set
  - isGetTags
```
boolean isGetTags()
```
    If true we attach an array of Tag objects to the product. Defaults to false for performance reasons since you may not require tags until you fetch the product details.
    
    Returns:
    
    the getTags
  - setGetTags
```
void setGetTags(boolean getTags)
```
    If true we attach an array of Tag objects to the product. Defaults to false for performance reasons since you may not require tags until you fetch the product details.
    
    Parameters:
    
    getTags - the getTags to set
  - isCreateListOfUniqueProducts
```
boolean isCreateListOfUniqueProducts()
```
    This attribute is only used 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, 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.
    
    Returns:
    
    the createListOfUniqueProducts
  - setCreateListOfUniqueProducts
```
void setCreateListOfUniqueProducts(boolean createListOfUniqueProducts)
```
    This attribute is only used 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, 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.
    
    Parameters:
    
    createListOfUniqueProducts - the createListOfUniqueProducts to set
  - isGetRelationshipData
```
boolean isGetRelationshipData()
```
    Only used by the API call getRelatedProductsWithOptions. If set to true, the return Products object contains an array of ProductRelationship objects which contain data specific to each relationship.
    
    Returns:
    
    the getRelationshipData
  - setGetRelationshipData
```
void setGetRelationshipData(boolean getRelationshipData)
```
    Only used by the API call getRelatedProductsWithOptions. If set to true, the return Products object contains an array of ProductRelationship objects which contain data specific to each relationship.
    
    Parameters:
    
    getRelationshipData - the getRelationshipData to set
  - getCustom1
```
java.lang.String getCustom1()
```
    Can be used for passing data to customize the query.
    
    Returns:
    
    the custom1
  - setCustom1
```
void setCustom1(java.lang.String custom1)
```
    Can be used for passing data to customize the query.
    
    Parameters:
    
    custom1 - the custom1 to set
  - getCustom2
```
java.lang.String getCustom2()
```
    Can be used for passing data to customize the query.
    
    Returns:
    
    the custom2
  - setCustom2
```
void setCustom2(java.lang.String custom2)
```
    Can be used for passing data to customize the query.
    
    Parameters:
    
    custom2 - the custom2 to set
  - getCustom3
```
java.lang.String getCustom3()
```
    Can be used for passing data to customize the query.
    
    Returns:
    
    the custom3
  - setCustom3
```
void setCustom3(java.lang.String custom3)
```
    Can be used for passing data to customize the query.
    
    Parameters:
    
    custom3 - the custom3 to set
  - getCustom4
```
java.lang.String getCustom4()
```
    Can be used for passing data to customize the query.
    
    Returns:
    
    the custom4
  - setCustom4
```
void setCustom4(java.lang.String custom4)
```
    Parameters:
    
    custom4 - the custom4 to set
  - getCustom5
```
java.lang.String getCustom5()
```
    Can be used for passing data to customize the query.
    
    Returns:
    
    the custom5
  - setCustom5
```
void setCustom5(java.lang.String custom5)
```
    Can be used for passing data to customize the query.
    
    Parameters:
    
    custom5 - the custom5 to set
  - isGetImages
```
boolean isGetImages()
```
    If true we attach a ProductImages object to the product, which contains a list of image names available for it.
    
    Returns:
    
    the getImages
  - setGetImages
```
void setGetImages(boolean getImages)
```
    If true we attach a ProductImages object to the product, which contains a list of image names available for it.
    
    Parameters:
    
    getImages - the getImages to set
  - isGetStockReservationInfo
```
boolean isGetStockReservationInfo()
```
    If true, information about reserved stock is returned as well as normal stock when fetching products from the database.
    
    Returns:
    
    the getStockReservationInfo
  - setGetStockReservationInfo
```
void setGetStockReservationInfo(boolean getStockReservationInfo)
```
    If true, information about reserved stock is returned as well as normal stock when fetching products from the database.
    
    Parameters:
    
    getStockReservationInfo - the getStockReservationInfo to set
  - getInventoryUpdateExcludeProdTypes
```
int[] getInventoryUpdateExcludeProdTypes()
```
    Used to define product types that are excluded from inventory updates. Used in the updateProductQuantityWithOptions() API call of the ProductMgr. Valid product types are:
    - com.konakart.bl.ProductMgr.PHYSICAL_PRODUCT
    - com.konakart.bl.ProductMgr.DIGITAL_DOWNLOAD
    - com.konakart.bl.ProductMgr.FREE_SHIPPING
    - com.konakart.bl.ProductMgr.BUNDLE_PRODUCT_TYPE
    - com.konakart.bl.ProductMgr.FREE_SHIPPING_BUNDLE_PRODUCT_TYPE
    - com.konakart.bl.ProductMgr.GIFT_CERTIFICATE_PRODUCT_TYPE
    - com.konakart.bl.ProductMgr.BOOKABLE_PRODUCT_TYPE
    - com.konakart.bl.ProductMgr.VIRTUAL_PRODUCT_TYPE
    Returns:
    
    the inventoryUpdateExcludeProdTypes
  - setInventoryUpdateExcludeProdTypes
```
void setInventoryUpdateExcludeProdTypes(int[] inventoryUpdateExcludeProdTypes)
```
    Used to define product types that are excluded from inventory updates. Used in the updateProductQuantityWithOptions() API call of the ProductMgr. Valid product types are:
    - com.konakart.bl.ProductMgr.PHYSICAL_PRODUCT
    - com.konakart.bl.ProductMgr.DIGITAL_DOWNLOAD
    - com.konakart.bl.ProductMgr.FREE_SHIPPING
    - com.konakart.bl.ProductMgr.BUNDLE_PRODUCT_TYPE
    - com.konakart.bl.ProductMgr.FREE_SHIPPING_BUNDLE_PRODUCT_TYPE
    - com.konakart.bl.ProductMgr.GIFT_CERTIFICATE_PRODUCT_TYPE
    - com.konakart.bl.ProductMgr.BOOKABLE_PRODUCT_TYPE
    - com.konakart.bl.ProductMgr.VIRTUAL_PRODUCT_TYPE
    Parameters:
    
    inventoryUpdateExcludeProdTypes - the inventoryUpdateExcludeProdTypes to set
  - isForceUseSolr
```
boolean isForceUseSolr()
```
    This attribute also exists in the ProductSearch object. It's repeated here for the API calls
    - getProductsPerCategoryWithOptions()
    - getProductsPerManufacturerWithOptions()
    - getProductsPerCategoryPerManufacturerWithOptions()
    which don't receive the ProductSearch object as a parameter.
    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.
    Returns:
    
    the forceUseSolr
  - setForceUseSolr
```
void setForceUseSolr(boolean forceUseSolr)
```
    This attribute also exists in the ProductSearch object. It's repeated here for the API calls
    - getProductsPerCategoryWithOptions()
    - getProductsPerManufacturerWithOptions()
    - getProductsPerCategoryPerManufacturerWithOptions()
    which don't receive the ProductSearch object as a parameter.
    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.
    Parameters:
    
    forceUseSolr - the forceUseSolr to set
  - isGetStoreName
```
boolean isGetStoreName()
```
    If true, when in multi-vendor mode the store name attribute of the product is populated. It defaults to true.
    
    Returns:
    
    the getStoreName
  - setGetStoreName
```
void setGetStoreName(boolean getStoreName)
```
    If true, when in multi-vendor mode the store name attribute of the product is populated. It defaults to true.
    
    Parameters:
    
    getStoreName - the getStoreName to set
  - isGetStoreDescription
```
boolean isGetStoreDescription()
```
    If true, when in multi-vendor mode the store description attribute of the product is populated. It defaults to false.
    
    Returns:
    
    the getStoreDescription
  - setGetStoreDescription
```
void setGetStoreDescription(boolean getStoreDescription)
```
    If true, when in multi-vendor mode the store description attribute of the product is populated. It defaults to false.
    
    Parameters:
    
    getStoreDescription - the getStoreDescription to set
  - isGetProductSuggestions
```
boolean isGetProductSuggestions()
```
    If set to true the Product Suggestions from the AI service are added to the product
    
    Returns:
    
    true if the Product Suggestions should be added
  - setGetProductSuggestions
```
void setGetProductSuggestions(boolean getProductSuggestions)
```
    If set to true the Product Suggestions from the AI service are added to the product
    
    Parameters:
    
    getProductSuggestions - Set to true to get Product Suggestions
  - isGetVariantPrices
```
boolean isGetVariantPrices()
```
    If true we attach an array of VariantPrice objects to the product. Defaults to false for performance reasons since you may not require tier prices until you fetch the product details.
    
    Returns:
    
    the getVariantPrices
  - setGetVariantPrices
```
void setGetVariantPrices(boolean getVariantPrices)
```
    If true we attach an array of VariantPrice objects to the product. Defaults to false for performance reasons since you may not require tier prices until you fetch the product details.
    
    Parameters:
    
    getVariantPrices - the getVariantPrices to set

Interface FetchProductOptionsIf

Method Summary

Method Detail

getCatalogId

setCatalogId

getPriceDate

setPriceDate

isUseExternalPrice

setUseExternalPrice

isGetTierPrices

setGetTierPrices

isUseExternalQuantity

setUseExternalQuantity

isInvertRelatedProductDirection

setInvertRelatedProductDirection

isCalcQuantityForBundles

setCalcQuantityForBundles

isGetTags

setGetTags

isCreateListOfUniqueProducts

setCreateListOfUniqueProducts

isGetRelationshipData

setGetRelationshipData

getCustom1

setCustom1

getCustom2

setCustom2

getCustom3

setCustom3

getCustom4

setCustom4

getCustom5

setCustom5

isGetImages

setGetImages

isGetStockReservationInfo

setGetStockReservationInfo

getInventoryUpdateExcludeProdTypes

setInventoryUpdateExcludeProdTypes

isForceUseSolr

setForceUseSolr

isGetStoreName

setGetStoreName

isGetStoreDescription

setGetStoreDescription

isGetProductSuggestions

setGetProductSuggestions

isGetVariantPrices

setGetVariantPrices