edu.emory.cci.aiw.cvrg.eureka.common.dao

Interface Dao<T,PK>

Type Parameters:

T - The type of the entity.

PK - The type of the primary key of the entity.

All Known Subinterfaces:

AuthorizedUserDao

All Known Implementing Classes:

GenericDao

public interface Dao<T,PK>

Provides an interface for the common CRUD operations for an entity.

Author:

hrathod

Method Summary

Modifier and Type	Method and Description
T	create(T entity) Creates (persists) the given entity in the data store.
List<T>	getAll() Retrieves a list of all the entities of the given type in the data store.
T	refresh(T entity) Refreshes the given entity instance with latest information from the data store.
T	remove(T entity) Removes the given entity from the data store.
T	retrieve(PK uniqueId) Retrieves the entity referred to by the unique identifier from the data store.
T	update(T entity) Updates the data store using the given entity.

Method Detail

create

T create(T entity)

Creates (persists) the given entity in the data store.

Parameters:

entity - The entity to create (persist).

Returns:

The persisted entity. Useful for chained method calls, if needed.

retrieve

T retrieve(PK uniqueId)

Retrieves the entity referred to by the unique identifier from the data store.

Parameters:

uniqueId - The unique identifier for the entity to retrieve.

Returns:

The retrieved entity, or null if it can not be found.

update

T update(T entity)

Updates the data store using the given entity.

Parameters:

entity - The entity to use for updates to the data store.

Returns:

The given entity. Useful for chained method calls, if needed.

remove

T remove(T entity)

Removes the given entity from the data store.

Parameters:

entity - The entity to remove from the data store.

Returns:

The removed entity.

refresh

T refresh(T entity)

Refreshes the given entity instance with latest information from the data store.

Parameters:

entity - The entity to refresh from the data store.

Returns:

The refreshed entity.

getAll

List<T> getAll()

Retrieves a list of all the entities of the given type in the data store.

Returns:

A list of all entities in the data store.