|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface VersionsReader
Method Summary | ||
---|---|---|
VersionsQueryCreator |
createQuery()
|
|
|
find(java.lang.Class<T> cls,
java.lang.Object primaryKey,
java.lang.Number revision)
Find an entity by primary key at the given revision. |
|
|
findRevision(java.lang.Class<T> revisionEntityClass,
java.lang.Number revision)
A helper method; should be used only if a custom revision entity is used. |
|
java.util.Date |
getRevisionDate(java.lang.Number revision)
Get the date, at which a revision was created. |
|
java.lang.Number |
getRevisionNumberForDate(java.util.Date date)
Gets the revision number, that corresponds to the given date. |
|
java.util.List<java.lang.Number> |
getRevisions(java.lang.Class<?> cls,
java.lang.Object primaryKey)
Get a list of revision numbers, at which an entity was modified. |
Method Detail |
---|
<T> T find(java.lang.Class<T> cls, java.lang.Object primaryKey, java.lang.Number revision) throws java.lang.IllegalArgumentException, NotVersionedException, java.lang.IllegalStateException
cls
- Class of the entity.primaryKey
- Primary key of the entity.revision
- Revision in which to get the entity.
java.lang.IllegalArgumentException
- If cls or primaryKey is null or revision is less or equal to 0.
NotVersionedException
- When entities of the given class are not versioned.
java.lang.IllegalStateException
- If the associated entity manager is closed.java.util.List<java.lang.Number> getRevisions(java.lang.Class<?> cls, java.lang.Object primaryKey) throws java.lang.IllegalArgumentException, NotVersionedException, java.lang.IllegalStateException
cls
- Class of the entity.primaryKey
- Primary key of the entity.
NotVersionedException
- When entities of the given class are not versioned.
java.lang.IllegalArgumentException
- If cls or primaryKey is null.
java.lang.IllegalStateException
- If the associated entity manager is closed.java.util.Date getRevisionDate(java.lang.Number revision) throws java.lang.IllegalArgumentException, RevisionDoesNotExistException, java.lang.IllegalStateException
revision
- Number of the revision for which to get the date.
java.lang.IllegalArgumentException
- If revision is less or equal to 0.
RevisionDoesNotExistException
- If the revision does not exist.
java.lang.IllegalStateException
- If the associated entity manager is closed.java.lang.Number getRevisionNumberForDate(java.util.Date date) throws java.lang.IllegalStateException, RevisionDoesNotExistException, java.lang.IllegalArgumentException
getRevisionDate(getRevisionNumberForDate(date)) <= date
and
getRevisionDate(getRevisionNumberForDate(date)+1) > date
.
date
- Date for which to get the revision.
java.lang.IllegalStateException
- If the associated entity manager is closed.
RevisionDoesNotExistException
- If the given date is before the first revision.
java.lang.IllegalArgumentException
- If date
is null
.<T> T findRevision(java.lang.Class<T> revisionEntityClass, java.lang.Number revision) throws java.lang.IllegalArgumentException, RevisionDoesNotExistException, java.lang.IllegalStateException
RevisionEntity
.
revisionEntityClass
- Class of the revision entity. Should be annotated with RevisionEntity
.revision
- Number of the revision for which to get the data.
java.lang.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.
java.lang.IllegalStateException
- If the associated entity manager is closed.VersionsQueryCreator createQuery()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |