Class StoreInventoryFilterValue

dw.catalog

Object

dw.catalog.StoreInventoryFilterValue

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 value, which can be used for a StoreInventoryFilter to filter the search result by one or more store inventory list IDs via ProductSearchModel.setStoreInventoryFilter(StoreInventoryFilter). Compared to ProductSearchModel.setInventoryListIDs(List) the store inventory filter allows a customization of the inventory parameter name and the inventory list ID values for URL generations. A StoreInventoryFilterValue provides the mapping between a semantic value e.g. store1,store2 or Burlington,Boston to the related real inventory list ID.

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")
 ));

inventoryListID : String (Read Only)

The real inventory list ID of this store inventory filter value.

semanticInventoryID : String (Read Only)

The semantic inventory ID of this store inventory filter value.

StoreInventoryFilterValue(semanticInventoryListID : String, inventoryListID : String)

Important Note: This API is not GA and is currently a pilot/beta service as defined by the customer's main services agreement and provided as-is.

getInventoryListID() : String

Returns the real inventory list ID of this store inventory filter value.

getSemanticInventoryID() : String

Returns the semantic inventory ID of this store inventory filter value.

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

StoreInventoryFilterValue

public StoreInventoryFilterValue(semanticInventoryListID : String, inventoryListID : String)

Important Note: This API 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 will throw an exception. Contact your customer success representative for more information.

Creates a new StoreInventoryFilterValue instance for the semantic inventory ID and real inventory list ID.

Parameters:

semanticInventoryListID - The semantic inventory list ID of this store inventory filter value.

inventoryListID - The real inventory list ID to filter the search result on.

Throws:

NullArgumentException - in case of missing required parameter.

UnsupportedOperationException - if case the class is used without enablement.

getInventoryListID

getInventoryListID() : String

Returns the real inventory list ID of this store inventory filter value.

Returns:

the real inventory list ID of this store inventory filter value.

getSemanticInventoryID

getSemanticInventoryID() : String

Returns the semantic inventory ID of this store inventory filter value.

Returns:

the semantic inventory ID of this store inventory filter value.