Package com.broadleafcommerce.catalog.web.endpoint

Class ProductTagVariantEndpoint

java.lang.Object

com.broadleafcommerce.catalog.web.endpoint.ProductTagVariantEndpoint

@FrameworkRestController
@FrameworkMapping("/products/{productId}/variants/{variantId}/tags")
@DataRouteByExample(Product.class)
public class ProductTagVariantEndpoint
extends Object

Endpoint for managing ProductTags from a Variant context.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
ProductTagVariantEndpoint(VariantService<Variant> variantService, ProductService<Product> productService, AdvancedTagService<AdvancedTag> tagService, ProductTagService<ProductTag> productTagService, com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Summary

Modifier and Type	Method	Description
ProductTag	addVariantTag(String productId, String variantId, ProductTag req, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.http.ResponseEntity<Void>	deleteVariantTag(String productId, String variantId, String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected ProductService<Product>	getProductService()
protected ProductTagService<ProductTag>	getProductTagService()
protected AdvancedTagService<AdvancedTag>	getTagService()
protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation>	getTranslationEntityService()
protected VariantService<Variant>	getVariantService()
protected void	hydrateVariantTag(String productId, String variantId, ProductTag productTag, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
ProductTag	patchVariantTag(String productId, String variantId, String id, ProductTag productTag, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<ProductTag>	readAllVariantTags(String variantId, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<ProductTag>	readAllVariantTagsSorted(String productId, String variantId, boolean isSorted, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
ProductTag	readVariantTag(String variantId, String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
ProductTag	reorderVariantTag(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String productId, String variantId, String id, com.broadleafcommerce.data.tracking.core.sort.SortPositionRequest sortPositionRequest)
com.broadleafcommerce.translation.service.dto.TranslationsPayload	replaceAllVariantTagTranslations(String productId, String variantId, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
ProductTag	replaceVariantTag(String productId, String variantId, String id, ProductTag productTag, 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

ProductTagVariantEndpoint

public ProductTagVariantEndpoint(VariantService<Variant> variantService,
 ProductService<Product> productService,
 AdvancedTagService<AdvancedTag> tagService,
 ProductTagService<ProductTag> productTagService,
 com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Details

readAllVariantTags

@FrameworkGetMapping
@Policy(permissionRoots="PRODUCT")
public org.springframework.data.domain.Page<ProductTag> readAllVariantTags(@PathVariable("variantId")
 String variantId,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readAllVariantTagsSorted

@FrameworkGetMapping(params="isSorted")
@Policy(permissionRoots="PRODUCT")
public org.springframework.data.domain.Page<ProductTag> readAllVariantTagsSorted(@PathVariable("productId")
 String productId,
 @PathVariable("variantId")
 String variantId,
 @RequestParam
 boolean isSorted,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readVariantTag

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="PRODUCT")
public ProductTag readVariantTag(@PathVariable("variantId")
 String variantId,
 @PathVariable("id")
 String id,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

replaceVariantTag

@FrameworkPutMapping(path="/{id}",
                     consumes="application/json")
@Policy(permissionRoots="PRODUCT")
public ProductTag replaceVariantTag(@PathVariable("productId")
 String productId,
 @PathVariable("variantId")
 String variantId,
 @PathVariable("id")
 String id,
 @RequestBody
 ProductTag productTag,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

patchVariantTag

@FrameworkPatchMapping(path="/{id}",
                       consumes="application/json")
@Policy(permissionRoots="PRODUCT")
public ProductTag patchVariantTag(@PathVariable("productId")
 String productId,
 @PathVariable("variantId")
 String variantId,
 @PathVariable("id")
 String id,
 @RequestBody
 ProductTag productTag,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

addVariantTag

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="PRODUCT")
public ProductTag addVariantTag(@PathVariable("productId")
 String productId,
 @PathVariable("variantId")
 String variantId,
 @RequestBody
 ProductTag req,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteVariantTag

@FrameworkDeleteMapping("/{id}")
@Policy(permissionRoots="PRODUCT")
public org.springframework.http.ResponseEntity<Void> deleteVariantTag(@PathVariable("productId")
 String productId,
 @PathVariable("variantId")
 String variantId,
 @PathVariable("id")
 String id,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

replaceAllVariantTagTranslations

@FrameworkPutMapping(path="/{id}/translation/{locale}")
@Policy(permissionRoots="PRODUCT")
public com.broadleafcommerce.translation.service.dto.TranslationsPayload replaceAllVariantTagTranslations(@PathVariable("productId")
 String productId,
 @PathVariable("variantId")
 String variantId,
 @PathVariable("id")
 String id,
 @PathVariable("locale")
 Locale locale,
 @RequestBody
 com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

reorderVariantTag

@FrameworkPatchMapping("/{id}/sort")
@Policy(permissionRoots="PRODUCT")
public ProductTag reorderVariantTag(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("productId")
 String productId,
 @PathVariable("variantId")
 String variantId,
 @PathVariable("id")
 String id,
 @UpdateSortOperation
 com.broadleafcommerce.data.tracking.core.sort.SortPositionRequest sortPositionRequest)

hydrateVariantTag

protected void hydrateVariantTag(String productId,
 String variantId,
 ProductTag productTag,
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getVariantService

protected VariantService<Variant> getVariantService()

getProductService

protected ProductService<Product> getProductService()

getTagService

protected AdvancedTagService<AdvancedTag> getTagService()

getProductTagService

protected ProductTagService<ProductTag> getProductTagService()

getTranslationEntityService

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