Package com.broadleafcommerce.search.core.service.relevancyrule

Interface RelevancyRuleService<R extends com.broadleafcommerce.search.api.domain.RelevancyRule>

All Superinterfaces:
com.broadleafcommerce.data.tracking.core.service.CrudEntityService<R>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<R>
All Known Implementing Classes:
DefaultRelevancyRuleService
public interface RelevancyRuleService<R extends com.broadleafcommerce.search.api.domain.RelevancyRule> extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<R>

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getRepositoryDomain()
    Get the name of the Jpa Domain representation of the object
    void
    hydrateFieldDefinitions(Iterable<R> relevancyRules, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Hydrates the full FieldDefinition on the provided relevancy-rules.
    List<R>
    readAllByFieldDefinitionIdIn(Iterable<String> fieldDefinitionIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Retrieves a list of relevancy rules for the provided field definition IDs
    List<R>
    readAllById(List<String> relevancyRuleIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Reads all non-archived relevancy rules by context ID
    org.springframework.data.domain.Page<R>
    readAllByName(String name, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Retrieves a paged list of relevancy-rules by name

    Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.CrudEntityService

    create, createAll, createAllAllowingPartialSuccess, delete, readAll, readAll, readAll, readAllByContextId, readByContextId, replace, replaceAll, replaceAllAllowingPartialSuccess, update, updateAll, updateAllAllowingPartialSuccess, updateSort

    Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService

    readAll, readAll, readAll, readAll

  • Method Details

    • readAllByName

      org.springframework.data.domain.Page<R> readAllByName(@Nullable String name, @Nullable cz.jirutka.rsql.parser.ast.Node filters, @Nullable org.springframework.data.domain.Pageable page, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Retrieves a paged list of relevancy-rules by name
      Parameters:
      name - the name field being queried
      filters - additional filters to apply in the query. Should be EmptyNode if no additional filters should be applied.
      page - the requested page of results from the database
      contextInfo - context information around sandbox and multitenant state
      Returns:
      a paged list of relevancy-rules from the underlying repository

    • hydrateFieldDefinitions

      void hydrateFieldDefinitions(Iterable<R> relevancyRules, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Hydrates the full FieldDefinition on the provided relevancy-rules.
      Parameters:
      relevancyRules - An Iterable<com.broadleafcommerce.search.api.domain.RelevancyRule>. Uses iterable to support taking Collections or Pages.
      contextInfo - Additional sandbox and multitenant info

    • readAllById

      List<R> readAllById(List<String> relevancyRuleIds, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads all non-archived relevancy rules by context ID
      Parameters:
      relevancyRuleIds - the list of relevancy rule ids to filter on
      contextInfo - context information around sandbox and multitenant state
      Returns:
      all non-archived relevancy rules by context ID

    • readAllByFieldDefinitionIdIn

      List<R> readAllByFieldDefinitionIdIn(Iterable<String> fieldDefinitionIds, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Retrieves a list of relevancy rules for the provided field definition IDs
      Parameters:
      fieldDefinitionIds - the field definition IDs to query on
      context - context information around sandbox and multitenant state
      Returns:
      a list of relevancy rules for the provided field definition IDs

    • getRepositoryDomain

      String getRepositoryDomain()
      Get the name of the Jpa Domain representation of the object
      Returns:
      the name of the Jpa Domain representation of the object