org.eurekaclinical.standardapis.dao

Interface HistoricalDao<PK,E extends HistoricalEntity<PK>>

Type Parameters:

PK - the primary key type.

E - the entity type.

All Superinterfaces:

Dao<E,PK>

All Known Subinterfaces:

HistoricalDaoWithUniqueName<PK,T>

public interface HistoricalDao<PK,E extends HistoricalEntity<PK>>
extends Dao<E,PK>

A data access object that manages an entity that maintains its historical state. Such entities implement the HistoricalEntity interface, which defines effectiveAt and expiredAt. Real-world objects will have one or more entity instances, each representing the object's state between the effective and expired datetimes.

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
List<E>	getCurrent()
E	updateCurrent(E entity) Updates the given entity.

Methods inherited from interface org.eurekaclinical.standardapis.dao.Dao

create, getAll, getAll, refresh, remove, retrieve, update

Method Detail

getCurrent

List<E> getCurrent()

updateCurrent

E updateCurrent(E entity)

Updates the given entity. The id of the entity must match that of an entity that is already in the database. This method will get the existing entity instance, set its expiredAt field to the current datetime, and create a new record reflecting the given entity instance. It will set the new entity instance's effectiveAt field to the current datetime. It also will set the expiredAt field to null. The given entity instance will have an updated id after the method returns, and the updated entity also will be returned from the method.

Parameters:

entity - the entity to update.

Returns:

the updated entity.