|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface AuditReader
Method Summary | ||
---|---|---|
AuditQueryCreator |
createQuery()
|
|
|
find(Class<T> cls,
Object primaryKey,
Number revision)
Find an entity by primary key at the given revision. |
|
|
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 |
---|
<T> T find(Class<T> cls, Object primaryKey, Number revision) throws IllegalArgumentException, NotAuditedException, IllegalStateException
cls
- Class of the entity.primaryKey
- Primary key of the entity.revision
- Revision in which to get the entity.
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.List<Number> getRevisions(Class<?> cls, Object primaryKey) throws IllegalArgumentException, NotAuditedException, IllegalStateException
cls
- Class of the entity.primaryKey
- Primary key of the entity.
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.Date getRevisionDate(Number revision) throws IllegalArgumentException, RevisionDoesNotExistException, IllegalStateException
revision
- Number of the revision for which to get the date.
IllegalArgumentException
- If revision is less or equal to 0.
RevisionDoesNotExistException
- If the revision does not exist.
IllegalStateException
- If the associated entity manager is closed.Number getRevisionNumberForDate(Date date) throws IllegalStateException, RevisionDoesNotExistException, IllegalArgumentException
getRevisionDate(getRevisionNumberForDate(date)) <= date
and
getRevisionDate(getRevisionNumberForDate(date)+1) > date
.
date
- Date for which to get the revision.
IllegalStateException
- If the associated entity manager is closed.
RevisionDoesNotExistException
- If the given date is before the first revision.
IllegalArgumentException
- If date
is null
.<T> T findRevision(Class<T> revisionEntityClass, Number revision) throws IllegalArgumentException, RevisionDoesNotExistException, IllegalStateException
RevisionEntity
.
revisionEntityClass
- Class of the revision entity. Should be annotated with RevisionEntity
.revision
- Number of the revision for which to get the data.
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.AuditQueryCreator createQuery()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |