io.katharsis.repository

Interface ResourceRepository<T,ID extends Serializable>

Type Parameters:

T - Type of an entity

ID - Type of Identifier of an entity

public interface ResourceRepository<T,ID extends Serializable>

Base repository which is used to operate on the resources. Each resource should have a corresponding repository implementation.

Method Summary

Modifier and Type	Method and Description
void	delete(ID id) Removes a resource identified by id parameter.
Iterable<T>	findAll(Iterable<ID> ids, RequestParams requestParams) Search for resources constrained by a list of identifiers.
Iterable<T>	findAll(RequestParams requestParams) Search for all of the resources.
T	findOne(ID id, RequestParams requestParams) Search one resource with a given ID.
<S extends T> S	save(S entity) Saves a resource.

Method Detail

findOne

T findOne(ID id,
          RequestParams requestParams)

Search one resource with a given ID. If a resource cannot be found, a ResourceNotFoundException exception should be thrown.

Parameters:

id - an identifier of the resource

requestParams - parameters sent along with the request

Returns:

an instance of the resource

findAll

Iterable<T> findAll(RequestParams requestParams)

Search for all of the resources. An instance of RequestParams can be used if necessary. If no resources can be found an empty Iterable or null must be returned.

Parameters:

requestParams - parameters send with the request

Returns:

a list of found resources

findAll

Iterable<T> findAll(Iterable<ID> ids,
                    RequestParams requestParams)

Search for resources constrained by a list of identifiers. An instance of RequestParams can be used if necessary. If no resources can be found an empty Iterable or null must be returned.

Parameters:

ids - an Iterable of passed resource identifiers

requestParams - parameters send with the request

Returns:

a list of found resources

save

<S extends T> S save(S entity)

Saves a resource. It should not save relating relationships. A Returning resource must include assigned identifier created for the instance of resource.

Type Parameters:

S - type of the resource

Parameters:

entity - resource to be saved

Returns:

saved resource. Must include set identifier.

delete

void delete(ID id)

Removes a resource identified by id parameter.

Parameters:

id - identified of the resource to be removed