File	Doc	Category	Size	Date	Package
Interceptor.java	API Doc	Hibernate 3.2.5	7001	Fri Aug 12 15:03:08 BST 2005	org.hibernate

Interceptor

Fields Summary

Constructors Summary

Methods Summary
public void	afterTransactionBegin(Transaction tx) Called when a Hibernate transaction is begun via the Hibernate Transaction API. Will not be called if transactions are being controlled via some other mechanism (CMT, for example).
public void	afterTransactionCompletion(Transaction tx) Called after a transaction is committed or rolled back.
public void	beforeTransactionCompletion(Transaction tx) Called before a transaction is committed (but not before rollback).
public int[]	findDirty(java.lang.Object entity, java.io.Serializable id, java.lang.Object[] currentState, java.lang.Object[] previousState, java.lang.String[] propertyNames, org.hibernate.type.Type[] types) Called from flush(). The return value determines whether the entity is updated an array of property indices - the entity is dirty an empty array - the entity is not dirty null - use Hibernate's default dirty-checking algorithm param entity a persistent entity return array of dirty property indices or null to choose default behaviour
public java.lang.Object	getEntity(java.lang.String entityName, java.io.Serializable id) Get a fully loaded entity instance that is cached externally param entityName the name of the entity param id the instance identifier return a fully initialized entity throws CallbackException
public java.lang.String	getEntityName(java.lang.Object object) Get the entity name for a persistent or transient instance param object an entity instance return the name of the entity
public java.lang.Object	instantiate(java.lang.String entityName, EntityMode entityMode, java.io.Serializable id) Instantiate the entity class. Return null to indicate that Hibernate should use the default constructor of the class. The identifier property of the returned instance should be initialized with the given identifier. param entityName the name of the entity param entityMode The type of entity instance to be returned. param id the identifier of the new instance return an instance of the class, or null to choose default behaviour
public java.lang.Boolean	isTransient(java.lang.Object entity) Called to distinguish between transient and detached entities. The return value determines the state of the entity with respect to the current session. Boolean.TRUE - the entity is transient Boolean.FALSE - the entity is detached null - Hibernate uses the unsaved-value mapping and other heuristics to determine if the object is unsaved param entity a transient or detached entity return Boolean or null to choose default behaviour
public void	onCollectionRecreate(java.lang.Object collection, java.io.Serializable key) Called before a collection is (re)created.
public void	onCollectionRemove(java.lang.Object collection, java.io.Serializable key) Called before a collection is deleted.
public void	onCollectionUpdate(java.lang.Object collection, java.io.Serializable key) Called before a collection is updated.
public void	onDelete(java.lang.Object entity, java.io.Serializable id, java.lang.Object[] state, java.lang.String[] propertyNames, org.hibernate.type.Type[] types) Called before an object is deleted. It is not recommended that the interceptor modify the state.
public boolean	onFlushDirty(java.lang.Object entity, java.io.Serializable id, java.lang.Object[] currentState, java.lang.Object[] previousState, java.lang.String[] propertyNames, org.hibernate.type.Type[] types) Called when an object is detected to be dirty, during a flush. The interceptor may modify the detected currentState, which will be propagated to both the database and the persistent object. Note that not all flushes end in actual synchronization with the database, in which case the new currentState will be propagated to the object, but not necessarily (immediately) to the database. It is strongly recommended that the interceptor not modify the previousState. return true if the user modified the currentState in any way.
public boolean	onLoad(java.lang.Object entity, java.io.Serializable id, java.lang.Object[] state, java.lang.String[] propertyNames, org.hibernate.type.Type[] types) Called just before an object is initialized. The interceptor may change the state, which will be propagated to the persistent object. Note that when this method is called, entity will be an empty uninitialized instance of the class. return true if the user modified the state in any way.
public java.lang.String	onPrepareStatement(java.lang.String sql) Called when sql string is being prepared. param sql sql to be prepared return original or modified sql
public boolean	onSave(java.lang.Object entity, java.io.Serializable id, java.lang.Object[] state, java.lang.String[] propertyNames, org.hibernate.type.Type[] types) Called before an object is saved. The interceptor may modify the state, which will be used for the SQL INSERT and propagated to the persistent object. return true if the user modified the state in any way.
public void	postFlush(java.util.Iterator entities) Called after a flush that actually ends in execution of the SQL statements required to synchronize in-memory state with the database.
public void	preFlush(java.util.Iterator entities) Called before a flush