From: Kevin W. <kev...@us...> - 2004-12-31 15:38:19
|
Update of /cvsroot/nhibernate/nhibernate/src/NHibernate In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv21158 Modified Files: IInterceptor.cs Log Message: fixing xml comments and letting ReSharper do reformatting Index: IInterceptor.cs =================================================================== RCS file: /cvsroot/nhibernate/nhibernate/src/NHibernate/IInterceptor.cs,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** IInterceptor.cs 14 Mar 2003 22:09:17 -0000 1.3 --- IInterceptor.cs 31 Dec 2004 15:38:09 -0000 1.4 *************** *** 1,7 **** - using System; using System.Collections; using NHibernate.Type; ! namespace NHibernate { /// <summary> /// Allows user code to inspect and/or change property values before they are written and after they --- 1,7 ---- using System.Collections; using NHibernate.Type; ! namespace NHibernate ! { /// <summary> /// Allows user code to inspect and/or change property values before they are written and after they *************** *** 20,28 **** /// </para> /// </remarks> ! public interface IInterceptor { ! /// <summary> /// Called just before an object is initialized /// </summary> /// <remarks> /// The interceptor may change the <c>state</c>, which will be propagated to the persistent --- 20,33 ---- /// </para> /// </remarks> ! public interface IInterceptor ! { /// <summary> /// Called just before an object is initialized /// </summary> + /// <param name="entity"></param> + /// <param name="id"></param> + /// <param name="propertyNames"></param> + /// <param name="state"></param> + /// <param name="types"></param> /// <remarks> /// The interceptor may change the <c>state</c>, which will be propagated to the persistent *************** *** 30,38 **** /// uninitialized instance of the class.</remarks> /// <returns><c>true</c> if the user modified the <c>state</c> in any way</returns> ! bool OnLoad(object entity, object id, object[] state, string[] propertyNames, IType[] types); /// <summary> /// Called when an object is detected to be dirty, during a flush. /// </summary> /// <remarks> /// The interceptor may modify the detected <c>currentState</c>, which will be propagated to --- 35,49 ---- /// uninitialized instance of the class.</remarks> /// <returns><c>true</c> if the user modified the <c>state</c> in any way</returns> ! bool OnLoad( object entity, object id, object[ ] state, string[ ] propertyNames, IType[ ] types ); /// <summary> /// Called when an object is detected to be dirty, during a flush. /// </summary> + /// <param name="currentState"></param> + /// <param name="entity"></param> + /// <param name="id"></param> + /// <param name="previousState"></param> + /// <param name="propertyNames"></param> + /// <param name="types"></param> /// <remarks> /// The interceptor may modify the detected <c>currentState</c>, which will be propagated to *************** *** 43,51 **** /// </remarks> /// <returns><c>true</c> if the user modified the <c>currentState</c> in any way</returns> ! bool OnFlushDirty(object entity, object id, object[] currentState, object[] previousState, string[] propertyNames, IType[] types); /// <summary> /// Called before an object is saved /// </summary> /// <remarks> /// The interceptor may modify the <c>state</c>, which will be used for the SQL <c>INSERT</c> --- 54,67 ---- /// </remarks> /// <returns><c>true</c> if the user modified the <c>currentState</c> in any way</returns> ! bool OnFlushDirty( object entity, object id, object[ ] currentState, object[ ] previousState, string[ ] propertyNames, IType[ ] types ); /// <summary> /// Called before an object is saved /// </summary> + /// <param name="entity"></param> + /// <param name="id"></param> + /// <param name="propertyNames"></param> + /// <param name="state"></param> + /// <param name="types"></param> /// <remarks> /// The interceptor may modify the <c>state</c>, which will be used for the SQL <c>INSERT</c> *************** *** 53,65 **** /// </remarks> /// <returns><c>true</c> if the user modified the <c>state</c> in any way</returns> ! bool OnSave(object entity, object id, object[] state, string[] propertyNames, IType[] types); /// <summary> /// Called before an object is deleted /// </summary> /// <remarks> /// It is not recommended that the interceptor modify the <c>state</c>. /// </remarks> ! void OnDelete(object entity, object id, object[] state, string[] propertyNames, IType[] types); /// <summary> --- 69,86 ---- /// </remarks> /// <returns><c>true</c> if the user modified the <c>state</c> in any way</returns> ! bool OnSave( object entity, object id, object[ ] state, string[ ] propertyNames, IType[ ] types ); /// <summary> /// Called before an object is deleted /// </summary> + /// <param name="entity"></param> + /// <param name="id"></param> + /// <param name="propertyNames"></param> + /// <param name="state"></param> + /// <param name="types"></param> /// <remarks> /// It is not recommended that the interceptor modify the <c>state</c>. /// </remarks> ! void OnDelete( object entity, object id, object[ ] state, string[ ] propertyNames, IType[ ] types ); /// <summary> *************** *** 67,71 **** /// </summary> /// <param name="entities">The entities</param> ! void PreFlush(ICollection entities); /// <summary> --- 88,92 ---- /// </summary> /// <param name="entities">The entities</param> ! void PreFlush( ICollection entities ); /// <summary> *************** *** 74,78 **** /// </summary> /// <param name="entities">The entitites</param> ! void PostFlush(ICollection entities); /// <summary> --- 95,99 ---- /// </summary> /// <param name="entities">The entitites</param> ! void PostFlush( ICollection entities ); /// <summary> *************** *** 89,93 **** /// <param name="entity">A transient entity</param> /// <returns></returns> ! object IsUnsaved(object entity); /// <summary> --- 110,114 ---- /// <param name="entity">A transient entity</param> /// <returns></returns> ! object IsUnsaved( object entity ); /// <summary> *************** *** 102,108 **** /// </remarks> /// <param name="entity">A persistent entity</param> /// <returns>An array of dirty property indicies or <c>null</c> to choose default behavior</returns> ! int[] FindDirty(object entity, object id, object[] currentState, object[] previousState, string[] propertyNames, IType[] types); ! /// <summary> /// Instantiate the entity class. Return <c>null</c> to indicate that Hibernate should use the default --- 123,134 ---- /// </remarks> /// <param name="entity">A persistent entity</param> + /// <param name="currentState"></param> + /// <param name="id"></param> + /// <param name="previousState"></param> + /// <param name="propertyNames"></param> + /// <param name="types"></param> /// <returns>An array of dirty property indicies or <c>null</c> to choose default behavior</returns> ! int[ ] FindDirty( object entity, object id, object[ ] currentState, object[ ] previousState, string[ ] propertyNames, IType[ ] types ); ! /// <summary> /// Instantiate the entity class. Return <c>null</c> to indicate that Hibernate should use the default *************** *** 112,117 **** /// <param name="id">The identifier of the new instance</param> /// <returns>An instance of the class, or <c>null</c> to choose default behaviour</returns> ! object Instantiate(System.Type type, object id); ! } ! } --- 138,143 ---- /// <param name="id">The identifier of the new instance</param> /// <returns>An instance of the class, or <c>null</c> to choose default behaviour</returns> ! object Instantiate( System.Type type, object id ); ! } ! } \ No newline at end of file |