Package com.broadleafcommerce.content.web.endpoint

Class CustomContentFieldEndpoint

java.lang.Object

com.broadleafcommerce.content.web.endpoint.CustomContentFieldEndpoint

@FrameworkRestController
@FrameworkMapping("/custom-content-fields")
@DataRouteByExample(CustomContentField.class)
public class CustomContentFieldEndpoint
extends Object

Author:

Jon Fleschler (jfleschler)

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
CustomContentFieldEndpoint(CustomContentFieldService<CustomContentField> fieldService)

Method Summary

Modifier and Type	Method	Description
CustomContentField	createCustomContentField(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, CustomContentField field)
org.springframework.http.ResponseEntity<Void>	deleteCustomContentField(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
protected CustomContentFieldService<CustomContentField>	getFieldService()
org.springframework.data.domain.Page<CustomContentField>	readAllCustomContentFields(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters)
CustomContentField	readCustomContentFieldById(jakarta.servlet.http.HttpServletRequest request, com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id)
CustomContentField	replaceCustomContentField(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, CustomContentField field)
CustomContentField	updateCustomContentField(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, CustomContentField field)

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

CustomContentFieldEndpoint

public CustomContentFieldEndpoint(CustomContentFieldService<CustomContentField> fieldService)

Method Details

readAllCustomContentFields

@Policy(permissionRoots="CONTENT")
@FrameworkGetMapping
public org.springframework.data.domain.Page<CustomContentField> readAllCustomContentFields(jakarta.servlet.http.HttpServletRequest request,
 @ContextOperation(READ)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo context,
 @PageableDefault(size=50,sort="name",direction=ASC)
 org.springframework.data.domain.Pageable page,
 cz.jirutka.rsql.parser.ast.Node filters)

readCustomContentFieldById

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

createCustomContentField

@Policy(permissionRoots="CONTENT")
@FrameworkPostMapping(consumes="application/json")
public CustomContentField createCustomContentField(@ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @RequestBody
 CustomContentField field)

replaceCustomContentField

@Policy(permissionRoots="CONTENT")
@FrameworkPutMapping(value="/{id}",
                     consumes="application/json")
public CustomContentField replaceCustomContentField(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id,
 @RequestBody
 CustomContentField field)

updateCustomContentField

@Policy(permissionRoots="CONTENT")
@FrameworkPatchMapping(value="/{id}",
                       consumes="application/json")
public CustomContentField updateCustomContentField(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id,
 @RequestBody
 CustomContentField field)

deleteCustomContentField

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

getFieldService

protected CustomContentFieldService<CustomContentField> getFieldService()