org.seedstack.crud.rest

Interface ReadResource<A extends AggregateRoot<I>,I,D>

Type Parameters:

A - the aggregate root type.

I - the aggregate root identifier type.

D - the representation type.

All Superinterfaces:

Resource<A,I,D>

All Known Implementing Classes:

BaseCrudResource

public interface ReadResource<A extends AggregateRoot<I>,I,D>
extends Resource<A,I,D>

Specialization of Resource for reading aggregates (the R of CRUD).

See Also:

CreateResource, ReadResource, UpdateResource, DeleteResource, Resource

Method Summary

Modifier and Type	Method and Description
default <S extends Slice<A>> SpecificationPicker<S,A>	applyLimit(PaginationParams params, LimitPicker<S,A> limitPicker) Apply a pagination limit if present in the given pagination parameters.
default D	get(I id) The method that implements REST aggregate retrieval.
default Object	list(PaginationParams paginationParams, SortParams sortParams) The method that implements REST aggregate listing.

Methods inherited from interface org.seedstack.crud.rest.Resource

buildAggregateName, getAggregateRootClass, getFluentAssembler, getIdentifierClass, getPaginator, getRepository, getRepresentationClass

Method Detail

applyLimit

default <S extends Slice<A>> SpecificationPicker<S,A> applyLimit(@BeanParam
                                                                 PaginationParams params,
                                                                 LimitPicker<S,A> limitPicker)

Apply a pagination limit if present in the given pagination parameters.

Type Parameters:

S - the type of the paginated result.

Parameters:

params - the pagination parameters.

limitPicker - the Paginator DSL element to apply the limit to.

Returns:

the Paginator DSL element to continue with.

get

@GET
 @Produces(value="application/json")
 @Path(value="/{id}")
default D get(@PathParam(value="id")
                                                                              I id)

The method that implements REST aggregate retrieval.

Parameters:

id - the identifier of the aggregate to retrieve, passed as /{id} path parameter. If the identifier type is a complex object, it must have a constructor taking a single String parameter.

Returns:

the representation of the retrieved aggregate.

list

@GET
 @Produces(value="application/json")
default Object list(@BeanParam
                                                              PaginationParams paginationParams,
                                                              @BeanParam
                                                              SortParams sortParams)

The method that implements REST aggregate listing. Supports pagination through PaginationParams query parameters.

Parameters:

paginationParams - the optional pagination parameters.

sortParams - the optional sorting parameters.

Returns:

the serialized stream of aggregates, enveloped in a pagination wrapper if necessary.