org.eurekaclinical.standardapis.entity

Interface HistoricalEntity<PK>

All Superinterfaces:

Entity<PK>

public interface HistoricalEntity<PK>
extends Entity<PK>

Interface for entities that maintain their historical state. Corresponding real-world objects will have one or more entity instances, each representing the object's state between the effective and expired datetimes. Updates will expire the object's most recent record in the database and create a new record. Deletes will expire the current record in the database but will not physically delete it. Data access objects for historical entities only return instances that are valid at the time of the query unless otherwise specified.

Author:

Andrew Post

Method Summary

Modifier and Type	Method and Description
Date	getCreatedAt() Gets the datetime at which the first entity instance corresponding to this real-world object was created.
Date	getEffectiveAt() Returns the effective datetime of this entity instance.
Date	getExpiredAt() Returns the datetime at which this entity instance expired.
void	setCreatedAt(Date createdAt) Sets the datetime at which the first entity instance corresponding to this real-world object was created.
void	setEffectiveAt(Date effectiveAt) Sets the effective datetime of this entity instance.
void	setExpiredAt(Date expiredAt) Sets the timestamp at which this entity instance expired.

Methods inherited from interface org.eurekaclinical.standardapis.entity.Entity

getId, setId

Method Detail

getEffectiveAt

Date getEffectiveAt()

Returns the effective datetime of this entity instance.

Returns:

a datetime.

setEffectiveAt

void setEffectiveAt(Date effectiveAt)

Sets the effective datetime of this entity instance.

Parameters:

effectiveAt - a datetime.

getExpiredAt

Date getExpiredAt()

Returns the datetime at which this entity instance expired.

Returns:

a datetime.

setExpiredAt

void setExpiredAt(Date expiredAt)

Sets the timestamp at which this entity instance expired.

Parameters:

expiredAt - a datetime.

getCreatedAt

Date getCreatedAt()

Gets the datetime at which the first entity instance corresponding to this real-world object was created.

Returns:

a datetime

setCreatedAt

void setCreatedAt(Date createdAt)

Sets the datetime at which the first entity instance corresponding to this real-world object was created.

Parameters:

createdAt - a datetime.