AuditWorkUnit (Hibernate Javadocs)

All Superinterfaces:: WorkUnitMergeDispatcher, WorkUnitMergeVisitor

All Known Implementing Classes:: AbstractAuditWorkUnit, AddWorkUnit, CollectionChangeWorkUnit, DelWorkUnit, FakeBidirectionalRelationWorkUnit, ModWorkUnit, PersistentCollectionChangeWorkUnit

public interface AuditWorkUnit extends WorkUnitMergeVisitor, WorkUnitMergeDispatcher

TODO: refactor constructors into factory methods

Method Summary

Modifier and Type

Method

Description

boolean

containsWork()

Map<String,Object>

generateData(Object revisionData)

Object

getEntityId()

String

getEntityName()

RevisionType

getRevisionType()

boolean

isPerformed()

void

perform(Session session, Object revisionData)

Perform this work unit in the given session.

void

undo(Session session)

Methods inherited from interface org.hibernate.envers.internal.synchronization.work.WorkUnitMergeDispatcher
dispatch

Methods inherited from interface org.hibernate.envers.internal.synchronization.work.WorkUnitMergeVisitor
merge, merge, merge, merge, merge

Method Details
- getEntityId
  
  Object getEntityId()
- getEntityName
  
  String getEntityName()
- containsWork
  
  boolean containsWork()
- isPerformed
  
  boolean isPerformed()
- perform
  
  void perform(Session session, Object revisionData)
  
  Perform this work unit in the given session.
  
  Parameters:
  
  session - Session, in which the work unit should be performed.
  
  revisionData - The current revision data, which will be used to populate the work unit with the correct revision relation.
- undo
  
  void undo(Session session)
- generateData
  
  Map<String,Object> generateData(Object revisionData)
  
  Parameters:
  
  revisionData - The current revision data, which will be used to populate the work unit with the correct revision relation.
  
  Returns:
  
  Generates data that should be saved when performing this work unit.
- getRevisionType
  
  RevisionType getRevisionType()
  
  Returns:
  
  Performed modification type.