Package com.broadleafcommerce.search.core.service.facetgroupfacet

Interface FacetGroupFacetService<P extends com.broadleafcommerce.search.api.domain.FacetGroupFacet>

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

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    existsByJoinedIds(String facetId, String facetGroupId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Returns whether there is a facet group/facet relationship for the given facet and facet group in the data store.
    boolean
    hasNonProductionRecordsByFacetIdsInTenant(Collection<String> facetIds, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Returns true if there is non-production FacetGroupFacet that match the given facetIds and the given context.
    List<P>
    readAllByFacetGroupId(String facetGroupContextId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Reads all FacetGroupFacet relationships associated with the given FacetGroup ID.
    List<P>
    readAllByFacetId(String facetId, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Reads all FacetGroupFacet relationships associated with the given Facet ID.
    org.springframework.data.domain.Page<P>
    readByFacetGroupContextId(String facetGroupContextId, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Reads a page of FacetGroupFacet relationships associated with the given FacetGroup ID.
    org.springframework.data.domain.Page<P>
    readByFacetGroupContextIdAndIsSorted(String facetGroupContextId, Boolean isSorted, org.springframework.data.domain.Pageable page, cz.jirutka.rsql.parser.ast.Node filters, com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
    Reads a page of FacetGroupFacet relationships associated with the given FacetGroup 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

    • readByFacetGroupContextId

      org.springframework.data.domain.Page<P> readByFacetGroupContextId(String facetGroupContextId, @Nullable org.springframework.data.domain.Pageable page, @Nullable cz.jirutka.rsql.parser.ast.Node filters, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads a page of FacetGroupFacet relationships associated with the given FacetGroup ID.
      Parameters:
      facetGroupContextId - the facet group ID to filter on
      page - the requested page of results from the database
      filters - additional filters to apply in the query. Should be EmptyNode if no additional filters should be applied.
      contextInfo - context surrounding sandboxing and multitenant state
      Returns:
      a page of FacetGroupFacet relationships associated with the given FacetGroup ID

    • readByFacetGroupContextIdAndIsSorted

      org.springframework.data.domain.Page<P> readByFacetGroupContextIdAndIsSorted(String facetGroupContextId, @Nullable Boolean isSorted, @Nullable org.springframework.data.domain.Pageable page, @Nullable cz.jirutka.rsql.parser.ast.Node filters, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads a page of FacetGroupFacet relationships associated with the given FacetGroup ID.
      Parameters:
      facetGroupContextId - the facet group ID to filter on
      isSorted - Whether to read only FacetGroupFacet that have a sort value.
      page - the requested page of results from the database
      filters - additional filters to apply in the query. Should be EmptyNode if no additional filters should be applied.
      contextInfo - context surrounding sandboxing and multitenant state
      Returns:
      a page of FacetGroupFacet relationships associated with the given FacetGroup ID

    • readAllByFacetGroupId

      List<P> readAllByFacetGroupId(String facetGroupContextId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads all FacetGroupFacet relationships associated with the given FacetGroup ID.
      Parameters:
      facetGroupContextId - the facet group ID to filter on
      contextInfo - context surrounding sandboxing and multitenant state
      Returns:
      All FacetGroupFacet relationships associated with the given FacetGroup ID

    • existsByJoinedIds

      boolean existsByJoinedIds(String facetId, String facetGroupId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Returns whether there is a facet group/facet relationship for the given facet and facet group in the data store.
      Parameters:
      facetId - the facet context ID
      facetGroupId - the facet group context ID
      contextInfo - context surrounding sandboxing and multitenant state
      Returns:
      true if a relationship was found between the facet and facet group, false otherwise

    • readAllByFacetId

      List<P> readAllByFacetId(String facetId, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Reads all FacetGroupFacet relationships associated with the given Facet ID.
      Parameters:
      facetId - the facet ID to filter on
      contextInfo - context surrounding sandboxing and multitenant state
      Returns:
      All FacetGroupFacet relationships associated with the given Facet ID
      Since:
      Search Service 2.1.4, Release Train 2.1.4, Search Service 2.2.0, Release Train 2.2.0

    • hasNonProductionRecordsByFacetIdsInTenant

      boolean hasNonProductionRecordsByFacetIdsInTenant(Collection<String> facetIds, @Nullable com.broadleafcommerce.data.tracking.core.context.ContextInfo contextInfo)
      Returns true if there is non-production FacetGroupFacet that match the given facetIds and the given context.
      Parameters:
      facetIds - IDs of the Facet to match against
      contextInfo - Request context information around sandbox and multitenant state
      Returns:
      true if there is non-production records that match the given facetIds and the given context, and false otherwise
      Since:
      Search Service 2.1.4, Release Train 2.1.4, Search Service 2.2.0, Release Train 2.2.0