org.exoplatform.acceptance.service

Interface CRUDService<T>

All Known Implementing Classes:

AbstractMongoCRUDService, CredentialService, VCSRepositoryService

public interface CRUDService<T>

CRUDService interface.

Since:

2.0.0

Author:

Arnaud Héritier ( aheritier@exoplatform.com )

Method Summary

Methods

Modifier and Type	Method and Description
long	count() Returns the number of entities available.
void	delete(String id) Deletes the entity with the given id.
void	deleteAll() Deletes all entities managed by the repository.
boolean	exists(String id) Returns whether an entity with the given id exists.
Iterable<T>	findAll() Returns all instances of the type.
Iterable<T>	findAll(int page, int size) Returns all instances of the given page.
T	findOne(String id) Retrieves an entity by its id.
<S extends T> S	update(S entity) Updates an existing entity.
<S extends T> S	updateOrCreate(S entity) Saves a given entity (creates it if it doesn't exist).

Method Detail

findOne

T findOne(String id)
          throws EntityNotFoundException

Retrieves an entity by its id.

Parameters:

id - must not be null.

Returns:

the entity with the given id

Throws:

IllegalArgumentException - if id is null

EntityNotFoundException - in case there is no entity with the given id

update

<S extends T> S update(S entity)
                   throws EntityNotFoundException

Updates an existing entity. Use the returned instance for further operations as the save operation might have changed the entity instance completely.

Type Parameters:

S - a S object.

Parameters:

entity - the entity to update

Returns:

the saved entity

Throws:

EntityNotFoundException - in case there is no entity with the given id

updateOrCreate

<S extends T> S updateOrCreate(S entity)

Saves a given entity (creates it if it doesn't exist). Use the returned instance for further operations as the save operation might have changed the entity instance completely.

Type Parameters:

S - a S object.

Parameters:

entity - the entity to update

Returns:

the saved entity

exists

boolean exists(String id)

Returns whether an entity with the given id exists.

Parameters:

id - must not be null.

Returns:

true if an entity with the given id exists, false otherwise

Throws:

IllegalArgumentException - if id is null

findAll

Iterable<T> findAll()

Returns all instances of the type.

Returns:

all entities

findAll

Iterable<T> findAll(int page,
                  int size)

Returns all instances of the given page. Pages are zero indexed, thus providing 0 for page will return the first page.

Parameters:

page - a int.

size - a int.

Returns:

entities for the given page

count

long count()

Returns the number of entities available.

Returns:

the number of entities

delete

void delete(String id)
            throws EntityNotFoundException

Deletes the entity with the given id.

Parameters:

id - must not be null.

Throws:

IllegalArgumentException - in case the given id is null

EntityNotFoundException - in case there is no entity with the given id

deleteAll

void deleteAll()

Deletes all entities managed by the repository.