de.alpharogroup.service.rs

Interface RestfulResource<PK extends Serializable,DO extends de.alpharogroup.domain.DomainObject<PK>>

Type Parameters:

PK - the generic type of the primary key

DO - the generic type of the domain object

All Known Implementing Classes:

AbstractRestfulResource

public interface RestfulResource<PK extends Serializable,DO extends de.alpharogroup.domain.DomainObject<PK>>

The Interface RestfulResource.

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(PK id) Deletes an entity with the given id.
DO	read(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="/{id}/")
void delete(PK id)

Deletes an entity with the given id.

Parameters:

id - the id

read

@GET
 @Path(value="/{id}/")
DO read(@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