Package com.broadleafcommerce.ratings.web.endpoint

Class RatingSummaryEndpoint

java.lang.Object

com.broadleafcommerce.ratings.web.endpoint.RatingSummaryEndpoint

@FrameworkRestController
@FrameworkMapping("/rating-summary")
@DataRouteByExample(RatingSummary.class)
public class RatingSummaryEndpoint
extends Object

Endpoint for reading rating summaries.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
RatingSummaryEndpoint(RatingSummaryService<RatingSummary> ratingSummaryService, com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Summary

Modifier and Type	Method	Description
protected RatingSummary	emptyRatingSummary(String targetId, String parentTargetId, String ratingTargetType)
protected RatingSummaryService<RatingSummary>	getRatingSummaryService()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected List<RatingSummary>	mapWithEmptySummaries(List<RatingSummary> results, Set<String> requestedTargetIds)
RatingSummary	readByProductId(String productId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<RatingSummary>	readByTargetIds(Set<String> targetIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
RatingSummary	readByVariantId(String productId, String variantId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

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

RatingSummaryEndpoint

public RatingSummaryEndpoint(RatingSummaryService<RatingSummary> ratingSummaryService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory)

Method Details

readByProductId

@FrameworkGetMapping("/product/{productId}")
@Policy(permissionRoots="RATING_DETAIL")
public RatingSummary readByProductId(@PathVariable
 String productId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readByVariantId

@FrameworkGetMapping("/product/{productId}/variant/{variantId}")
@Policy(permissionRoots="RATING_DETAIL")
public RatingSummary readByVariantId(@PathVariable
 String productId,
 @PathVariable
 String variantId,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readByTargetIds

@FrameworkGetMapping
@Policy(permissionRoots="RATING_DETAIL")
public List<RatingSummary> readByTargetIds(@RequestParam(name="targetIds")
 Set<String> targetIds,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

mapWithEmptySummaries

protected List<RatingSummary> mapWithEmptySummaries(List<RatingSummary> results,
 Set<String> requestedTargetIds)

emptyRatingSummary

protected RatingSummary emptyRatingSummary(String targetId,
 @Nullable
 String parentTargetId,
 @Nullable
 String ratingTargetType)

getRatingSummaryService

protected RatingSummaryService<RatingSummary> getRatingSummaryService()

getTypeFactory

protected com.broadleafcommerce.common.extension.TypeFactory getTypeFactory()