Package com.broadleafcommerce.catalog.web.endpoint

Class BusinessTypeEndpoint

java.lang.Object

com.broadleafcommerce.catalog.web.endpoint.BusinessTypeEndpoint

@FrameworkRestController
@FrameworkMapping("/product-types")
@DataRouteByExample(BusinessType.class)
public class BusinessTypeEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
BusinessTypeEndpoint(BusinessTypeService<BusinessType> businessTypeService, com.broadleafcommerce.common.extension.TypeFactory typeFactory, org.springframework.context.MessageSource messageSource)

Method Summary

Modifier and Type	Method	Description
BusinessType	createBusinessType(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, BusinessType businessType)
org.springframework.http.ResponseEntity<Void>	deleteBusinessType(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
protected BusinessTypeService<BusinessType>	getBusinessTypeService()
protected org.springframework.context.MessageSource	getMessageSource()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
org.springframework.data.domain.Page<BusinessType>	readAllBusinessTypes(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String query, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
List<BusinessType>	readAllBusinessTypesIncludingDefaults(boolean includeDefaults, boolean includeTemplates, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
Map<String,List<String>>	readAllBusinessTypesWithComponentMappings(com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
BusinessType	readBusinessTypeById(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String businessTypeId)
BusinessType	replaceBusinessType(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, BusinessType businessType)
BusinessType	updateBusinessType(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, BusinessType businessType)

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

BusinessTypeEndpoint

public BusinessTypeEndpoint(BusinessTypeService<BusinessType> businessTypeService,
 com.broadleafcommerce.common.extension.TypeFactory typeFactory,
 org.springframework.context.MessageSource messageSource)

Method Details

readAllBusinessTypes

@FrameworkGetMapping
@Policy(permissionRoots="PRODUCT_BUSINESS_TYPE")
public org.springframework.data.domain.Page<BusinessType> readAllBusinessTypes(@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)

readBusinessTypeById

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="PRODUCT_BUSINESS_TYPE")
public BusinessType readBusinessTypeById(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PathVariable("id")
 String businessTypeId)

createBusinessType

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="PRODUCT_BUSINESS_TYPE")
public BusinessType createBusinessType(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @RequestBody
 BusinessType businessType)

updateBusinessType

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

replaceBusinessType

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

deleteBusinessType

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

readAllBusinessTypesIncludingDefaults

@FrameworkGetMapping(params={"includeDefaults","includeTemplates"})
@Policy(permissionRoots="PRODUCT_BUSINESS_TYPE")
public List<BusinessType> readAllBusinessTypesIncludingDefaults(@RequestParam(value="includeDefaults",required=false)
 boolean includeDefaults,
 @RequestParam(value="includeTemplates",required=false)
 boolean includeTemplates,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

readAllBusinessTypesWithComponentMappings

@FrameworkGetMapping("/component-mappings")
@Policy(permissionRoots="PRODUCT_BUSINESS_TYPE")
public Map<String,List<String>> readAllBusinessTypesWithComponentMappings(@ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context)

getBusinessTypeService

protected BusinessTypeService<BusinessType> getBusinessTypeService()

getTypeFactory

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

getMessageSource

protected org.springframework.context.MessageSource getMessageSource()