org.hibernate.envers
Interface AuditReader

All Known Subinterfaces:

AuditReaderImplementor, VersionsReader

All Known Implementing Classes:

AuditReaderImpl

public interface AuditReader

Author:

Adam Warski (adam at warski dot org)

Method Summary

AuditQueryCreator	createQuery()
<T> T	find(Class<T> cls, Object primaryKey, Number revision) Find an entity by primary key at the given revision.
<T> T	findRevision(Class<T> revisionEntityClass, Number revision) A helper method; should be used only if a custom revision entity is used.
Date	getRevisionDate(Number revision) Get the date, at which a revision was created.
Number	getRevisionNumberForDate(Date date) Gets the revision number, that corresponds to the given date.
List<Number>	getRevisions(Class<?> cls, Object primaryKey) Get a list of revision numbers, at which an entity was modified.

Method Detail

find

<T> T find(Class<T> cls,
           Object primaryKey,
           Number revision)
       throws IllegalArgumentException,
              NotAuditedException,
              IllegalStateException

Find an entity by primary key at the given revision.

Parameters:

cls - Class of the entity.

primaryKey - Primary key of the entity.

revision - Revision in which to get the entity.

Returns:

The found entity instance at the given revision (its properties may be partially filled if not all properties are audited) or null, if an entity with that id didn't exist at that revision.

Throws:

IllegalArgumentException - If cls or primaryKey is null or revision is less or equal to 0.

NotAuditedException - When entities of the given class are not audited.

IllegalStateException - If the associated entity manager is closed.

getRevisions

List<Number> getRevisions(Class<?> cls,
                          Object primaryKey)
                          throws IllegalArgumentException,
                                 NotAuditedException,
                                 IllegalStateException

Get a list of revision numbers, at which an entity was modified.

Parameters:

cls - Class of the entity.

primaryKey - Primary key of the entity.

Returns:

A list of revision numbers, at which the entity was modified, sorted in ascending order (so older revisions come first).

Throws:

NotAuditedException - When entities of the given class are not audited.

IllegalArgumentException - If cls or primaryKey is null.

IllegalStateException - If the associated entity manager is closed.

getRevisionDate

Date getRevisionDate(Number revision)
                     throws IllegalArgumentException,
                            RevisionDoesNotExistException,
                            IllegalStateException

Get the date, at which a revision was created.

Parameters:

revision - Number of the revision for which to get the date.

Returns:

Date of commiting the given revision.

Throws:

IllegalArgumentException - If revision is less or equal to 0.

RevisionDoesNotExistException - If the revision does not exist.

IllegalStateException - If the associated entity manager is closed.

getRevisionNumberForDate

Number getRevisionNumberForDate(Date date)
                                throws IllegalStateException,
                                       RevisionDoesNotExistException,
                                       IllegalArgumentException

Gets the revision number, that corresponds to the given date. More precisely, returns the number of the highest revision, which was created on or before the given date. So: getRevisionDate(getRevisionNumberForDate(date)) <= date and getRevisionDate(getRevisionNumberForDate(date)+1) > date.

Parameters:

date - Date for which to get the revision.

Returns:

Revision number corresponding to the given date.

Throws:

IllegalStateException - If the associated entity manager is closed.

RevisionDoesNotExistException - If the given date is before the first revision.

IllegalArgumentException - If date is null.

findRevision

<T> T findRevision(Class<T> revisionEntityClass,
                   Number revision)
               throws IllegalArgumentException,
                      RevisionDoesNotExistException,
                      IllegalStateException

A helper method; should be used only if a custom revision entity is used. See also RevisionEntity.

Parameters:

revisionEntityClass - Class of the revision entity. Should be annotated with RevisionEntity.

revision - Number of the revision for which to get the data.

Returns:

Entity containing data for the given revision.

Throws:

IllegalArgumentException - If revision is less or equal to 0 or if the class of the revision entity is invalid.

RevisionDoesNotExistException - If the revision does not exist.

IllegalStateException - If the associated entity manager is closed.

createQuery

AuditQueryCreator createQuery()

Returns:

A query creator, associated with this AuditReader instance, with which queries can be created and later executed. Shouldn't be used after the associated Session or EntityManager is closed.