org.josef.ejb

Interface CrudActions<T extends Persistable>

Type Parameters:

T - The type of the Persistable.

All Known Subinterfaces:

CarControllerLocal, CarControllerRemote, PeriodicTableControllerLocal, PeriodicTableControllerRemote, PlanetControllerLocal, PlanetControllerRemote, ScientistControllerLocal, ScientistControllerRemote

All Known Implementing Classes:

CarControllerBean, PeriodicTableControllerBean, PlanetControllerBean, ScientistControllerBean

@Status(stage=PRODUCTION,
        unitTests=NOT_APPLICABLE)
 @Review(by="Kees Schotanus",
        at="2009-09-24")
public interface CrudActions<T extends Persistable>

Interface to be implemented by classes that support CRUD (Create, Read, Update and Delete) actions on an Entity.
The names in this interface are consistent with the names used by JPA, not with the acronym CRUD.
Note: JPA uses runtime exceptions. EJB specs state that when a RuntimeException is thrown, it will be wrapped in an EJBException before thrown to the client. In addition. the transaction will be marked for read-only.

Version:

1.0 $Revision: 5460 $

Author:

Kees Schotanus.

Method Summary

Modifier and Type	Method and Description
List<T>	findByCriteria(Searchable criteria) Finds Entities based upon criteria.
T	findById(Long objectId) Finds the Entity.
T	merge(T entity) Merges the Entity.
void	persist(T entity) Persists the Entity.
void	remove(T entity) Removes the Entity.

Method Detail

persist

void persist(T entity)

Persists the Entity.

Parameters:

entity - The entity to persist.
Create action.

Throws:

NullPointerException - When the supplied entity is null.

javax.persistence.PersistenceException - When the persist operation failed.

findById

T findById(Long objectId)

Finds the Entity.
Read action.

Parameters:

objectId - The Object ID of the entity to find.

Returns:

The Entity with the supplied objectId or null when no such Entity exists.

Throws:

NullPointerException - When the supplied objectId is null.

merge

T merge(T entity)

Merges the Entity.

Parameters:

entity - The entity to merge.
Update action.

Returns:

A copy of the merged state of the supplied entity.

Throws:

NullPointerException - When the supplied entity is null.

javax.persistence.PersistenceException - when the merge operation failed.

remove

void remove(T entity)

Removes the Entity.

Parameters:

entity - The entity to merge.
Delete action.

Throws:

NullPointerException - When the supplied entity is null.

javax.persistence.PersistenceException - when the remove operation failed.

findByCriteria

List<T> findByCriteria(Searchable criteria)

Finds Entities based upon criteria.

Parameters:

criteria - The search criteria.

Returns:

A list of Entities that comply with the supplied criteria.

Throws:

NullPointerException - When the supplied criteria object is null.