Author: adamw Date: 2009-04-30 03:42:39 -0400 (Thu, 30 Apr 2009) New Revision: 16486 Modified: core/trunk/documentation/envers/src/main/docbook/en-US/content/revisionlog.xml Log: HHH-3823: - updating documentation Modified: core/trunk/documentation/envers/src/main/docbook/en-US/content/revisionlog.xml =================================================================== --- core/trunk/documentation/envers/src/main/docbook/en-US/content/revisionlog.xml 2009-04-30 07:36:14 UTC (rev 16485) +++ core/trunk/documentation/envers/src/main/docbook/en-US/content/revisionlog.xml 2009-04-30 07:42:39 UTC (rev 16486) @@ -70,6 +70,17 @@ </para> <para> + Alternatively, you can use the <literal>getCurrentRevision</literal> method of the + <literal>AuditReader</literal> interface to obtain the current revision, and fill it with desired information. + The method has a <literal>persist</literal> parameter specifying, if the revision entity should be persisted + before returning. If set to <literal>true</literal>, the revision number will be available in the returned + revision entity (as it is normally generated by the database), but the revision entity will be persisted + regardless of wheter there are any audited entities changed. If set to <literal>false</literal>, the revision + number will be <literal>null</literal>, but the revision entity will be persisted only if some audited entities + have changed. + </para> + + <para> A simplest example of a revisions entity, which with each revision associates the username of the user making the change is: </para>