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

Class RelevancyRuleGroupEndpoint

java.lang.Object

com.broadleafcommerce.search.core.web.endpoint.RelevancyRuleGroupEndpoint

@FrameworkRestController
@FrameworkMapping("/relevancy-rule-groups")
@DataRouteByKey("search")
public class RelevancyRuleGroupEndpoint
extends Object

Endpoint for RelevancyRuleGroup and RelevancyRuleGroupRule

Since:

Search Service 2.2.0, Release Train 2.2.0

Author:

karanjariwala

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI
static final String	GROUP_INDEXABLE_TYPE
static final String	RELEVANCY_RULE_GROUP_PERMISSION
static final String	RELEVANCY_RULES_BY_RELEVANCY_RULE_GROUP_ID_BASE_URI
static final String	STRING_EQUALS

Constructor Summary

Constructors

Constructor

Description

RelevancyRuleGroupEndpoint(RelevancyRuleGroupService<com.broadleafcommerce.search.api.domain.RelevancyRuleGroup> relevancyRuleGroupService, RelevancyRuleService<com.broadleafcommerce.search.api.domain.RelevancyRule> relevancyRuleService, RelevancyRuleGroupRuleService<com.broadleafcommerce.search.api.domain.RelevancyRuleGroupRule> relevancyRuleGroupRuleService, 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	applyGroupIndexableTypeFilters(String groupIndexableType, cz.jirutka.rsql.parser.ast.Node filters)
com.broadleafcommerce.search.api.domain.RelevancyRuleGroupRule	createRelevancyRuleForRelevancyRuleGroup(String id, com.broadleafcommerce.search.api.domain.RelevancyRuleGroupRule relevancyRuleGroupRule, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.search.api.domain.RelevancyRuleGroup	createRelevancyRuleGroup(com.broadleafcommerce.search.api.domain.RelevancyRuleGroup relevancyRuleGroup, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteRelevancyRuleForRelevancyRuleGroup(String id, String relevancyRuleGroupRuleId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteRelevancyRuleGroup(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected com.broadleafcommerce.data.tracking.core.filtering.fetch.FilterParser<cz.jirutka.rsql.parser.ast.Node>	getParser()
protected RelevancyRuleGroupRuleService<com.broadleafcommerce.search.api.domain.RelevancyRuleGroupRule>	getRelevancyRuleGroupRuleService()
protected RelevancyRuleGroupService<com.broadleafcommerce.search.api.domain.RelevancyRuleGroup>	getRelevancyRuleGroupService()
protected RelevancyRuleService<com.broadleafcommerce.search.api.domain.RelevancyRule>	getRelevancyRuleService()
protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation>	getTranslationEntityService()
org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.RelevancyRuleGroup>	readAllRelevancyRuleGroups(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String query, String groupIndexableType, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)
com.broadleafcommerce.search.api.domain.RelevancyRuleGroup	readRelevancyRuleGroupById(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.RelevancyRuleGroupRule>	readRelevancyRulesForRelevancyRuleGroup(String id, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.translation.service.dto.TranslationsPayload	replaceAllRelevancyRuleGroupTranslations(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id, Locale locale, com.broadleafcommerce.translation.service.dto.TranslationsPayload translationRequest)
com.broadleafcommerce.search.api.domain.RelevancyRuleGroup	replaceRelevancyRuleGroup(com.broadleafcommerce.search.api.domain.RelevancyRuleGroup relevancyRuleGroup, 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)

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

RELEVANCY_RULES_BY_RELEVANCY_RULE_GROUP_ID_BASE_URI

public static final String RELEVANCY_RULES_BY_RELEVANCY_RULE_GROUP_ID_BASE_URI

See Also:

• Constant Field Values

RELEVANCY_RULE_GROUP_PERMISSION

public static final String RELEVANCY_RULE_GROUP_PERMISSION

See Also:

• Constant Field Values

STRING_EQUALS

public static final String STRING_EQUALS

See Also:

• Constant Field Values

GROUP_INDEXABLE_TYPE

public static final String GROUP_INDEXABLE_TYPE

See Also:

• Constant Field Values

Constructor Details

RelevancyRuleGroupEndpoint

public RelevancyRuleGroupEndpoint(RelevancyRuleGroupService<com.broadleafcommerce.search.api.domain.RelevancyRuleGroup> relevancyRuleGroupService,
 RelevancyRuleService<com.broadleafcommerce.search.api.domain.RelevancyRule> relevancyRuleService,
 RelevancyRuleGroupRuleService<com.broadleafcommerce.search.api.domain.RelevancyRuleGroupRule> relevancyRuleGroupRuleService,
 com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> translationEntityService)

Method Details

readAllRelevancyRuleGroups

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

readRelevancyRuleGroupById

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

createRelevancyRuleGroup

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="RELEVANCY_RULE_GROUP",
        operationTypes=CREATE)
public com.broadleafcommerce.search.api.domain.RelevancyRuleGroup createRelevancyRuleGroup(@RequestBody
 com.broadleafcommerce.search.api.domain.RelevancyRuleGroup relevancyRuleGroup,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteRelevancyRuleGroup

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

replaceRelevancyRuleGroup

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

readRelevancyRulesForRelevancyRuleGroup

@FrameworkGetMapping("/{id}/relevancy-rules")
@Policy(permissionRoots="RELEVANCY_RULE_GROUP",
        operationTypes=READ)
public org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.RelevancyRuleGroupRule> readRelevancyRulesForRelevancyRuleGroup(@PathVariable("id")
 String id,
 cz.jirutka.rsql.parser.ast.Node filters,
 @PageableDefault(size=50)
 org.springframework.data.domain.Pageable page,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

createRelevancyRuleForRelevancyRuleGroup

@FrameworkPostMapping("/{id}/relevancy-rules")
@Policy(permissionRoots="RELEVANCY_RULE_GROUP",
        operationTypes=CREATE)
public com.broadleafcommerce.search.api.domain.RelevancyRuleGroupRule createRelevancyRuleForRelevancyRuleGroup(@PathVariable("id")
 String id,
 @RequestBody
 com.broadleafcommerce.search.api.domain.RelevancyRuleGroupRule relevancyRuleGroupRule,
 @ContextOperation(CREATE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteRelevancyRuleForRelevancyRuleGroup

@FrameworkDeleteMapping("/{id}/relevancy-rules/{relevancyRuleGroupRuleId}")
@Policy(permissionRoots="RELEVANCY_RULE_GROUP",
        operationTypes=DELETE)
public void deleteRelevancyRuleForRelevancyRuleGroup(@PathVariable("id")
 String id,
 @PathVariable("relevancyRuleGroupRuleId")
 String relevancyRuleGroupRuleId,
 @ContextOperation(DELETE)
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

replaceAllRelevancyRuleGroupTranslations

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

applyGroupIndexableTypeFilters

@NonNull
protected cz.jirutka.rsql.parser.ast.Node applyGroupIndexableTypeFilters(String groupIndexableType,
 cz.jirutka.rsql.parser.ast.Node filters)

getRelevancyRuleGroupService

protected RelevancyRuleGroupService<com.broadleafcommerce.search.api.domain.RelevancyRuleGroup> getRelevancyRuleGroupService()

getRelevancyRuleService

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

getRelevancyRuleGroupRuleService

protected RelevancyRuleGroupRuleService<com.broadleafcommerce.search.api.domain.RelevancyRuleGroupRule> getRelevancyRuleGroupRuleService()

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)