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

Class DataDrivenEnumDetailsEndpoint

java.lang.Object

com.broadleafcommerce.catalog.web.endpoint.commerce.DataDrivenEnumDetailsEndpoint

@FrameworkRestController
@FrameworkMapping("/data-driven-enum-details")
@DataRouteByExample(DataDrivenEnumDetails.class)
public class DataDrivenEnumDetailsEndpoint
extends Object

Author:

Sunny Yu

Constructor Summary

Constructors

Constructor	Description
DataDrivenEnumDetailsEndpoint(DataDrivenEnumDetailsService dataDrivenEnumDetailsService)

Method Summary

Modifier and Type	Method	Description
protected DataDrivenEnumDetailsService	getDataDrivenEnumDetailsService()
org.springframework.http.ResponseEntity<DataDrivenEnumDetailsList>	readDetailsForRequest(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, DataDrivenEnumDetailsRequest detailsRequest, org.springframework.util.MultiValueMap<String,String> parameters)	Returns a DataDrivenEnumDetailsList for the given DataDrivenEnumDetailsRequest.

Methods inherited from class java.lang.Object

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

Constructor Details

DataDrivenEnumDetailsEndpoint

public DataDrivenEnumDetailsEndpoint(DataDrivenEnumDetailsService dataDrivenEnumDetailsService)

Method Details

readDetailsForRequest

@FrameworkGetMapping
public org.springframework.http.ResponseEntity<DataDrivenEnumDetailsList> readDetailsForRequest(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 DataDrivenEnumDetailsRequest detailsRequest,
 @RequestParam
 org.springframework.util.MultiValueMap<String,String> parameters)

Returns a DataDrivenEnumDetailsList for the given DataDrivenEnumDetailsRequest. If the request is missing or has insufficient information (e.g., is missing DataDrivenEnumDetailsRequest.getDataDrivenEnumIds()), then this returns a 400 error. If no data driven enum matches the request, then this returns a 404.

Parameters:

request - HttpServletRequest for the request

context - Context info for multitenant and sandbox conditions

detailsRequest - The DataDrivenEnumDetailsRequest

Returns:

a DataDrivenEnumDetails matching the DataDrivenEnumDetailsRequest.

getDataDrivenEnumDetailsService

protected DataDrivenEnumDetailsService getDataDrivenEnumDetailsService()