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

Class RatingEndpoint

java.lang.Object

com.broadleafcommerce.rest.api.endpoint.BaseEndpoint

com.broadleafcommerce.rest.api.endpoint.catalog.RatingEndpoint

All Implemented Interfaces:

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

@FrameworkRestController
@FrameworkMapping(value="/ratings",
                  produces={"application/json","application/xml"})
public class RatingEndpoint
extends BaseEndpoint

Author:

Nick Crum ncrum

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.broadleafcommerce.profile.core.service.CustomerService	customerService
protected final org.broadleafcommerce.core.rating.service.RatingService	ratingService

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

context, messageSource

Constructor Summary

Constructors

Constructor	Description
RatingEndpoint(org.broadleafcommerce.core.rating.service.RatingService ratingService, org.broadleafcommerce.profile.core.service.CustomerService customerService)

Method Summary

Modifier and Type	Method	Description
RatingSummaryWrapper	getRatingsForItem(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, String itemId, String ratingType)
RatingSummaryWrapper	submitReviewForItem(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, String itemId, String ratingType, ReviewDetailWrapper reviewDetailWrapper)

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

ratingService

protected final org.broadleafcommerce.core.rating.service.RatingService ratingService

customerService

protected final org.broadleafcommerce.profile.core.service.CustomerService customerService

Constructor Details

RatingEndpoint

public RatingEndpoint(org.broadleafcommerce.core.rating.service.RatingService ratingService,
 org.broadleafcommerce.profile.core.service.CustomerService customerService)

Method Details

getRatingsForItem

@FrameworkMapping("/{itemId}")
public RatingSummaryWrapper getRatingsForItem(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @PathVariable("itemId")
 String itemId,
 @RequestParam(value="ratingType",required=false,defaultValue="PRODUCT")
 String ratingType)

submitReviewForItem

@FrameworkMapping(value="/{itemId}",
                  method=POST)
public RatingSummaryWrapper submitReviewForItem(jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response,
 @PathVariable("itemId")
 String itemId,
 @RequestParam(value="ratingType",required=false,defaultValue="PRODUCT")
 String ratingType,
 @RequestBody
 ReviewDetailWrapper reviewDetailWrapper)