org.milyn.scribe
Interface MappingDao<E>

public interface MappingDao<E>

The Mapping DAO interface

Provides the most basic DAO operations to manipulate a data source. The difference to the Dao interface is that this intefaces adds a extra id parameter to each method. This id determines how the implementation should execute the operation.

Author:

maurice.zeijen@smies.com

Method Summary

E	delete(String id, E entity) Deletes the entity instance from the datasource
E	insert(String id, E entity) Inserts the entity instance in to the datasource
E	update(String id, E entity) Updates the entity instance in the datasource

Method Detail

insert

E insert(String id,
         E entity)

Inserts the entity instance in to the datasource

Parameters:

id - The id

entity - The entity object to insert

Returns:

The inserted entity. The Dao should only return an entity that represents the inserted entity but is a different object then the one that was used as the parameter. If this is not the case then NULL should be returned.

Throws:

UnsupportedOperationException - Indicates that this Dao doesn't support the insert operation.

update

E update(String id,
         E entity)

Updates the entity instance in the datasource

Parameters:

id - The id

entity - The entity object to update

Returns:

The updated entity. The Dao should only return an entity that represents the updated entity but is a different object then the one that was used as the parameter. If this is not the case then NULL should be returned.

Throws:

UnsupportedOperationException - Indicates that this Dao doesn't support the update operation.

delete

E delete(String id,
         E entity)

Deletes the entity instance from the datasource

Parameters:

id - The id

entity - The entity object to delete

Returns:

The deleted entity. The Dao should only return an entity that represents the deleted entity but is a different object then the one that was used as the parameter. If this is not the case then NULL should be returned.

Throws:

UnsupportedOperationException - Indicates that this Dao doesn't support the delete operation.