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

Class FieldDefinitionEndpoint

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

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static String BASE_URI  

    • 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

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      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 FieldDefinitionService<com.broadleafcommerce.search.api.domain.FieldDefinition> getFieldDefinitionService()  
      protected com.broadleafcommerce.translation.service.TranslationEntityService<com.broadleafcommerce.translation.domain.Translation> getTranslationEntityService()  
      org.springframework.data.domain.Page<com.broadleafcommerce.search.api.domain.FieldDefinition> readAllFieldDefinitions​(com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo, String query, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page)  
      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)  

    • Constructor Detail

      • FieldDefinitionEndpoint

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

    • Method Detail

      • 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,
                                                                                                                             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)

      • getFieldDefinitionService

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

      • getTranslationEntityService

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