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

Class RelevancyRuleEndpoint

java.lang.Object

com.broadleafcommerce.search.core.web.endpoint.RelevancyRuleEndpoint

@FrameworkRestController
@FrameworkMapping("/relevancy-rules")
@DataRouteByKey("search")
public class RelevancyRuleEndpoint
extends Object

Since:

Search Service 2.2.0, Release Train 2.2.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
static final String	FIELD_INDEXABLE_TYPE
static final String	RELEVANCY_RULE_PERMISSION
static final String	STRING_EQUALS

Constructor Summary

Constructors

Constructor	Description
RelevancyRuleEndpoint(RelevancyRuleService<com.broadleafcommerce.search.api.domain.RelevancyRule> relevancyRuleService, 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	applyFieldIndexableTypeFilters(String fieldIndexableType, cz.jirutka.rsql.parser.ast.Node filters)
protected com.broadleafcommerce.search.api.domain.FieldRef	buildFieldRef(com.broadleafcommerce.search.api.domain.FieldDefinition field)
com.broadleafcommerce.search.api.domain.RelevancyRule	createRelevancyRule(com.broadleafcommerce.search.api.domain.RelevancyRule relevancyRule, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteRelevancyRule(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
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 RelevancyRuleService<com.broadleafcommerce.search.api.domain.RelevancyRule>	getRelevancyRuleService()
protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation>	getTranslationEntityService()
protected com.broadleafcommerce.common.extension.TypeFactory	getTypeFactory()
org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.RelevancyRule>	readAllRelevancyRules(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String query, String fieldIndexableType, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
com.broadleafcommerce.search.api.domain.RelevancyRule	readRelevancyRuleById(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.translation.service.dto.TranslationsPayload	replaceAllRelevancyRuleTranslations(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)
com.broadleafcommerce.search.api.domain.RelevancyRule	replaceRelevancyRule(com.broadleafcommerce.search.api.domain.RelevancyRule relevancyRule, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)
void	setParser(com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node> parser)
void	setTypeFactory(com.broadleafcommerce.common.extension.TypeFactory typeFactory)

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

FIELD_INDEXABLE_TYPE

public static final String FIELD_INDEXABLE_TYPE

See Also:

• Constant Field Values

RELEVANCY_RULE_PERMISSION

public static final String RELEVANCY_RULE_PERMISSION

See Also:

• Constant Field Values

Constructor Details

RelevancyRuleEndpoint

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

Method Details

readAllRelevancyRules

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

readRelevancyRuleById

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

createRelevancyRule

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="RELEVANCY_RULE",
        operationTypes=CREATE)
public com.broadleafcommerce.search.api.domain.RelevancyRule createRelevancyRule(@RequestBody
 com.broadleafcommerce.search.api.domain.RelevancyRule relevancyRule,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteRelevancyRule

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

replaceRelevancyRule

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

replaceAllRelevancyRuleTranslations

@FrameworkPutMapping(value="/{id}/translations/{locale}",
                     consumes="application/json")
@Policy(permissionRoots="RELEVANCY_RULE",
        operationTypes=UPDATE)
public com.broadleafcommerce.translation.service.dto.TranslationsPayload replaceAllRelevancyRuleTranslations(@ContextOperation(UPDATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo,
 @PathVariable("id")
 String id,
 @PathVariable("locale")
 Locale locale,
 @RequestBody
 com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)

buildFieldRef

protected com.broadleafcommerce.search.api.domain.FieldRef buildFieldRef(com.broadleafcommerce.search.api.domain.FieldDefinition field)

applyFieldIndexableTypeFilters

@NonNull
protected cz.jirutka.rsql.parser.ast.Node applyFieldIndexableTypeFilters(String fieldIndexableType,
 cz.jirutka.rsql.parser.ast.Node filters)

getRelevancyRuleService

protected RelevancyRuleService<com.broadleafcommerce.search.api.domain.RelevancyRule> getRelevancyRuleService()

getFieldDefinitionService

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

getTranslationEntityService

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

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)

getTypeFactory

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

setTypeFactory

@Autowired
public void setTypeFactory(com.broadleafcommerce.common.extension.TypeFactory typeFactory)