Package com.broadleafcommerce.catalog.web.endpoint

Class AdvancedTagEndpoint

java.lang.Object

com.broadleafcommerce.catalog.web.endpoint.AdvancedTagEndpoint

@FrameworkRestController
@FrameworkMapping("/tags")
@DataRouteByExample(AdvancedTag.class)
public class AdvancedTagEndpoint
extends Object

CRUD operations for Tags.

Author:

Nathan Moore (nathandmoore)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
AdvancedTagEndpoint(AdvancedTagService<AdvancedTag> tagService, com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Summary

Modifier and Type	Method	Description
AdvancedTag	createTag(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, AdvancedTag req)
org.springframework.http.ResponseEntity<Void>	deleteTag(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
protected AdvancedTagService<AdvancedTag>	getTagService()
protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation>	getTranslationEntityService()
org.springframework.data.domain.Page<AdvancedTag>	readAllTags(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String query, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
AdvancedTag	readTagById(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String tagId)
com.broadleafcommerce.translation.service.dto.TranslationsPayload	replaceAllTagTranslations(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)
AdvancedTag	replaceTag(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, AdvancedTag req)
AdvancedTag	updateTag(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, AdvancedTag 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

AdvancedTagEndpoint

public AdvancedTagEndpoint(AdvancedTagService<AdvancedTag> tagService,
 com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Details

readAllTags

@FrameworkGetMapping
@Policy(permissionRoots="ADVANCED_TAG")
public org.springframework.data.domain.Page<AdvancedTag> readAllTags(@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)

readTagById

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="ADVANCED_TAG")
public AdvancedTag readTagById(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String tagId)

updateTag

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

replaceTag

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

createTag

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

deleteTag

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

replaceAllTagTranslations

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

getTagService

protected AdvancedTagService<AdvancedTag> getTagService()

getTranslationEntityService

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