org.seedstack.crud.rest

Interface UpdateResource<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 UpdateResource<A extends AggregateRoot<I>,I,D>
extends Resource<A,I,D>

Specialization of Resource for updating aggregates (the U of CRUD).

See Also:

CreateResource, ReadResource, UpdateResource, DeleteResource, Resource

Method Summary

Modifier and Type	Method and Description
default D	update(I id, D representation) The method that implements REST aggregate updating.

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

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

Method Detail

update

@PUT
 @Produces(value="application/json")
 @Consumes(value="application/json")
 @Path(value="/{id}")
default D update(@PathParam(value="id")
                                                                                                                      I id,
                                                                                                                      D representation)

The method that implements REST aggregate updating.

Parameters:

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

representation - the updated representation of the aggregate as JSON request body.

Returns:

the updated representation.