Package com.broadleafcommerce.data.tracking.core.service

Interface MappableRsqlFilterExecutor<D>

  • All Superinterfaces:
    com.broadleafcommerce.common.extension.DomainTypeAware
    public interface MappableRsqlFilterExecutor<D>
extends com.broadleafcommerce.common.extension.DomainTypeAware
    Marker interface to indicate that a PagingAndSortingRepository can also handle RSQL-based query methods. This version is intended for domain that is mapped, but not tracked. See TrackableRsqlFilterExecutor for handling of Trackable domain.
    Author:
    Jeff Fischer
    See Also:
    TrackableRsqlFilterExecutor

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean exists​(cz.jirutka.rsql.parser.ast.Node filters)
      Checks whether the data store contains elements that match the given Node.
      List<D> findAll​(cz.jirutka.rsql.parser.ast.Node filters)
      Retrieve all domain instances using an RSQL Node to restrict results.
      org.springframework.data.domain.Page<D> findAll​(cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable)
      Retrieve all domain instances using an RSQL Node to restrict results.
      List<D> findAll​(cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Sort sort)
      Retrieve all domain instances using an RSQL Node to restrict results.
      org.springframework.data.domain.Page<D> findAll​(cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Sort sort, org.springframework.data.domain.Pageable pageable)
      Retrieve all domain instances using an RSQL Node to restrict results.

      • Methods inherited from interface com.broadleafcommerce.common.extension.DomainTypeAware

        getDomainType

    • Method Detail

      • findAll

        @Policy(operationTypes=READ)
List<D> findAll​(@NonNull
                cz.jirutka.rsql.parser.ast.Node filters)

        Retrieve all domain instances using an RSQL Node to restrict results. If no matches were found an empty List is returned

        Parameters:
        filters - the RSQL Node used to restrict result, must not be null
        Returns:
        The list of narrowed entities or an empty result if none were found
        See Also:
        RSQLFilterParser

      • findAll

        @Policy(operationTypes=READ)
List<D> findAll​(@NonNull
                cz.jirutka.rsql.parser.ast.Node filters,
                org.springframework.data.domain.Sort sort)

        Retrieve all domain instances using an RSQL Node to restrict results. If no matches were found an empty List is returned

        This version also accepts a Spring Data version of a Sort to apply to the result set

        Parameters:
        filters - the RSQL Node used to restrict result, must not be null
        sorts - The string containing the structured list of sorts to apply
        Returns:
        The list of narrowed, sorted entities
        See Also:
        RSQLFilterParser

      • findAll

        @Policy(operationTypes=READ)
org.springframework.data.domain.Page<D> findAll​(@NonNull
                                                cz.jirutka.rsql.parser.ast.Node filters,
                                                org.springframework.data.domain.Pageable pageable)

        Retrieve all domain instances using an RSQL Node to restrict results. If no matches were found an empty Page is returned

        Parameters:
        filters - the RSQL Node used to restrict result, must not be null
        pageable - may be Pageable.unpaged(), must not be null.
        Returns:
        The subset (page) of narrowed entities

      • findAll

        @Policy(operationTypes=READ)
org.springframework.data.domain.Page<D> findAll​(@NonNull
                                                cz.jirutka.rsql.parser.ast.Node filters,
                                                org.springframework.data.domain.Sort sort,
                                                org.springframework.data.domain.Pageable pageable)

        Retrieve all domain instances using an RSQL Node to restrict results. If no matches were found an empty Page is returned

        This version also accepts a Spring Data version of a Sort to apply to the result set

        Parameters:
        filters - the RSQL Node used to restrict result, must not be null
        sort - The sort that should be applied to the results
        pageable - may be Pageable.unpaged(), must not be null.
        Returns:
        The subset (page) of narrowed entities

      • exists

        @Policy(operationTypes=READ)
boolean exists​(@NonNull
               cz.jirutka.rsql.parser.ast.Node filters)
        Checks whether the data store contains elements that match the given Node.
        Parameters:
        filters - the RSQL Node used to restrict result, must not be null
        Returns:
        true if the data store contains elements that match the given Node.