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

Class TypeAheadEndpoint

java.lang.Object

com.broadleafcommerce.search.core.web.endpoint.TypeAheadEndpoint

@FrameworkRestController
@FrameworkMapping("/type-ahead")
@DataRouteByKey("search")
public class TypeAheadEndpoint
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
protected TypeAheadConfigurationService<com.broadleafcommerce.search.api.domain.TypeAheadConfiguration>	configurationService
protected static String	TYPE_AHEAD_ENDPOINT

Constructor Summary

Constructors

Constructor	Description
TypeAheadEndpoint(TypeAheadConfigurationService<com.broadleafcommerce.search.api.domain.TypeAheadConfiguration> configurationService)

Method Summary

Modifier and Type	Method	Description
com.broadleafcommerce.search.api.domain.TypeAheadConfiguration	createConfiguration(com.broadleafcommerce.search.api.domain.TypeAheadConfiguration configuration, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
void	deleteConfiguration(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
List<com.broadleafcommerce.search.api.domain.TypeAheadConfiguration>	readAllConfigurations(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.search.api.domain.TypeAheadConfiguration	readConfigurationById(String id, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
com.broadleafcommerce.search.api.domain.TypeAheadConfiguration	replaceConfiguration(com.broadleafcommerce.search.api.domain.TypeAheadConfiguration configuration, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String id)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TYPE_AHEAD_ENDPOINT

protected static final String TYPE_AHEAD_ENDPOINT

See Also:

Constant Field Values

configurationService

protected final TypeAheadConfigurationService<com.broadleafcommerce.search.api.domain.TypeAheadConfiguration> configurationService

Constructor Detail

TypeAheadEndpoint

public TypeAheadEndpoint(TypeAheadConfigurationService<com.broadleafcommerce.search.api.domain.TypeAheadConfiguration> configurationService)

Method Detail

readAllConfigurations

@FrameworkGetMapping
@Policy(permissionRoots="TYPE_AHEAD",
        operationTypes=READ)
public List<com.broadleafcommerce.search.api.domain.TypeAheadConfiguration> readAllConfigurations(@ContextOperation
                                                                                                  com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

readConfigurationById

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

createConfiguration

@FrameworkPostMapping(consumes="application/json")
@Policy(permissionRoots="TYPE_AHEAD",
        operationTypes=CREATE)
public com.broadleafcommerce.search.api.domain.TypeAheadConfiguration createConfiguration(@RequestBody
                                                                                          com.broadleafcommerce.search.api.domain.TypeAheadConfiguration configuration,
                                                                                          @ContextOperation(CREATE)
                                                                                          com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)

deleteConfiguration

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

replaceConfiguration

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