Package com.broadleafcommerce.catalog.web.endpoint.commerce

Class CategoryDetailsEndpoint

java.lang.Object

com.broadleafcommerce.catalog.web.endpoint.commerce.CategoryDetailsEndpoint

@FrameworkRestController
@FrameworkMapping("/category-details")
@DataRouteByExample(CategoryDetails.class)
public class CategoryDetailsEndpoint
extends Object

Author:

Nathan Moore (nathandmoore)

Constructor Summary

Constructors

Constructor	Description
CategoryDetailsEndpoint(CategoryDetailsService categoryDetailsService)

Method Summary

Modifier and Type	Method	Description
protected CategoryDetailsService	getCategoryDetailsService()
org.springframework.http.ResponseEntity<CategoryDetails>	readDetailsForRequest(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, org.springframework.data.domain.Pageable productPageInfo, CategoryDetailsRequest categoryDetailsRequest, org.springframework.util.MultiValueMap<String,String> parameters)	Returns a CategoryDetails for the given CategoryDetailsRequest.

Methods inherited from class java.lang.Object

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

Constructor Details

CategoryDetailsEndpoint

public CategoryDetailsEndpoint(CategoryDetailsService categoryDetailsService)

Method Details

readDetailsForRequest

@FrameworkGetMapping
public org.springframework.http.ResponseEntity<CategoryDetails> readDetailsForRequest(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PageableDefault
 org.springframework.data.domain.Pageable productPageInfo,
 CategoryDetailsRequest categoryDetailsRequest,
 @RequestParam
 org.springframework.util.MultiValueMap<String,String> parameters)

Returns a CategoryDetails for the given CategoryDetailsRequest. If the request is missing or has insufficient information (e.g., is missing CategoryDetailsRequest.getCategoryId() and CategoryDetailsRequest.getCategoryUrl()), the this returns a 400 error. If no category matches the request, then this returns a 404.

Parameters:

request - HttpServletRequest for the request

context - Context info for multitenant and sandbox conditions

productPageInfo - pagination info to apply to products included in the response.

categoryDetailsRequest - The CategoryDetailsRequest

Returns:

a CategoryDetails matching the CategoryDetailsRequest.

getCategoryDetailsService

protected CategoryDetailsService getCategoryDetailsService()