Interface RsqlMappableCrudEntityService<P>
-
- All Superinterfaces:
MappableCrudEntityService<P>
- All Known Implementing Classes:
BaseRsqlMappableCrudEntityService
public interface RsqlMappableCrudEntityService<P> extends MappableCrudEntityService<P>
RSQL-specific variant of theMappableCrudEntityService
. Allows results to be further restricted by an RSQL filter.- Author:
- Jeff Fischer
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description List<P>
readAll(cz.jirutka.rsql.parser.ast.Node filters)
Retrieve all domain instances using a structured query string to drive the query criteria.org.springframework.data.domain.Page<P>
readAll(cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Pageable pageable)
Retrieve all domain instances using a structured query string to drive the query criteria.List<P>
readAll(cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Sort sort)
Retrieve all domain instances using a structured query string to drive the query criteria.org.springframework.data.domain.Page<P>
readAll(cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Sort sort, org.springframework.data.domain.Pageable pageable)
Retrieve all domain instances using a structured query string to drive the query criteria.-
Methods inherited from interface com.broadleafcommerce.data.tracking.core.service.MappableCrudEntityService
create, createAll, createAllAllowingPartialSuccess, delete, readAll, readAll, readAll, readAllByIds, readById, replace, replaceAll, replaceAllAllowingPartialSuccess, update, updateAll, updateAllAllowingPartialSuccess
-
-
-
-
Method Detail
-
readAll
List<P> readAll(@NonNull cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Sort sort)
Retrieve all domain instances using a structured query string to drive the query criteria. The filters string is parsed by an internal implementation and the result is added to the query before executing the fetch against the persistence store. SeeFilterParser
for more information.This version also accepts a formatted sort string that declares the sorting characteristics for the query.
- Parameters:
filters
- the RSQLNode
used to restrict result, must not be nullsort
- The string containing the structured list of sorts to apply- Returns:
- The list of narrowed, sorted entities
-
readAll
List<P> readAll(@NonNull cz.jirutka.rsql.parser.ast.Node filters)
Retrieve all domain instances using a structured query string to drive the query criteria. The filters string is parsed by an internal implementation and the result is added to the query before executing the fetch against the persistence store. SeeFilterParser
for more information.- Parameters:
filters
- the RSQLNode
used to restrict result, must not be null- Returns:
- The list of narrowed, sorted entities
-
readAll
org.springframework.data.domain.Page<P> readAll(@NonNull cz.jirutka.rsql.parser.ast.Node filters, org.springframework.data.domain.Sort sort, @NonNull org.springframework.data.domain.Pageable pageable)
Retrieve all domain instances using a structured query string to drive the query criteria. The filters string is parsed by an internal implementation and the result is added to the query before executing the fetch against the persistence store. SeeFilterParser
for more information.This version also accepts a Sort to apply to the result set
- Parameters:
filters
- the RSQLNode
used to restrict result, must not be nullsort
- sort to apply to the querypageable
- may bePageable.unpaged()
, must not be null.- Returns:
- The subset (page) of narrowed entities
-
readAll
org.springframework.data.domain.Page<P> readAll(@NonNull cz.jirutka.rsql.parser.ast.Node filters, @NonNull org.springframework.data.domain.Pageable pageable)
Retrieve all domain instances using a structured query string to drive the query criteria. The filters string is parsed by an internal implementation and the result is added to the query before executing the fetch against the persistence store. SeeFilterParser
for more information.- Parameters:
filters
- the RSQLNode
used to restrict result, must not be nullpageable
- may bePageable.unpaged()
, must not be null.- Returns:
- The subset (page) of narrowed entities
-
-