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

Class SynonymEndpoint

java.lang.Object

com.broadleafcommerce.search.core.web.endpoint.SynonymEndpoint

@FrameworkRestController
@FrameworkMapping("/synonyms/{indexableType}")
@DataRouteByKey("search")
public class SynonymEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
static final String	BASE_URI

Constructor Summary

Constructors

Constructor	Description
SynonymEndpoint(SynonymService synonymService)

Method Summary

Modifier and Type	Method	Description
List<Synonym>	addSynonyms(String indexableType, List<Synonym> synonyms, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteSynonym(String indexableType, String word, String synonym, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteSynonyms(String indexableType, String word, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected SynonymService	getSynonymService()
List<Synonym>	readAllSynonyms(String indexableType, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
Synonym	readSynonym(String indexableType, String word, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
Synonym	updateSynonym(String indexableType, String word, Synonym synonym, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
protected Locale	validateLocale(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

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

SynonymEndpoint

public SynonymEndpoint(@Autowired(required=false)
 SynonymService synonymService)

Method Details

readAllSynonyms

@FrameworkGetMapping
@Policy(permissionRoots="FIELD",
        operationTypes=READ)
public List<Synonym> readAllSynonyms(@PathVariable
 String indexableType,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readSynonym

@FrameworkGetMapping("/{word}")
@Policy(permissionRoots="FIELD",
        operationTypes=READ)
public Synonym readSynonym(@PathVariable
 String indexableType,
 @PathVariable
 String word,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

addSynonyms

@FrameworkPostMapping
@Policy(permissionRoots="FIELD",
        operationTypes={CREATE,UPDATE})
public List<Synonym> addSynonyms(@PathVariable
 String indexableType,
 @RequestBody
 List<Synonym> synonyms,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

updateSynonym

@FrameworkPutMapping("/{word}")
@FrameworkPatchMapping("/{word}")
@Policy(permissionRoots="FIELD",
        operationTypes={UPDATE,CREATE})
public Synonym updateSynonym(@PathVariable
 String indexableType,
 @PathVariable
 String word,
 @RequestBody
 Synonym synonym,
 @ContextOperation
 com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteSynonym

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

deleteSynonyms

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

validateLocale

protected Locale validateLocale(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

getSynonymService

protected SynonymService getSynonymService()