Field Detail

• COPYRIGHT

  public static final java.lang.String COPYRIGHT
  

  IBM Copyright notice field.

  See Also:

  Constant Field Values

• RESOURCE_NAME

  public static final java.lang.String RESOURCE_NAME
  

  The Constant RESOURCE_NAME.

  See Also:

  Constant Field Values

• RESOURCE_MAPPING_KEY_SUMMARY

  public static final java.lang.String RESOURCE_MAPPING_KEY_SUMMARY
  

  The Constant RESOURCE_MAPPING_KEY_SUMMARY.

  See Also:

  Constant Field Values

• RESOURCE_MAPPING_KEY_DETAILS

  public static final java.lang.String RESOURCE_MAPPING_KEY_DETAILS
  

  The Constant RESOURCE_MAPPING_KEY_DETAILS.

  See Also:

  Constant Field Values

• PRODUCTS_BY_SEARCH_TERM

  public static final java.lang.String PRODUCTS_BY_SEARCH_TERM
  

  The Constant PRODUCTS_BY_SEARCH_TERM.

  See Also:

  Constant Field Values

• PRODUCTS_BY_ID

  public static final java.lang.String PRODUCTS_BY_ID
  

  The Constant PRODUCTS_BY_ID.

  See Also:

  Constant Field Values

• PRODUCTS_BY_IDS

  public static final java.lang.String PRODUCTS_BY_IDS
  

  The Constant PRODUCTS_BY_ID.

  See Also:

  Constant Field Values

• PRODUCTS_BY_PARTNUMBER

  public static final java.lang.String PRODUCTS_BY_PARTNUMBER
  

  The Constant PRODUCTS_BY_PARTNUMBER.

  See Also:

  Constant Field Values

• PRODUCTS_BY_CATEGORY

  public static final java.lang.String PRODUCTS_BY_CATEGORY
  

  The Constant PRODUCTS_BY_CATEGORY.

  See Also:

  Constant Field Values

• BY_ID

  public static final java.lang.String BY_ID
  

  The Constant BY_ID.

  See Also:

  Constant Field Values

• PARAMETER_ASSOCIATION_TYPE

  public static final java.lang.String PARAMETER_ASSOCIATION_TYPE
  

  The associationType

  See Also:

  Constant Field Values

• PARAMETER_ASSOCIATION_TYPE_DESCRIPTION

  public static final java.lang.String PARAMETER_ASSOCIATION_TYPE_DESCRIPTION
  

  associationType description

  See Also:

  Constant Field Values

• helper

  protected SearchHelper helper
  

  Helper to retrieve and deal with BOD.

Constructor Detail

• ProductViewHandler

  public ProductViewHandler()
  

Method Detail

• getResourceName

  public java.lang.String getResourceName()
  

  Description copied from interface: IResourceHandler
  This method returns the name of the resource used primarily to determine the representation of the resource. This class can be overridden to change the name of the resource and therefore the representation, while keeping all the methods in this class.

  Returns:

  the resource name

• getHelper

  public SearchHelper getHelper()
  

  Return the BOD helper associated with the catalog resource.

  Returns:

  SearchHelper

• getFormattingGroupName

  public java.lang.String getFormattingGroupName()
  

  Description copied from class: AbstractBaseResourceHandler
  Returns the formatting group name for resolving the struts action of the formatting JSP. Overwrite this method in your resource handler class to return a formatting group name specific to your resource handler.

  Specified by:

  getFormattingGroupName in interface IResourceHandler

  Overrides:

  getFormattingGroupName in class AbstractBaseResourceHandler

  Returns:

  the formatting group name.

• findProductsBySearchTerm

  public javax.ws.rs.core.Response findProductsBySearchTerm(java.lang.String storeId,
                                                   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,
                                                   java.lang.String responseFormat)
  

  Deprecated. The facet parameter has been changed from String to List in order to pass multiple facet values.
  This method performs product search based on the search term.

  Parameters:

  storeId - the store identifier.

  searchTerm - the search term.

  pageNumber - the page number of search results to display.

  pageSize - the size of each 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.

  responseFormat - the response format shortcut (e.g, xml, json).

  Returns:

  the response

• findProductsBySearchTerm

  public javax.ws.rs.core.Response findProductsBySearchTerm(java.lang.String storeId,
                                                   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,
                                                   java.lang.String responseFormat)
  

  This method performs product search based on the search term.

  Parameters:

  storeId - the store identifier.

  searchTerm - the search term.

  pageNumber - the page number of search results to display.

  pageSize - the size of each 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.

  responseFormat - the response format shortcut (e.g, xml, json).

  Returns:

  the response

• findProductById

  public javax.ws.rs.core.Response findProductById(java.lang.String storeId,
                                          java.lang.String productId,
                                          java.lang.String responseFormat)
  

  Deprecated. Replaced by findProductsByIds(String, List, String)
  This method retrieves details of a product based on the Product ID.

  Parameters:

  storeId - the store identifier.

  productId - the product identifier.

  responseFormat - the response format shortcut (e.g, xml, json).

  Returns:

  the response.

• findProductsByIds

  public javax.ws.rs.core.Response findProductsByIds(java.lang.String storeId,
                                            java.util.List<java.lang.String> productIds,
                                            java.lang.String responseFormat)
  

  This method retrieves product details of products based on a list of product IDs.

  Parameters:

  storeId - the store identifier.

  productIds - the list of product identifiers.

  responseFormat - the response format shortcut (e.g, xml, json).

  Returns:

  the response.

• findProductByPartNumber

  public javax.ws.rs.core.Response findProductByPartNumber(java.lang.String storeId,
                                                  java.lang.String partNumber,
                                                  java.lang.String responseFormat)
  

  This method retrieves details of a product based on the PartNumber.

  Parameters:

  storeId - the store identifier.

  partNumber - the part number of the product.

  responseFormat - the response format shortcut(e.g, xml, json).

  Returns:

  the response.

• findProductsByCategory

  public javax.ws.rs.core.Response findProductsByCategory(java.lang.String storeId,
                                                 java.lang.String categoryId,
                                                 int pageNumber,
                                                 int pageSize,
                                                 java.lang.String orderBy,
                                                 java.lang.String responseFormat)
  

  Deprecated. A new parameter - searchType is added for find products by parent category
  This method retrieves products based on the parent Category ID.

  Parameters:

  storeId - the store identifier.

  categoryId - the category identifier.

  pageNumber - the page number of search results to display.

  pageSize - the size of each page of search display.

  orderBy - the sorting order.

  responseFormat - the response format shortcut(e.g, xml, json).

  Returns:

  the response.

• findProductsByCategory

  public javax.ws.rs.core.Response findProductsByCategory(java.lang.String storeId,
                                                 java.lang.String categoryId,
                                                 java.lang.String searchType,
                                                 int pageNumber,
                                                 int pageSize,
                                                 java.lang.String orderBy,
                                                 java.lang.String responseFormat)
  

  This method retrieves products based on the parent Category ID.

  Parameters:

  storeId - the store identifier.

  categoryId - the category identifier.

  searchType - the type of search

  pageNumber - the page number of search results to display.

  pageSize - the size of each page of search display.

  orderBy - the sorting order.

  responseFormat - the response format shortcut(e.g, xml, json).

  Returns:

  the response.

• generateResponse

  protected javax.ws.rs.core.Response generateResponse(com.ibm.commerce.catalog.facade.datatypes.ShowCatalogNavigationViewDataAreaType dataArea,
                                           java.lang.String urlParamGroupName,
                                           java.lang.String responseFormat)
  

  Generates REST response from a given data object and its corresponding URL parameter group name from the BOD to URL mapping configuration.

  This method calls createMapForProvider to create the response data map. The response status code is resolved based on the input parameters.

  Parameters:

  dataArea - the data object.

  urlParamGroupName - the URL parameter group name.

  responseFormat - the response format shortcut. Response format is used to resolve the media type for the REST response. If response format is not provided, then Accept header is used to resolve the media type for the REST response. Refer to MediaTypeHelper.getResponseMediaType(String, Request) for more details on the response media type resolution.

  Returns:

  the REST response.

• postProcess

  public void postProcess(java.util.Map<java.lang.String,java.lang.Object> responseMap)
  

  (non-Javadoc)

  Specified by:

  postProcess in interface IResourceHandler

  Overrides:

  postProcess in class AbstractBaseResourceHandler

  Parameters:

  responseMap - The response Map after each DataObject has been converted to a Map.

  See Also:

  AbstractBaseResourceHandler.postProcess(java.util.Map)

• getExternalResourceName

  public java.lang.String getExternalResourceName()
  

  Description copied from class: AbstractBaseResourceHandler
  Get the resource name to show externally. This defaults to the value returned by getResourceName if this method isn't overridden.

  Overrides:

  getExternalResourceName in class AbstractBaseResourceHandler

  Returns:

  The external resource name.