org.seedstack.crud.rest

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

Type Parameters:

A - the aggregate root type.

I - the aggregate root identifier type.

D - the representation type.

All Known Subinterfaces:

CreateResource<A,I,D>, DeleteResource<A,I,D>, ReadResource<A,I,D>, UpdateResource<A,I,D>

All Known Implementing Classes:

BaseCrudResource, BaseResource

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

Common interface shared by all CRUD-specialized interfaces.

See Also:

CreateResource, ReadResource, UpdateResource, DeleteResource

Method Summary

Modifier and Type	Method and Description
default String	buildAggregateName(I id) Builds the standardized name of the aggregate for a particular id.
Class<A>	getAggregateRootClass() Returns the aggregate root class managed by the resource.
FluentAssembler	getFluentAssembler() Returns the FluentAssembler implementation used by the resource.
Class<I>	getIdentifierClass() Returns the aggregate root identifier class managed by the resource.
Paginator	getPaginator() Returns the Paginator implementation used by the resource.
Repository<A,I>	getRepository() Returns the repository where to find aggregates managed by the resource.
Class<D>	getRepresentationClass() Returns the representation class managed by the resource.

Method Detail

buildAggregateName

default String buildAggregateName(I id)

Builds the standardized name of the aggregate for a particular id.

Parameters:

id - the aggregate identifier.

Returns:

the aggregate name.

getAggregateRootClass

Class<A> getAggregateRootClass()

Returns the aggregate root class managed by the resource.

Returns:

the aggregate root class.

getFluentAssembler

FluentAssembler getFluentAssembler()

Returns the FluentAssembler implementation used by the resource.

Returns:

the FluentAssembler implementation.

getIdentifierClass

Class<I> getIdentifierClass()

Returns the aggregate root identifier class managed by the resource.

Returns:

the aggregate root identifier class.

getPaginator

Paginator getPaginator()

Returns the Paginator implementation used by the resource.

Returns:

the Paginator implementation.

getRepository

Repository<A,I> getRepository()

Returns the repository where to find aggregates managed by the resource.

Returns:

the repository of managed aggregates.

getRepresentationClass

Class<D> getRepresentationClass()

Returns the representation class managed by the resource.

Returns:

the representation class.