Package com.broadleafcommerce.catalog.web.endpoint

Class DataDrivenEnumEndpoint

java.lang.Object

com.broadleafcommerce.catalog.web.endpoint.DataDrivenEnumEndpoint

@FrameworkRestController
@FrameworkMapping("/data-driven-enums")
@DataRouteByExample(DataDrivenEnum.class)
public class DataDrivenEnumEndpoint
extends Object

Operations that are performed for a DataDrivenEnum.

Author:

Sunny Yu

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
DataDrivenEnumEndpoint(DataDrivenEnumService<DataDrivenEnum> dataDrivenEnumService, com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Summary

Modifier and Type	Method	Description
DataDrivenEnum	createDataDrivenEnum(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, DataDrivenEnum req)
void	deleteDataDrivenEnum(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
protected DataDrivenEnumService<DataDrivenEnum>	getDataDrivenEnumService()
protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation>	getTranslationEntityService()
org.springframework.data.domain.Page<DataDrivenEnum>	readAllDataDrivenEnums(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String query, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
DataDrivenEnum	readDataDrivenEnumById(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String enumId)
com.broadleafcommerce.translation.service.dto.TranslationsPayload	replaceAllDataDrivenEnumTranslations(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)
DataDrivenEnum	replaceDataDrivenEnum(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, DataDrivenEnum req)
DataDrivenEnum	updateDataDrivenEnum(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, DataDrivenEnum req)

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

DataDrivenEnumEndpoint

public DataDrivenEnumEndpoint(DataDrivenEnumService<DataDrivenEnum> dataDrivenEnumService,
 com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Details

readAllDataDrivenEnums

@FrameworkGetMapping
@Policy(permissionRoots="DATA_DRIVEN_ENUM")
public org.springframework.data.domain.Page<DataDrivenEnum> readAllDataDrivenEnums(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestParam(value="q",required=false)
 String query,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page)

readDataDrivenEnumById

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="DATA_DRIVEN_ENUM")
public DataDrivenEnum readDataDrivenEnumById(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String enumId)

updateDataDrivenEnum

@FrameworkPatchMapping(value="/{id}",
                       consumes="application/json")
@Policy(permissionRoots="DATA_DRIVEN_ENUM")
public DataDrivenEnum updateDataDrivenEnum(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id,
 @RequestBody
 DataDrivenEnum req)

replaceDataDrivenEnum

@FrameworkPutMapping(value="/{id}",
                     consumes="application/json")
@Policy(permissionRoots="DATA_DRIVEN_ENUM")
public DataDrivenEnum replaceDataDrivenEnum(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id,
 @RequestBody
 DataDrivenEnum req)

replaceAllDataDrivenEnumTranslations

@FrameworkPutMapping(value="/{id}/translations/{locale}",
                     consumes="application/json")
@Policy(permissionRoots="DATA_DRIVEN_ENUM")
public com.broadleafcommerce.translation.service.dto.TranslationsPayload replaceAllDataDrivenEnumTranslations(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id,
 @PathVariable("locale")
 Locale locale,
 @RequestBody
 com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)

createDataDrivenEnum

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="DATA_DRIVEN_ENUM")
public DataDrivenEnum createDataDrivenEnum(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 DataDrivenEnum req)

deleteDataDrivenEnum

@FrameworkDeleteMapping("/{id}")
@Policy(permissionRoots="DATA_DRIVEN_ENUM")
public void deleteDataDrivenEnum(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id)

getDataDrivenEnumService

protected DataDrivenEnumService<DataDrivenEnum> getDataDrivenEnumService()

getTranslationEntityService

protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> getTranslationEntityService()