Package com.broadleafcommerce.rest.api.endpoint.catalog

Class RelatedProductsEndpoint

java.lang.Object

com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

com.broadleafcommerce.rest.api.endpoint.catalog.RelatedProductsEndpoint

All Implemented Interfaces:

org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.MessageSourceAware

@FrameworkRestController
@FrameworkMapping(value="/related-products",
                  produces={"application/json","application/xml"})
public class RelatedProductsEndpoint
extends BaseEndpoint

Author:

Nick Crum ncrum

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.broadleafcommerce.core.catalog.service.CatalogService	catalogService
protected final PromotionMessageDTOWrapperService	promotionMessageDTOWrapperService
protected final org.broadleafcommerce.core.catalog.service.RelatedProductsService	relatedProductsService

Fields inherited from class com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

context, messageSource

Constructor Summary

Constructors

Constructor	Description
RelatedProductsEndpoint(org.broadleafcommerce.core.catalog.service.CatalogService catalogService, org.broadleafcommerce.core.catalog.service.RelatedProductsService relatedProductsService, PromotionMessageDTOWrapperService promotionMessageDTOWrapperService)

Method Summary

Modifier and Type	Method	Description
protected List<org.broadleafcommerce.core.catalog.domain.Product>	buildProductList(List<? extends org.broadleafcommerce.core.catalog.domain.PromotableProduct> relatedProducts)
List<ProductWrapper>	getRelatedProducts(jakarta.servlet.http.HttpServletRequest request, Long productId, String productKey, Long categoryId, String categoryKey, Integer quantity, String type, Boolean includePromotionMessages, Boolean includePriceData)

Methods inherited from class com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

getApplicationContext, getMessageSource, setApplicationContext, setMessageSource

Methods inherited from class java.lang.Object

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

Field Details

relatedProductsService

protected final org.broadleafcommerce.core.catalog.service.RelatedProductsService relatedProductsService

catalogService

protected final org.broadleafcommerce.core.catalog.service.CatalogService catalogService

promotionMessageDTOWrapperService

protected final PromotionMessageDTOWrapperService promotionMessageDTOWrapperService

Constructor Details

RelatedProductsEndpoint

@Autowired
public RelatedProductsEndpoint(org.broadleafcommerce.core.catalog.service.CatalogService catalogService,
 org.broadleafcommerce.core.catalog.service.RelatedProductsService relatedProductsService,
 PromotionMessageDTOWrapperService promotionMessageDTOWrapperService)

Method Details

getRelatedProducts

@FrameworkMapping(method=GET)
public List<ProductWrapper> getRelatedProducts(jakarta.servlet.http.HttpServletRequest request,
 @RequestParam(value="productId",required=false)
 Long productId,
 @RequestParam(value="productKey",required=false)
 String productKey,
 @RequestParam(value="categoryId",required=false)
 Long categoryId,
 @RequestParam(value="categoryKey",required=false)
 String categoryKey,
 @RequestParam(value="quantity",required=false)
 Integer quantity,
 @RequestParam(value="type",required=false)
 String type,
 @RequestParam(value="includePromotionMessages",required=false)
 Boolean includePromotionMessages,
 @RequestParam(value="includePriceData",required=false)
 Boolean includePriceData)

buildProductList

protected List<org.broadleafcommerce.core.catalog.domain.Product> buildProductList(List<? extends org.broadleafcommerce.core.catalog.domain.PromotableProduct> relatedProducts)