Package com.broadleafcommerce.ratings.web.endpoint

Class CustomerRatingsEndpoint

java.lang.Object

com.broadleafcommerce.ratings.web.endpoint.CustomerRatingsEndpoint

@FrameworkRestController
@FrameworkMapping("/rating-detail")
@DataRouteByExample(RatingDetail.class)
public class CustomerRatingsEndpoint
extends Object

Endpoints for managing customer interactions with their ratings and reviews.

Author:

Cade Rea (cade-rea)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
CustomerRatingsEndpoint(CustomerRatingService<RatingDetail> customerRatingService)

Method Summary

Modifier and Type	Method	Description
void	deleteRatingByCustomer(String customerId, String detailId, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
protected CustomerRatingService<RatingDetail>	getCustomerRatingService()
org.springframework.data.domain.Page<RatingDetail>	getRatingDetailsForCustomer(String customerId, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
RatingDetail	submitProductRating(String productId, RatingRequest ratingRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
RatingDetail	submitVariantRating(String productId, String variantId, RatingRequest ratingRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
RatingDetail	updateRatingByCustomer(String customerId, String detailId, RatingRequest ratingRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

Methods inherited from class java.lang.Object

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

Field Details

BASE_URI

public static final String BASE_URI

See Also:

• Constant Field Values

Constructor Details

CustomerRatingsEndpoint

public CustomerRatingsEndpoint(CustomerRatingService<RatingDetail> customerRatingService)

Method Details

getRatingDetailsForCustomer

@FrameworkGetMapping("/customer/{customerId}")
@Policy(permissionRoots="RATING_DETAIL",
        ownerIdentifierParam=0,
        operationTypes=READ,
        identityTypes={ADMIN,OWNER})
public org.springframework.data.domain.Page<RatingDetail> getRatingDetailsForCustomer(@PathVariable
 String customerId,
 @PageableDefault(size=5)
 org.springframework.data.domain.Pageable page,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

submitProductRating

@FrameworkPostMapping("/product/{productId}")
@Policy(permissionRoots="RATING_DETAIL",
        operationTypes=CREATE)
public RatingDetail submitProductRating(@PathVariable
 String productId,
 @RequestBody
 RatingRequest ratingRequest,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

submitVariantRating

@FrameworkPostMapping("/product/{productId}/variant/{variantId}")
@Policy(permissionRoots="RATING_DETAIL",
        operationTypes=CREATE)
public RatingDetail submitVariantRating(@PathVariable
 String productId,
 @PathVariable
 String variantId,
 @RequestBody
 RatingRequest ratingRequest,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

updateRatingByCustomer

@FrameworkMapping(path="/customer/{customerId}/rating-detail/{detailId}",
                  method={PUT,PATCH})
@Policy(permissionRoots="RATING_DETAIL",
        operationTypes=UPDATE)
public RatingDetail updateRatingByCustomer(@PathVariable
 String customerId,
 @PathVariable
 String detailId,
 @RequestBody
 RatingRequest ratingRequest,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

deleteRatingByCustomer

@FrameworkDeleteMapping("/customer/{customerId}/rating-detail/{detailId}")
@Policy(permissionRoots="RATING_DETAIL",
        operationTypes=DELETE)
public void deleteRatingByCustomer(@PathVariable
 String customerId,
 @PathVariable
 String detailId,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

getCustomerRatingService

protected CustomerRatingService<RatingDetail> getCustomerRatingService()