Package com.broadleafcommerce.search.core.service.facetgroup

Interface FacetGroupService<P extends com.broadleafcommerce.search.api.domain.FacetGroup>

All Superinterfaces:
com.broadleafcommerce.data.tracking.core.service.CrudEntityService<P>, com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>
All Known Implementing Classes:
DefaultFacetGroupService
public interface FacetGroupService<P extends com.broadleafcommerce.search.api.domain.FacetGroup> extends com.broadleafcommerce.data.tracking.core.service.RsqlCrudEntityService<P>

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getRepositoryDomain()
    Returns the name of the repository domain corresponding to the projection domain.
    org.springframework.data.domain.Page<P>
    readAllByName(String label, cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable page, com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
    Retrieves a page of facets by name
    Optional<P>
    readByContextIdAndNotArchived(String contextId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Reads the non-archived facet group by its context ID

    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<P> readAllByName(@Nullable String label, @Nullable cz.jirutka.rsql.parser.ast.Node filters, @Nullable org.springframework.data.domain.Pageable page, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo context)
      Retrieves a page of facets by name
      Parameters:
      label - the label field being queried
      filters - additional filters to apply in the query.
      page - describes the page of results to return
      context - context information around sandbox and multitenant state
      Returns:
      a paged list of facets matching the label string

    • readByContextIdAndNotArchived

      Optional<P> readByContextIdAndNotArchived(String contextId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads the non-archived facet group by its context ID
      Parameters:
      contextId - the contextId to filter on
      contextInfo - context information around sandbox and multitenant state
      Returns:
      the non-archived facet group, if it exists

    • getRepositoryDomain

      String getRepositoryDomain()
      Returns the name of the repository domain corresponding to the projection domain.
      Returns:
      The name of the repository domain corresponding to the projection domain.