Package com.broadleafcommerce.catalog.web.endpoint

Class CharacteristicEndpoint

java.lang.Object

com.broadleafcommerce.catalog.web.endpoint.CharacteristicEndpoint

@FrameworkRestController
@FrameworkMapping("/characteristics")
@DataRouteByExample(Characteristic.class)
public class CharacteristicEndpoint
extends Object

Since:

Catalog Service 2.2.0, Release Train 2.2.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
CharacteristicEndpoint(CharacteristicService<Characteristic> characteristicService, com.broadleafcommerce.common.extension.TypeFactory typeFactory, org.springframework.context.MessageSource messageSource, com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Summary

Modifier and Type	Method	Description
Characteristic	createCharacteristic(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, Characteristic characteristic)
org.springframework.http.ResponseEntity<Void>	deleteCharacteristic(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
protected CharacteristicService<Characteristic>	getCharacteristicService()
protected org.springframework.context.MessageSource	getMessageSource()
protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation>	getTranslationEntityService()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
protected void	hydrateCharacteristicValueValueTypes(Characteristic characteristic)
org.springframework.data.domain.Page<Characteristic>	readAllCharacteristics(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String query, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
Characteristic	readCharacteristicById(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String characteristicId)
com.broadleafcommerce.translation.service.dto.TranslationsPayload	replaceAllCharacteristicTranslations(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)
Characteristic	replaceCharacteristic(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Characteristic characteristic)
Characteristic	updateCharacteristic(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Characteristic characteristic)

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

CharacteristicEndpoint

public CharacteristicEndpoint(CharacteristicService<Characteristic> characteristicService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 org.springframework.context.MessageSource messageSource,
 com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Details

readAllCharacteristics

@FrameworkGetMapping
@Policy(permissionRoots="CHARACTERISTIC")
public org.springframework.data.domain.Page<Characteristic> readAllCharacteristics(@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,sort="name",direction=ASC)
 org.springframework.data.domain.Pageable page)

readCharacteristicById

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="CHARACTERISTIC")
public Characteristic readCharacteristicById(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String characteristicId)

createCharacteristic

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="CHARACTERISTIC")
public Characteristic createCharacteristic(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 Characteristic characteristic)

updateCharacteristic

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

replaceCharacteristic

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

deleteCharacteristic

@FrameworkDeleteMapping("/{id}")
@Policy(permissionRoots="CHARACTERISTIC")
public org.springframework.http.ResponseEntity<Void> deleteCharacteristic(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String id)

replaceAllCharacteristicTranslations

@FrameworkPutMapping(value="/{id}/translations/{locale}",
                     consumes="application/json")
@Policy(permissionRoots="CHARACTERISTIC")
public com.broadleafcommerce.translation.service.dto.TranslationsPayload replaceAllCharacteristicTranslations(@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)

hydrateCharacteristicValueValueTypes

protected void hydrateCharacteristicValueValueTypes(Characteristic characteristic)

getCharacteristicService

protected CharacteristicService<Characteristic> getCharacteristicService()

getTypeFactory

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

getMessageSource

protected org.springframework.context.MessageSource getMessageSource()

getTranslationEntityService

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