Class StoreInventoryFilter
This class represents a store inventory filter, which can be used at ProductSearchModel.setStoreInventoryFilter(StoreInventoryFilter) to filter the search result by one or more store inventories. Compared to the default parameter 'ilids' (Inventory List IDs) see (ProductSearchModel.INVENTORY_LIST_IDS_PARAMETER the store inventory filter allows a customization of the parameter name and the inventory list ID parameter values for the URL generations via all URLRefine and URLRelax methods e.g. for ProductSearchModel.urlRefineCategory(String, String), ProductSearchModel.urlRelaxPrice(URL), SearchModel.urlRefineAttribute(String, String, String).
Example custom URL: city=Burlington|Boston
| Property | Description |
|---|---|
semanticURLParameter: String (read-only) | Returns the semantic URL parameter of this StoreInventoryFilter. |
storeInventoryFilterValues: List (read-only) | Returns a list of StoreInventoryFilterValue instances used by this StoreInventoryFilter. |
| Constructor | Description |
|---|---|
| StoreInventoryFilter(String, List) | Creates a new StoreInventoryFilter instance for the given semantic URL parameter and a list of StoreInventoryFilterValue instances. |
| Method | Description |
|---|---|
| getSemanticURLParameter() | Returns the semantic URL parameter of this StoreInventoryFilter. |
| getStoreInventoryFilterValues() | Returns a list of StoreInventoryFilterValue instances used by this StoreInventoryFilter. |
assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values
- semanticURLParameter: String
(read-only) Returns the semantic URL parameter of this StoreInventoryFilter.
- storeInventoryFilterValues: List
(read-only) Returns a list of StoreInventoryFilterValue instances used by this StoreInventoryFilter.
- StoreInventoryFilter(semanticURLParameter: String, storeFilterValues: List)
Creates a new StoreInventoryFilter instance for the given semantic URL parameter and a list of StoreInventoryFilterValue instances. The semantic URL parameter e.g. city, zip, store and the semantic store inventory values from the storeFilterValues will be used for URL generation. The mapped inventory list IDs from the storeFilterValues will be used for filtering. on the mapped
Parameters:
- semanticURLParameter - The semantic URL parameter which should be used for URL generation instead of 'ilids' (Inventory List IDs)
- storeFilterValues - A list of StoreInventoryFilterValue instances containing the store inventory values and the related real inventory list ID.
Throws:
- NullArgumentException - in case of missing required parameter.
- getSemanticURLParameter(): String
Returns the semantic URL parameter of this StoreInventoryFilter.
Returns:
- the semantic URL parameter of this StoreInventoryFilter.
- getStoreInventoryFilterValues(): List
Returns a list of StoreInventoryFilterValue instances used by this StoreInventoryFilter.
Returns:
- a list of StoreInventoryFilterValue instances used by this StoreInventoryFilter.