com.ibm.commerce.rest.bod.helpers

Class SearchHelper

java.lang.Object

com.ibm.commerce.rest.bod.helpers.SearchHelper

public class SearchHelper
extends java.lang.Object

The Class SearchHelper.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACCESS_PROFILE_BY_PARENT_CATEGORY The Access Profile applicable to fetching products by parent category.
static java.lang.String	ACCESS_PROFILE_DETAILS The Access Profile for category details.
static java.lang.String	ACCESS_PROFILE_SEARCH The Access Profile applicable to a list of products.
static java.lang.String	ACCESS_PROFILE_SUMMARY The Access Profile for category summary.
static java.lang.String	ADVANCED_FACET_LIST_KEY The Advanced Facet List key.
static java.lang.String	CATALOG_ENTRY_VIEW_KEY The Constant CATALOG_ENTRY_VIEW_KEY.
static java.lang.String	CATALOG_GROUP_VIEW_KEY The Constant CATALOG_GROUP_VIEW_KEY.
static java.lang.String	CATEGORY_ The Constant CATEGORY_.
static java.lang.String	COPYRIGHT IBM Copyright notice field.
static java.lang.String	DEFAULT_ACCESS_PROFILE The default access profile, used when an access profile is not specified using the accessProfile query parameter.
static java.lang.String	FACET_KEY The Facet key.
static java.lang.String	FILTER_TERM_KEY The Filter Term key.
static java.lang.String	FILTER_TYPE_KEY The Filter Type key.
static java.lang.String	FILTET_FACET_KEY The Filter Facet key.
static java.lang.String	FORMATTING_GROUP_CATALOG_NAVIGATION_VIEW The constant FORMATTING_GROUP_CATALOG_NAVIGATION_VIEW.
static java.lang.String	GENERIC_SEARCH_EXPRESSION_BY_PARENT_CATEGORY The generic XPath key to search products based on parent category.
static java.lang.String	IDENTIFIER The Constant IDENTIFIER.
static java.lang.String	INTENT_SEARCH_TERM_KEY The Intent Search Term key.
static java.lang.String	MANUFACTURER_KEY The Manufacturer key.
static java.lang.String	MAX_PRICE_KEY The Maximum Price key.
static java.lang.String	METADATA_KEY The Metadata key.
static java.lang.String	MIN_PRICE_KEY The Minimum Price key.
static java.lang.String	ORDER_BY_KEY The Order By key.
static java.lang.String	ORIGINAL_SEARCH_TERM_KEY The Original Search Term key.
static java.lang.String	PART_NUMBER The Constant PART_NUMBER.
static java.lang.String	PRODUCT_ The Constant PRODUCT_.
static java.lang.String	PRODUCT_VIEW_BY_CATEGORY The Constant PRODUCT_VIEW_BY_CATEGORY.
static java.lang.String	PRODUCTS_URL The Constant PRODUCTS_URL.
static java.lang.String	SEARCH_CATEGORY_ID_KEY The Search Category key.
static java.lang.String	SEARCH_DEPTH_KEY The Search Profile key.
static java.lang.String	SEARCH_EXPRESSION The XPath key to search products based on search term.
static java.lang.String	SEARCH_EXPRESSION_BY_ID The XPath key to search products based on Product ID.
static java.lang.String	SEARCH_EXPRESSION_BY_PARENT_CATEGORY The XPath key to search products based on parent category.
static java.lang.String	SEARCH_EXPRESSION_BY_PART_NUMBER The XPath key to search products based on Part Number.
static java.lang.String	SEARCH_EXPRESSION_FOR_CATEGORY_BY_IDENTIFIER The XPath key to fetch category based on identifier.
static java.lang.String	SEARCH_EXPRESSION_FOR_CATEGORY_BY_UNIQUE_ID The XPath key to fetch category based on unique identifier.
static java.lang.String	SEARCH_EXPRESSION_FOR_SUB_CATEGORIES The XPath key to fetch sub-categories for a given parent category.
static java.lang.String	SEARCH_EXPRESSION_FOR_TOP_CATEGORIES The XPath key to fetch the top categories of a catalog.
static java.lang.String	SEARCH_PROFILE_BY_NAME_AND_SHORTDESCRIPTION The Search Profile value for searching products based on search term (IBM_findCatalogEntryByNameAndShortDescription).
static java.lang.String	SEARCH_PROFILE_CATEGORY_DETAILS The Search Profile value for getting category details.
static java.lang.String	SEARCH_PROFILE_CATEGORY_SUMMARY The Search Profile value for getting category summary.
static java.lang.String	SEARCH_PROFILE_COMP_PRODUCT_LIST_BY_CATEGORY_ID The Search Profile value for composing product list by category ID without search term (IBM_ComposeProductListByCategoryId).
static java.lang.String	SEARCH_PROFILE_KEY The Search Profile key.
static java.lang.String	SEARCH_PROFILE_PRODUCT_DETAILS The Search Profile value for getting product details based on Product ID / Part Number.
static java.lang.String	SEARCH_PROFILE_WITHOUT_DESC_BY_NAME_AND_SHORTDESC The Search Profile value for searching products based on search term but with no description (IBM_findCatalogEntryWithoutDescriptionByNameAndShortDescription).
static java.lang.String	SEARCH_SOURCE_KEY Deprecated. Use (@value #SEARCH_DEPTH_KEY) instead.
static java.lang.String	SEARCH_TERM_KEY The Search Term key.
static java.lang.String	SEARCH_TYPE_KEY The Search Type key.
static java.lang.String	UNIQUE_ID The Constant UNIQUE_ID.

Constructor Summary

Constructors

Constructor and Description
SearchHelper() Instantiates a new search helper.
SearchHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor) Instantiates a new search helper.

Method Summary

Modifier and Type	Method and Description
com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType	getCategoryByIdentifier(java.lang.String groupId, BusinessContextType bContext, java.lang.String xPath, java.lang.String accessProfile, java.lang.String searchProfile, javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler) Fetches the category details based on identifier.
com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType	getCategoryByUniqueId(java.lang.String categoryId, BusinessContextType bContext, java.lang.String xPath, java.lang.String accessProfile, java.lang.String searchProfile, javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler) Fetches the category details based on category unique ID.
java.lang.String	getCategoryUniqueIdentifier(com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType category) Returns unique identifier for the category.
com.ibm.commerce.rest.utils.Instrumentor	getInstrumentor() Get the instrumentor associated with this request instance.
com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType	getProductById(java.lang.String productId, BusinessContextType bContext, java.lang.String xPath, java.lang.String accessProfile, java.lang.String searchProfile, javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler) Deprecated. Replaced by getProductByIds(String[], BusinessContextType, String, String, String, CallbackHandler)
com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType	getProductByIds(java.lang.String[] productIds, BusinessContextType bContext, java.lang.String xPath, java.lang.String accessProfile, java.lang.String searchProfile, javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler) Fetches the product details based on Product ID.
com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType	getProductByPartNumber(java.lang.String partNumber, BusinessContextType bContext, java.lang.String xPath, java.lang.String accessProfile, java.lang.String searchProfile, javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler) Fetches the product details based on Part Number.
com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType	getProductByXPath(BusinessContextType bContext, java.lang.String xPath, java.lang.String accessProfile, java.lang.String searchProfile, javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler) Fetches the product details based on the XPath.
com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType	getProductsByCategory(java.lang.String categoryId, int pageNumber, int pageSize, java.lang.String orderBy, BusinessContextType bContext, java.lang.String xPath, java.lang.String accessProfile, java.lang.String searchProfile, javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler) Deprecated. A new parameter - searchType is added for find products by parent category
com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType	getProductsByCategory(java.lang.String categoryId, java.lang.String searchType, int pageNumber, int pageSize, java.lang.String orderBy, BusinessContextType bContext, java.lang.String xPath, java.lang.String accessProfile, java.lang.String searchProfile, javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler) Fetches the products that are under a specified category.
com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType	getProductsBySearchTerm(java.lang.String searchTerm, int pageNumber, int pageSize, java.lang.String intentSearchTerm, java.lang.String originalSearchTerm, java.lang.String searchCategoryId, java.lang.String searchType, java.lang.String filterTerm, java.lang.String filterType, java.lang.String manufacturer, java.lang.String minPrice, java.lang.String maxPrice, java.util.List<java.lang.String> facetList, java.lang.String advancedFacetList, java.lang.String filterFacet, java.lang.String orderBy, java.lang.String metaData, java.lang.String searchSource, BusinessContextType bContext, java.lang.String xPath, java.lang.String accessProfile, java.lang.String searchProfile, javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler) Fetches the products that match the search term.
com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType	getProductsBySearchTerm(java.lang.String searchTerm, int pageNumber, int pageSize, java.lang.String intentSearchTerm, java.lang.String originalSearchTerm, java.lang.String searchCategoryId, java.lang.String searchType, java.lang.String filterTerm, java.lang.String filterType, java.lang.String manufacturer, java.lang.String minPrice, java.lang.String maxPrice, java.lang.String facet, java.lang.String advancedFacetList, java.lang.String filterFacet, java.lang.String orderBy, java.lang.String metaData, java.lang.String searchSource, BusinessContextType bContext, java.lang.String xPath, java.lang.String accessProfile, java.lang.String searchProfile, javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler) Deprecated. The facet parameter has been changed from String to List in order to pass multiple facet values.
java.lang.String	getProductUniqueIdentifier(com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType product) Returns unique identifier for the category.
com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType	getSubCategories(java.lang.String parentCategoryId, int pageNumber, int pageSize, BusinessContextType bContext, java.lang.String xPath, java.lang.String accessProfile, java.lang.String searchProfile, javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler) Fetches the sub-categories based on the parent category identifier.
com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType	getTopCategories(BusinessContextType bContext, java.lang.String xPath, java.lang.String accessProfile, java.lang.String searchProfile, javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler) Fetches the top categories of the catalog.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM Copyright notice field.

See Also:

Constant Field Values

CATALOG_ENTRY_VIEW_KEY

public static final java.lang.String CATALOG_ENTRY_VIEW_KEY

The Constant CATALOG_ENTRY_VIEW_KEY.

See Also:

Constant Field Values

CATALOG_GROUP_VIEW_KEY

public static final java.lang.String CATALOG_GROUP_VIEW_KEY

The Constant CATALOG_GROUP_VIEW_KEY.

See Also:

Constant Field Values

PART_NUMBER

public static final java.lang.String PART_NUMBER

The Constant PART_NUMBER.

See Also:

Constant Field Values

PRODUCT_

public static final java.lang.String PRODUCT_

The Constant PRODUCT_.

See Also:

Constant Field Values

IDENTIFIER

public static final java.lang.String IDENTIFIER

The Constant IDENTIFIER.

See Also:

Constant Field Values

CATEGORY_

public static final java.lang.String CATEGORY_

The Constant CATEGORY_.

See Also:

Constant Field Values

PRODUCT_VIEW_BY_CATEGORY

public static final java.lang.String PRODUCT_VIEW_BY_CATEGORY

The Constant PRODUCT_VIEW_BY_CATEGORY.

See Also:

Constant Field Values

UNIQUE_ID

public static final java.lang.String UNIQUE_ID

The Constant UNIQUE_ID.

See Also:

Constant Field Values

PRODUCTS_URL

public static final java.lang.String PRODUCTS_URL

The Constant PRODUCTS_URL.

See Also:

Constant Field Values

FORMATTING_GROUP_CATALOG_NAVIGATION_VIEW

public static final java.lang.String FORMATTING_GROUP_CATALOG_NAVIGATION_VIEW

The constant FORMATTING_GROUP_CATALOG_NAVIGATION_VIEW.

See Also:

Constant Field Values

SEARCH_EXPRESSION

public static final java.lang.String SEARCH_EXPRESSION

The XPath key to search products based on search term.

See Also:

Constant Field Values

SEARCH_EXPRESSION_BY_ID

public static final java.lang.String SEARCH_EXPRESSION_BY_ID

The XPath key to search products based on Product ID.

See Also:

Constant Field Values

SEARCH_EXPRESSION_BY_PART_NUMBER

public static final java.lang.String SEARCH_EXPRESSION_BY_PART_NUMBER

The XPath key to search products based on Part Number.

See Also:

Constant Field Values

GENERIC_SEARCH_EXPRESSION_BY_PARENT_CATEGORY

public static final java.lang.String GENERIC_SEARCH_EXPRESSION_BY_PARENT_CATEGORY

The generic XPath key to search products based on parent category.

See Also:

Constant Field Values

SEARCH_EXPRESSION_BY_PARENT_CATEGORY

public static final java.lang.String SEARCH_EXPRESSION_BY_PARENT_CATEGORY

The XPath key to search products based on parent category.

See Also:

Constant Field Values

SEARCH_EXPRESSION_FOR_CATEGORY_BY_UNIQUE_ID

public static final java.lang.String SEARCH_EXPRESSION_FOR_CATEGORY_BY_UNIQUE_ID

The XPath key to fetch category based on unique identifier.

See Also:

Constant Field Values

SEARCH_EXPRESSION_FOR_CATEGORY_BY_IDENTIFIER

public static final java.lang.String SEARCH_EXPRESSION_FOR_CATEGORY_BY_IDENTIFIER

The XPath key to fetch category based on identifier.

See Also:

Constant Field Values

SEARCH_EXPRESSION_FOR_TOP_CATEGORIES

public static final java.lang.String SEARCH_EXPRESSION_FOR_TOP_CATEGORIES

The XPath key to fetch the top categories of a catalog.

See Also:

Constant Field Values

SEARCH_EXPRESSION_FOR_SUB_CATEGORIES

public static final java.lang.String SEARCH_EXPRESSION_FOR_SUB_CATEGORIES

The XPath key to fetch sub-categories for a given parent category.

See Also:

Constant Field Values

DEFAULT_ACCESS_PROFILE

public static final java.lang.String DEFAULT_ACCESS_PROFILE

The default access profile, used when an access profile is not specified using the accessProfile query parameter.

See Also:

Constant Field Values

ACCESS_PROFILE_SEARCH

public static final java.lang.String ACCESS_PROFILE_SEARCH

The Access Profile applicable to a list of products.

See Also:

Constant Field Values

ACCESS_PROFILE_BY_PARENT_CATEGORY

public static final java.lang.String ACCESS_PROFILE_BY_PARENT_CATEGORY

The Access Profile applicable to fetching products by parent category.

See Also:

Constant Field Values

ACCESS_PROFILE_SUMMARY

public static final java.lang.String ACCESS_PROFILE_SUMMARY

The Access Profile for category summary.

See Also:

Constant Field Values

ACCESS_PROFILE_DETAILS

public static final java.lang.String ACCESS_PROFILE_DETAILS

The Access Profile for category details.

See Also:

Constant Field Values

SEARCH_PROFILE_KEY

public static final java.lang.String SEARCH_PROFILE_KEY

The Search Profile key.

See Also:

Constant Field Values

SEARCH_DEPTH_KEY

public static final java.lang.String SEARCH_DEPTH_KEY

The Search Profile key.

See Also:

Constant Field Values

SEARCH_PROFILE_BY_NAME_AND_SHORTDESCRIPTION

public static final java.lang.String SEARCH_PROFILE_BY_NAME_AND_SHORTDESCRIPTION

The Search Profile value for searching products based on search term (IBM_findCatalogEntryByNameAndShortDescription).

See Also:

Constant Field Values

SEARCH_PROFILE_WITHOUT_DESC_BY_NAME_AND_SHORTDESC

public static final java.lang.String SEARCH_PROFILE_WITHOUT_DESC_BY_NAME_AND_SHORTDESC

The Search Profile value for searching products based on search term but with no description (IBM_findCatalogEntryWithoutDescriptionByNameAndShortDescription).

See Also:

Constant Field Values

SEARCH_PROFILE_COMP_PRODUCT_LIST_BY_CATEGORY_ID

public static final java.lang.String SEARCH_PROFILE_COMP_PRODUCT_LIST_BY_CATEGORY_ID

The Search Profile value for composing product list by category ID without search term (IBM_ComposeProductListByCategoryId).

See Also:

Constant Field Values

SEARCH_PROFILE_PRODUCT_DETAILS

public static final java.lang.String SEARCH_PROFILE_PRODUCT_DETAILS

The Search Profile value for getting product details based on Product ID / Part Number.

See Also:

Constant Field Values

SEARCH_PROFILE_CATEGORY_SUMMARY

public static final java.lang.String SEARCH_PROFILE_CATEGORY_SUMMARY

The Search Profile value for getting category summary.

See Also:

Constant Field Values

SEARCH_PROFILE_CATEGORY_DETAILS

public static final java.lang.String SEARCH_PROFILE_CATEGORY_DETAILS

The Search Profile value for getting category details.

See Also:

Constant Field Values

SEARCH_TERM_KEY

public static final java.lang.String SEARCH_TERM_KEY

The Search Term key.

See Also:

Constant Field Values

INTENT_SEARCH_TERM_KEY

public static final java.lang.String INTENT_SEARCH_TERM_KEY

The Intent Search Term key.

See Also:

Constant Field Values

ORIGINAL_SEARCH_TERM_KEY

public static final java.lang.String ORIGINAL_SEARCH_TERM_KEY

The Original Search Term key.

See Also:

Constant Field Values

SEARCH_CATEGORY_ID_KEY

public static final java.lang.String SEARCH_CATEGORY_ID_KEY

The Search Category key.

See Also:

Constant Field Values

SEARCH_TYPE_KEY

public static final java.lang.String SEARCH_TYPE_KEY

The Search Type key.

See Also:

Constant Field Values

FILTER_TERM_KEY

public static final java.lang.String FILTER_TERM_KEY

The Filter Term key.

See Also:

Constant Field Values

FILTER_TYPE_KEY

public static final java.lang.String FILTER_TYPE_KEY

The Filter Type key.

See Also:

Constant Field Values

MANUFACTURER_KEY

public static final java.lang.String MANUFACTURER_KEY

The Manufacturer key.

See Also:

Constant Field Values

MIN_PRICE_KEY

public static final java.lang.String MIN_PRICE_KEY

The Minimum Price key.

See Also:

Constant Field Values

MAX_PRICE_KEY

public static final java.lang.String MAX_PRICE_KEY

The Maximum Price key.

See Also:

Constant Field Values

FACET_KEY

public static final java.lang.String FACET_KEY

The Facet key.

See Also:

Constant Field Values

ADVANCED_FACET_LIST_KEY

public static final java.lang.String ADVANCED_FACET_LIST_KEY

The Advanced Facet List key.

See Also:

Constant Field Values

FILTET_FACET_KEY

public static final java.lang.String FILTET_FACET_KEY

The Filter Facet key.

See Also:

Constant Field Values

ORDER_BY_KEY

public static final java.lang.String ORDER_BY_KEY

The Order By key.

See Also:

Constant Field Values

METADATA_KEY

public static final java.lang.String METADATA_KEY

The Metadata key.

See Also:

Constant Field Values

SEARCH_SOURCE_KEY

public static final java.lang.String SEARCH_SOURCE_KEY

Deprecated. Use (@value #SEARCH_DEPTH_KEY) instead.

The Search Source key.

See Also:

Constant Field Values

Constructor Detail

SearchHelper

public SearchHelper()

Instantiates a new search helper.

SearchHelper

public SearchHelper(com.ibm.commerce.rest.utils.Instrumentor instrumentor)

Instantiates a new search helper.

Parameters:

instrumentor - the instrumentor

Method Detail

getInstrumentor

public com.ibm.commerce.rest.utils.Instrumentor getInstrumentor()

Get the instrumentor associated with this request instance.

Returns:

the instrumentor

getProductsBySearchTerm

public com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType getProductsBySearchTerm(java.lang.String searchTerm,
                                                                                                               int pageNumber,
                                                                                                               int pageSize,
                                                                                                               java.lang.String intentSearchTerm,
                                                                                                               java.lang.String originalSearchTerm,
                                                                                                               java.lang.String searchCategoryId,
                                                                                                               java.lang.String searchType,
                                                                                                               java.lang.String filterTerm,
                                                                                                               java.lang.String filterType,
                                                                                                               java.lang.String manufacturer,
                                                                                                               java.lang.String minPrice,
                                                                                                               java.lang.String maxPrice,
                                                                                                               java.lang.String facet,
                                                                                                               java.lang.String advancedFacetList,
                                                                                                               java.lang.String filterFacet,
                                                                                                               java.lang.String orderBy,
                                                                                                               java.lang.String metaData,
                                                                                                               java.lang.String searchSource,
                                                                                                               BusinessContextType bContext,
                                                                                                               java.lang.String xPath,
                                                                                                               java.lang.String accessProfile,
                                                                                                               java.lang.String searchProfile,
                                                                                                               javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler)
                                                                                                        throws com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException,
                                                                                                               java.io.UnsupportedEncodingException

Deprecated. The facet parameter has been changed from String to List in order to pass multiple facet values.

Fetches the products that match the search term.

Parameters:

searchTerm - the search term

pageNumber - the page number of search display

pageSize - the number of results in a single page of search display

intentSearchTerm - the search intent term.

originalSearchTerm - the original search term.

searchCategoryId - the category identifier.

searchType - the type of search.

filterTerm - the filter term.

filterType - the type of filter.

manufacturer - the manufacturer.

minPrice - the minimum price limit for search.

maxPrice - the maximum price limit for search.

facet - the facet of search.

advancedFacetList - the advanced facet list.

filterFacet - the facet filter.

orderBy - the sorting order.

metaData - the search metaData.

searchSource - the search source.

bContext - the business context

xPath - the xPath

accessProfile - the access profile

searchProfile - the search profile

activityTokenCallbackHandler - the CallbackHandler

Returns:

the search result

Throws:

com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException - the catalog navigation view exception

java.io.UnsupportedEncodingException - the unsupported encoding exception

getProductsBySearchTerm

public com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType getProductsBySearchTerm(java.lang.String searchTerm,
                                                                                                               int pageNumber,
                                                                                                               int pageSize,
                                                                                                               java.lang.String intentSearchTerm,
                                                                                                               java.lang.String originalSearchTerm,
                                                                                                               java.lang.String searchCategoryId,
                                                                                                               java.lang.String searchType,
                                                                                                               java.lang.String filterTerm,
                                                                                                               java.lang.String filterType,
                                                                                                               java.lang.String manufacturer,
                                                                                                               java.lang.String minPrice,
                                                                                                               java.lang.String maxPrice,
                                                                                                               java.util.List<java.lang.String> facetList,
                                                                                                               java.lang.String advancedFacetList,
                                                                                                               java.lang.String filterFacet,
                                                                                                               java.lang.String orderBy,
                                                                                                               java.lang.String metaData,
                                                                                                               java.lang.String searchSource,
                                                                                                               BusinessContextType bContext,
                                                                                                               java.lang.String xPath,
                                                                                                               java.lang.String accessProfile,
                                                                                                               java.lang.String searchProfile,
                                                                                                               javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler)
                                                                                                        throws com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException,
                                                                                                               java.io.UnsupportedEncodingException

Fetches the products that match the search term.

Parameters:

searchTerm - the search term

pageNumber - the page number of search display

pageSize - the number of results in a single page of search display

intentSearchTerm - the search intent term.

originalSearchTerm - the original search term.

searchCategoryId - the category identifier.

searchType - the type of search.

filterTerm - the filter term.

filterType - the type of filter.

manufacturer - the manufacturer.

minPrice - the minimum price limit for search.

maxPrice - the maximum price limit for search.

facetList - the facet of search list.

advancedFacetList - the advanced facet list.

filterFacet - the facet filter.

orderBy - the sorting order.

metaData - the search metaData.

searchSource - the search source.

bContext - the business context

xPath - the xPath

accessProfile - the access profile

searchProfile - the search profile

activityTokenCallbackHandler - the CallbackHandler

Returns:

the search result

Throws:

com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException - the catalog navigation view exception

java.io.UnsupportedEncodingException - the unsupported encoding exception

getProductById

public com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType getProductById(java.lang.String productId,
                                                                                                      BusinessContextType bContext,
                                                                                                      java.lang.String xPath,
                                                                                                      java.lang.String accessProfile,
                                                                                                      java.lang.String searchProfile,
                                                                                                      javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler)
                                                                                               throws com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException

Deprecated. Replaced by getProductByIds(String[], BusinessContextType, String, String, String, CallbackHandler)

Fetches the product details based on Product ID.

Parameters:

productId - the product identifier

bContext - the business context

xPath - the xPath

accessProfile - the access profile

searchProfile - the search profile

activityTokenCallbackHandler - the activity token callback handler

Returns:

the search result

Throws:

com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException - the catalog navigation view exception

getProductByIds

public com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType getProductByIds(java.lang.String[] productIds,
                                                                                                       BusinessContextType bContext,
                                                                                                       java.lang.String xPath,
                                                                                                       java.lang.String accessProfile,
                                                                                                       java.lang.String searchProfile,
                                                                                                       javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler)
                                                                                                throws com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException

Fetches the product details based on Product ID.

Parameters:

productIds - the list of product identifier(s)

bContext - the business context

xPath - the xPath

accessProfile - the access profile

searchProfile - the search profile

activityTokenCallbackHandler - the activity token callback handler

Returns:

the search result

Throws:

com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException - the catalog navigation view exception

getProductByXPath

public com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType getProductByXPath(BusinessContextType bContext,
                                                                                                         java.lang.String xPath,
                                                                                                         java.lang.String accessProfile,
                                                                                                         java.lang.String searchProfile,
                                                                                                         javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler)
                                                                                                  throws com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException

Fetches the product details based on the XPath.

Parameters:

bContext - the business context

xPath - the xPath with parameters populated.

accessProfile - the access profile

searchProfile - the search profile

activityTokenCallbackHandler - the activity token callback handler

Returns:

the search result

Throws:

com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException - the catalog navigation view exception

getProductByPartNumber

public com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType getProductByPartNumber(java.lang.String partNumber,
                                                                                                              BusinessContextType bContext,
                                                                                                              java.lang.String xPath,
                                                                                                              java.lang.String accessProfile,
                                                                                                              java.lang.String searchProfile,
                                                                                                              javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler)
                                                                                                       throws com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException,
                                                                                                              java.io.UnsupportedEncodingException

Fetches the product details based on Part Number.

Parameters:

partNumber - the part number of the product

bContext - the business context

xPath - the xPath

accessProfile - the access profile

searchProfile - the search profile

activityTokenCallbackHandler - the activity token callback handler

Returns:

the search result

Throws:

com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException - the catalog navigation view exception

java.io.UnsupportedEncodingException - the unsupported encoding exception

getProductsByCategory

public com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType getProductsByCategory(java.lang.String categoryId,
                                                                                                             int pageNumber,
                                                                                                             int pageSize,
                                                                                                             java.lang.String orderBy,
                                                                                                             BusinessContextType bContext,
                                                                                                             java.lang.String xPath,
                                                                                                             java.lang.String accessProfile,
                                                                                                             java.lang.String searchProfile,
                                                                                                             javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler)
                                                                                                      throws com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException

Deprecated. A new parameter - searchType is added for find products by parent category

Fetches the products that are under a specified category.

Parameters:

categoryId - the category identifier

pageNumber - the page number of search display

pageSize - the number of results in a single page of search display

orderBy - the sorting order.

bContext - the business context

xPath - the xPath

accessProfile - the access profile

searchProfile - the search profile

activityTokenCallbackHandler - the activity token callback handler

Returns:

the search result

Throws:

com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException - the catalog navigation view exception

getProductsByCategory

public com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType getProductsByCategory(java.lang.String categoryId,
                                                                                                             java.lang.String searchType,
                                                                                                             int pageNumber,
                                                                                                             int pageSize,
                                                                                                             java.lang.String orderBy,
                                                                                                             BusinessContextType bContext,
                                                                                                             java.lang.String xPath,
                                                                                                             java.lang.String accessProfile,
                                                                                                             java.lang.String searchProfile,
                                                                                                             javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler)
                                                                                                      throws com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException

Fetches the products that are under a specified category.

Parameters:

categoryId - the category identifier

searchType - the type of search

pageNumber - the page number of search display

pageSize - the number of results in a single page of search display

orderBy - the sorting order.

bContext - the business context

xPath - the xPath

accessProfile - the access profile

searchProfile - the search profile

activityTokenCallbackHandler - the activity token callback handler

Returns:

the search result

Throws:

com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException - the catalog navigation view exception

getCategoryByUniqueId

public com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType getCategoryByUniqueId(java.lang.String categoryId,
                                                                                                             BusinessContextType bContext,
                                                                                                             java.lang.String xPath,
                                                                                                             java.lang.String accessProfile,
                                                                                                             java.lang.String searchProfile,
                                                                                                             javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler)
                                                                                                      throws com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException

Fetches the category details based on category unique ID.

Parameters:

categoryId - the category unique ID

bContext - the business context

xPath - the xPath

accessProfile - the access profile

searchProfile - the search profile

activityTokenCallbackHandler - the activity token callback handler

Returns:

the search result

Throws:

com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException - the catalog navigation view exception

getCategoryByIdentifier

public com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType getCategoryByIdentifier(java.lang.String groupId,
                                                                                                               BusinessContextType bContext,
                                                                                                               java.lang.String xPath,
                                                                                                               java.lang.String accessProfile,
                                                                                                               java.lang.String searchProfile,
                                                                                                               javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler)
                                                                                                        throws com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException,
                                                                                                               java.io.UnsupportedEncodingException

Fetches the category details based on identifier.

Parameters:

groupId - the category identifier

bContext - the business context

xPath - the xPath

accessProfile - the access profile

searchProfile - the search profile

activityTokenCallbackHandler - the activity token callback handler

Returns:

the search result

Throws:

com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException - the catalog navigation view exception

java.io.UnsupportedEncodingException - the unsupported encoding exception

getTopCategories

public com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType getTopCategories(BusinessContextType bContext,
                                                                                                        java.lang.String xPath,
                                                                                                        java.lang.String accessProfile,
                                                                                                        java.lang.String searchProfile,
                                                                                                        javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler)
                                                                                                 throws com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException

Fetches the top categories of the catalog.

Parameters:

bContext - the business context

xPath - the xPath

accessProfile - the access profile

searchProfile - the search profile

activityTokenCallbackHandler - the activity token callback handler

Returns:

the search result

Throws:

com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException - the catalog navigation view exception

getSubCategories

public com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType getSubCategories(java.lang.String parentCategoryId,
                                                                                                        int pageNumber,
                                                                                                        int pageSize,
                                                                                                        BusinessContextType bContext,
                                                                                                        java.lang.String xPath,
                                                                                                        java.lang.String accessProfile,
                                                                                                        java.lang.String searchProfile,
                                                                                                        javax.security.auth.callback.CallbackHandler activityTokenCallbackHandler)
                                                                                                 throws com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException

Fetches the sub-categories based on the parent category identifier.

Parameters:

parentCategoryId - the parent category identifier

pageNumber - the page number of search display

pageSize - the number of results in a single page of search display

bContext - the business context

xPath - the xPath

accessProfile - the access profile

searchProfile - the search profile

activityTokenCallbackHandler - the activity token callback handler

Returns:

the search result

Throws:

com.ibm.commerce.catalog.facade.client.CatalogNavigationViewException - the catalog navigation view exception

getCategoryUniqueIdentifier

public java.lang.String getCategoryUniqueIdentifier(com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType category)
                                             throws java.lang.Exception

Returns unique identifier for the category.

Parameters:

category - the data area

Returns:

the unique identifier

Throws:

java.lang.Exception

getProductUniqueIdentifier

public java.lang.String getProductUniqueIdentifier(com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType product)
                                            throws java.lang.Exception

Returns unique identifier for the category.

Parameters:

product - the data area

Returns:

the unique identifier

Throws:

java.lang.Exception