Package com.broadleafcommerce.catalog.web.endpoint.option

Class OptionTemplateEndpoint

java.lang.Object

com.broadleafcommerce.catalog.web.endpoint.option.OptionTemplateEndpoint

@FrameworkRestController
@FrameworkMapping("/option-templates")
@DataRouteByExample(OptionTemplate.class)
public class OptionTemplateEndpoint
extends Object

Author:

Nathan Moore (nathanmoore).

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
OptionTemplateEndpoint(OptionTemplateService<OptionTemplate> productOptionService, com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService, ProductHydrationService productHydrationService)

Method Summary

Modifier and Type	Method	Description
OptionTemplate	create(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, OptionTemplate req)
void	delete(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
protected ProductHydrationService	getProductHydrationService()
protected OptionTemplateService<OptionTemplate>	getService()
protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation>	getTranslationEntityService()
OptionTemplate	read(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
org.springframework.data.domain.Page<OptionTemplate>	readAll(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String query, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)
OptionTemplate	replace(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, OptionTemplate req)
com.broadleafcommerce.translation.service.dto.TranslationsPayload	replaceAllProductOptionTranslations(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)
OptionTemplate	update(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, OptionTemplate 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

OptionTemplateEndpoint

public OptionTemplateEndpoint(OptionTemplateService<OptionTemplate> productOptionService,
 com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService,
 ProductHydrationService productHydrationService)

Method Details

readAll

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

read

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="OPTION_TEMPLATE")
public OptionTemplate read(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id)

replace

@FrameworkPutMapping("/{id}")
@Policy(permissionRoots="OPTION_TEMPLATE")
public OptionTemplate replace(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id,
 @RequestBody
 OptionTemplate req)

replaceAllProductOptionTranslations

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

update

@FrameworkPatchMapping("/{id}")
@Policy(permissionRoots="OPTION_TEMPLATE")
public OptionTemplate update(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id,
 @RequestBody
 OptionTemplate req)

create

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="OPTION_TEMPLATE")
public OptionTemplate create(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestBody
 OptionTemplate req)

delete

@FrameworkDeleteMapping("/{id}")
@Policy(permissionRoots="OPTION_TEMPLATE")
public void delete(@ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id)

getService

protected OptionTemplateService<OptionTemplate> getService()

getTranslationEntityService

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

getProductHydrationService

protected ProductHydrationService getProductHydrationService()