Class StoreInventoryFilter

dw.catalog

Object

dw.catalog.StoreInventoryFilter

Important Note: This API class is not GA and is currently a pilot/beta service as defined by the customer's main services agreement and provided as-is. If you are not part of the pilot/beta program, the API class will throw an exception. Contact your customer success representative for more information.

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

 new dw.catalog.StoreInventoryFilter( "city",
     new dw.util.ArrayList( new dw.catalog.StoreInventoryFilterValue( "Burlington", "inventory_store_store9" ),
         new dw.catalog.StoreInventoryFilterValue( "Boston", "inventory_store_store8" ) ) );

semanticURLParameter : String (Read Only)

The semantic URL parameter of this StoreInventoryFilter.

storeInventoryFilterValues : List (Read Only)

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.

getSemanticURLParameter() : String

Returns the semantic URL parameter of this StoreInventoryFilter.

getStoreInventoryFilterValues() : List

Returns a list of StoreInventoryFilterValue instances used by this StoreInventoryFilter.

Methods inherited from class Object

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

StoreInventoryFilter

public 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.

UnsupportedOperationException - in case the class is used without enablement.

getSemanticURLParameter

getSemanticURLParameter() : String

Returns the semantic URL parameter of this StoreInventoryFilter.

Returns:

the semantic URL parameter of this StoreInventoryFilter.

getStoreInventoryFilterValues

getStoreInventoryFilterValues() : List

Returns a list of StoreInventoryFilterValue instances used by this StoreInventoryFilter.

Returns:

a list of StoreInventoryFilterValue instances used by this StoreInventoryFilter.