Package com.broadleafcommerce.search.core.web.endpoint

Class FieldDefinitionEndpoint

java.lang.Object

com.broadleafcommerce.search.core.web.endpoint.FieldDefinitionEndpoint

@FrameworkRestController
@FrameworkMapping("/fields")
@DataRouteByKey("search")
public class FieldDefinitionEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
static final String	INDEXABLE_TYPE
static final String	STRING_EQUALS

Constructor Summary

Constructors

Constructor	Description
FieldDefinitionEndpoint(FieldDefinitionService<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitionService, com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Summary

Modifier and Type	Method	Description
protected cz.jirutka.rsql.parser.ast.Node	applyIndexableTypeFilters(String indexableType, cz.jirutka.rsql.parser.ast.Node filters)
com.broadleafcommerce.search.api.domain.FieldDefinition	createFieldDefinition(com.broadleafcommerce.search.api.domain.FieldDefinition field, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteFieldDefinition(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected FacetService<com.broadleafcommerce.search.api.domain.Facet>	getFacetService()
protected FieldDefinitionService<com.broadleafcommerce.search.api.domain.FieldDefinition>	getFieldDefinitionService()
protected com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node>	getParser()
protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation>	getTranslationEntityService()
org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.Facet>	readAllFacetsForFieldDefinition(String id, 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<com.broadleafcommerce.search.api.domain.FieldDefinition>	readAllFieldDefinitions(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String query, String indexableType, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
List<com.broadleafcommerce.search.api.domain.FieldVariant>	readAllFieldVariants(String id, boolean onlyVariantsIncludedInSearchResponse, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<com.broadleafcommerce.search.api.domain.FieldDefinition>	readByIndexableType(String type, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.search.api.domain.FieldDefinition	readFieldDefinitionById(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.translation.service.dto.TranslationsPayload	replaceAllFieldTranslations(com.broadleafcommerce.data.tracking.core.context.ContextInfo context, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)
com.broadleafcommerce.search.api.domain.FieldDefinition	replaceFieldDefinition(com.broadleafcommerce.search.api.domain.FieldDefinition field, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
void	setFacetService(FacetService<com.broadleafcommerce.search.api.domain.Facet> facetService)
void	setParser(com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> parser)

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

STRING_EQUALS

public static final String STRING_EQUALS

See Also:

• Constant Field Values

INDEXABLE_TYPE

public static final String INDEXABLE_TYPE

See Also:

• Constant Field Values

Constructor Details

FieldDefinitionEndpoint

public FieldDefinitionEndpoint(FieldDefinitionService<com.broadleafcommerce.search.api.domain.FieldDefinition> fieldDefinitionService,
 com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Details

readAllFieldDefinitions

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

readFieldDefinitionById

@FrameworkGetMapping("/{id}")
@Policy(permissionRoots="FIELD",
        operationTypes=READ)
public com.broadleafcommerce.search.api.domain.FieldDefinition readFieldDefinitionById(@PathVariable("id")
 String id,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

createFieldDefinition

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="FIELD",
        operationTypes=CREATE)
public com.broadleafcommerce.search.api.domain.FieldDefinition createFieldDefinition(@RequestBody
 com.broadleafcommerce.search.api.domain.FieldDefinition field,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteFieldDefinition

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

replaceFieldDefinition

@FrameworkPutMapping(value="/{id}",
                     consumes="application/json")
@Policy(permissionRoots="FIELD",
        operationTypes=UPDATE)
public com.broadleafcommerce.search.api.domain.FieldDefinition replaceFieldDefinition(@RequestBody
 com.broadleafcommerce.search.api.domain.FieldDefinition field,
 @ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id)

readByIndexableType

@FrameworkGetMapping("/type/{type}")
@Policy(permissionRoots="FIELD",
        operationTypes=READ)
public List<com.broadleafcommerce.search.api.domain.FieldDefinition> readByIndexableType(@PathVariable("type")
 String type,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

replaceAllFieldTranslations

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

readAllFieldVariants

@FrameworkGetMapping("/{id}/variants")
@Policy(permissionRoots="FIELD",
        operationTypes=READ)
public List<com.broadleafcommerce.search.api.domain.FieldVariant> readAllFieldVariants(@PathVariable("id")
 String id,
 @RequestParam(value="onlyVariantsIncludedInSearchResponse",required=false)
 boolean onlyVariantsIncludedInSearchResponse,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readAllFacetsForFieldDefinition

@FrameworkGetMapping("/{id}/facets")
@Policy(permissionRoots="FACET",
        operationTypes=READ)
public org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.Facet> readAllFacetsForFieldDefinition(@PathVariable("id")
 String id,
 @Nullable
 cz.jirutka.rsql.parser.ast.Node filters,
 @Nullable
 org.springframework.data.domain.Pageable page,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

applyIndexableTypeFilters

@NonNull
protected cz.jirutka.rsql.parser.ast.Node applyIndexableTypeFilters(String indexableType,
 cz.jirutka.rsql.parser.ast.Node filters)

getFieldDefinitionService

protected FieldDefinitionService<com.broadleafcommerce.search.api.domain.FieldDefinition> getFieldDefinitionService()

getTranslationEntityService

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

setFacetService

@Autowired
public void setFacetService(FacetService<com.broadleafcommerce.search.api.domain.Facet> facetService)

getFacetService

protected FacetService<com.broadleafcommerce.search.api.domain.Facet> getFacetService()

getParser

protected com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> getParser()

setParser

@Autowired
public void setParser(com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> parser)