de.alpharogroup.service.rs.api

Interface RestfulResource<PK,DO>

Type Parameters:

PK - the generic type of the primary key

DO - the generic type of the domain object

public interface RestfulResource<PK,DO>

The interface RestfulResource provides crud methods

Method Summary

Modifier and Type	Method and Description
DO	create(DO domainObject) Creates an entity from the given domain object and persist it to the underlying database.
void	delete(DO domainObject) Deletes an entity in the underlying database from the given domain object
void	deleteById(PK id) Deletes an entity with the given id.
void	merge(DO domainObject) Updates the given domain object to the underlying database.
DO	readById(PK id) Read an entity with the given id and maps it to a domain object that will be returned.
void	update(DO domainObject) Updates the given domain object to the underlying database.

Method Detail

create

@POST
 @Path(value="/")
DO create(DO domainObject)

Creates an entity from the given domain object and persist it to the underlying database.

Parameters:

domainObject - the domain object

Returns:

the domain object with the id from the entity.

delete

@DELETE
 @Path(value="/delete/")
void delete(DO domainObject)

Deletes an entity in the underlying database from the given domain object

Parameters:

domainObject - the domain object to be deleted

deleteById

@DELETE
 @Path(value="/{id}")
void deleteById(@PathParam(value="id")
                                              PK id)

Deletes an entity with the given id.

Parameters:

id - the id

merge

@PATCH
 @Path(value="/")
void merge(DO domainObject)

Updates the given domain object to the underlying database.

Parameters:

domainObject - the domain object

readById

@GET
 @Path(value="/{id}")
DO readById(@PathParam(value="id")
                                       PK id)

Read an entity with the given id and maps it to a domain object that will be returned.

Parameters:

id - the id

Returns:

the domain object

update

@PUT
 @Path(value="/")
void update(DO domainObject)

Updates the given domain object to the underlying database.

Parameters:

domainObject - the domain object